Interface ErrorChatResponseContent

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

Hierarchy (View Summary)

ChatResponseContent
- ErrorChatResponseContent

Implemented by

ErrorChatResponseContentImpl

Index

Properties

Methods

asDisplayString? asString? merge? toLanguageModelMessage? toSerializable?

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:544

`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:543

`Optional`merge

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

`Optional`toLanguageModelMessage

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

`Optional`toSerializable

toSerializable?(): SerializableChatResponseContentData
Returns SerializableChatResponseContentData
Inherited from ChatResponseContent.toSerializable
- Defined in packages/ai-chat/src/common/chat-model.ts:547