Interface ErrorChatResponseContent

interface ErrorChatResponseContent {
    error: Error;
    kind: "error";
    asDisplayString?(): undefined | string;
    asString?(): undefined | string;
    merge?(nextChatResponseContent): boolean;
    toLanguageModelMessage?(): LanguageModelMessage | LanguageModelMessage[];
}

Hierarchy (view full)

ChatResponseContent
- ErrorChatResponseContent

Implemented by

ErrorChatResponseContentImpl

Index

Properties

error kind

Methods

asDisplayString? asString? merge? toLanguageModelMessage?

Properties

error

error: Error

kind

kind: "error"

Methods

`Optional` asDisplayString

asDisplayString(): undefined | string
Returns undefined | string
Inherited from ChatResponseContent.asDisplayString
- Defined in packages/ai-chat/src/common/chat-model.ts:359

`Optional` asString

asString(): undefined | string
Represents the content as a string. Returns undefined if the content is purely informational and/or visual and should not be included in the overall representation of the response.

Returns undefined | string
Inherited from ChatResponseContent.asString
- Defined in packages/ai-chat/src/common/chat-model.ts:358

`Optional` merge

merge(nextChatResponseContent): boolean
Parameters
- nextChatResponseContent: ChatResponseContent
Returns boolean
Inherited from ChatResponseContent.merge
- Defined in packages/ai-chat/src/common/chat-model.ts:360

`Optional` toLanguageModelMessage

toLanguageModelMessage(): LanguageModelMessage | LanguageModelMessage[]
Returns LanguageModelMessage | LanguageModelMessage[]
Inherited from ChatResponseContent.toLanguageModelMessage
- Defined in packages/ai-chat/src/common/chat-model.ts:361

Interface ErrorChatResponseContent

Hierarchy (view full)

Implemented by

Index

Properties

Methods

Properties

error

kind

Methods

`Optional` asDisplayString

Returns undefined | string

`Optional` asString

Returns undefined | string

`Optional` merge

Parameters

Returns boolean

`Optional` toLanguageModelMessage

Returns LanguageModelMessage | LanguageModelMessage[]

Settings

Member Visibility

Theme

On This Page

Interface ErrorChatResponseContent

Hierarchy (view full)

Implemented by

Index

Properties

Methods

Properties

error

kind

Methods

Optional asDisplayString

Returns undefined | string

Optional asString

Returns undefined | string

Optional merge

Parameters

Returns boolean

Optional toLanguageModelMessage

Returns LanguageModelMessage | LanguageModelMessage[]

Settings

Member Visibility

Theme

On This Page

`Optional` asDisplayString

`Optional` asString

`Optional` merge

`Optional` toLanguageModelMessage