Class ChatMessageChunk

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

Hierarchy (view full)

Constructors

constructor

Properties

additional_kwargs content id? name? response_metadata role

Accessors

[toStringTag] text

Methods

concat getType toDict toJSON toJSONNotImplemented

Constructors

constructor

Properties

additional_kwargs

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

Additional keyword arguments

Type declaration

  • [key: string]: unknown
  • Optionalfunction_call?: FunctionCall

    Deprecated

    Use "tool_calls" field on AIMessages instead

  • Optionaltool_calls?: OpenAIToolCall[]

    Deprecated

    Use "tool_calls" field on AIMessages instead

content

content: MessageContent

The content of the message.

Optionalid

id?: string

An optional unique identifier for the message. This should ideally be provided by the provider/model which created the message.

Optionalname

name?: string

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

response_metadata

response_metadata: Record<string, any>

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

role

role: string

Accessors

[toStringTag]

text

Methods

concat

getType

toDict

toJSON

toJSONNotImplemented

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods