Skip to main content

Class: EngineResponse

Implements

Properties

message

message: ChatMessage

Implementation of

ChatResponse.message

Defined in

packages/core/schema/dist/index.d.ts:202


metadata

metadata: Metadata

Defined in

packages/core/schema/dist/index.d.ts:201


raw

raw: null | object

Raw response from the LLM

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

Implementation of

ChatResponse.raw

Defined in

packages/core/schema/dist/index.d.ts:203


sourceNodes

sourceNodes: undefined | NodeWithScore<Metadata>[]

Defined in

packages/core/schema/dist/index.d.ts:200


stream

readonly stream: boolean

Defined in

packages/core/schema/dist/index.d.ts:204

Accessors

delta

get delta(): string

Returns

string

Implementation of

ChatResponseChunk.delta

Defined in

packages/core/schema/dist/index.d.ts:214


response

get response(): string

Deprecated

Use message instead.

Returns

string

Defined in

packages/core/schema/dist/index.d.ts:213

Methods

toString()

toString(): string

Returns a string representation of an object.

Returns

string

Defined in

packages/core/schema/dist/index.d.ts:215


fromChatResponse()

static fromChatResponse(chatResponse, sourceNodes?): EngineResponse

Parameters

chatResponse: ChatResponse<object>

sourceNodes?: NodeWithScore<Metadata>[]

Returns

EngineResponse

Defined in

packages/core/schema/dist/index.d.ts:208


fromChatResponseChunk()

static fromChatResponseChunk(chunk, sourceNodes?): EngineResponse

Parameters

chunk: ChatResponseChunk

sourceNodes?: NodeWithScore<Metadata>[]

Returns

EngineResponse

Defined in

packages/core/schema/dist/index.d.ts:209


fromResponse()

static fromResponse(response, stream, sourceNodes): EngineResponse

Parameters

response: string

stream: boolean

sourceNodes: NodeWithScore<Metadata>[]

Returns

EngineResponse

Defined in

packages/core/schema/dist/index.d.ts:206