EngineResponse

Defined in: packages/core/src/schema/type/engine–response.ts:5

Implements

• ChatResponse
• ChatResponseChunk

Properties

sourceNodes

sourceNodes: undefined | NodeWithScore<Metadata>[]

Defined in: packages/core/src/schema/type/engine–response.ts:6

---

metadata

metadata: Metadata = {}

Defined in: packages/core/src/schema/type/engine–response.ts:8

---

message

message: ChatMessage

Defined in: packages/core/src/schema/type/engine–response.ts:10

Implementation of

ChatResponse.message

---

raw

raw: null | object

Defined in: packages/core/src/schema/type/engine–response.ts:11

Raw response from the LLM

If LLM response an iterable of chunks, this will be an array of those chunks

Implementation of

ChatResponse.raw

---

stream

readonly stream: boolean

Defined in: packages/core/src/schema/type/engine–response.ts:13

Accessors

response

Get Signature

get response(): string

Defined in: packages/core/src/schema/type/engine–response.ts:72

Deprecated

Use message instead.

Returns

string

---

delta

Get Signature

get delta(): string

Defined in: packages/core/src/schema/type/engine–response.ts:76

Returns

string

Implementation of

ChatResponseChunk.delta

Methods

fromResponse()

static fromResponse(response, stream, sourceNodes): EngineResponse

Defined in: packages/core/src/schema/type/engine–response.ts:26

Parameters

response

string

stream

boolean

sourceNodes

NodeWithScore<Metadata>[]

Returns

EngineResponse

---

fromChatResponse()

static fromChatResponse(chatResponse, sourceNodes?): EngineResponse

Defined in: packages/core/src/schema/type/engine–response.ts:51

Parameters

chatResponse

ChatResponse

sourceNodes?

NodeWithScore<Metadata>[]

Returns

EngineResponse

---

fromChatResponseChunk()

static fromChatResponseChunk(chunk, sourceNodes?): EngineResponse

Defined in: packages/core/src/schema/type/engine–response.ts:58

Parameters

chunk

ChatResponseChunk

sourceNodes?

NodeWithScore<Metadata>[]

Returns

EngineResponse

---

toString()

toString(): string

Defined in: packages/core/src/schema/type/engine–response.ts:85

Returns a string representation of an object.

Returns

string