Class AIMessage

Represents an AI message in a conversation.

Hierarchy (view full)

Constructors

constructor

Properties

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

Accessors

[toStringTag] text

Methods

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.

Optionalinvalid_tool_calls

invalid_tool_calls?: InvalidToolCall[] = []

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.

Optionaltool_calls

tool_calls?: ToolCall[] = []

Optionalusage_metadata

usage_metadata?: UsageMetadata

If provided, token usage information associated with the message.

Accessors

[toStringTag]

text

Methods

getType

toDict

toJSON

toJSONNotImplemented

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods