Class AIMessageChunk

Represents a chunk of an AI message, which can be concatenated with other AI message chunks.

Hierarchy (view full)

Constructors

constructor

Properties

additional_kwargs content response_metadata invalid_tool_calls? name? tool_call_chunks? tool_calls? usage_metadata?

Accessors

text

Methods

concat toDict toJSON toJSONNotImplemented

Constructors

constructor

Properties

additional_kwargs

additional_kwargs: {
    function_call?: FunctionCall;
    tool_calls?: ToolCall[];
    [key: string]: unknown;
}

Additional keyword arguments

Type declaration

content

content: MessageContent

The content of the message.

response_metadata

response_metadata: Record<string, any>

Response metadata. For example: response headers, logprobs, token counts.

Optional invalid_tool_calls

invalid_tool_calls?: InvalidToolCall[] = []

Optional name

name?: string

The name of the message sender in a multi-user chat.

Optional tool_call_chunks

tool_call_chunks?: ToolCallChunk[] = []

Optional tool_calls

tool_calls?: ToolCall[] = []

Optional usage_metadata

usage_metadata?: UsageMetadata

If provided, token usage information associated with the message.

Accessors

text

Methods

concat

toDict

toJSON

toJSONNotImplemented

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc