Interface ProgressChatResponseContent

interface ProgressChatResponseContent {
    kind: "progress";
    message: string;
    asDisplayString(): undefined | string;
    asString(): undefined | string;
    merge(nextChatResponseContent: ChatResponseContent): boolean;
    toLanguageModelMessage(): LanguageModelMessage | LanguageModelMessage[];
    toSerializable(): SerializableChatResponseContentData;
}

Hierarchy

Required<ChatResponseContent>
- ProgressChatResponseContent

Implemented by

ProgressChatResponseContentImpl

Index

Properties

Methods

asDisplayString asString merge toLanguageModelMessage toSerializable

Properties

kind

kind: "progress"

message

message: string

Methods

asDisplayString

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

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

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

toLanguageModelMessage

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

toSerializable

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