Represents a tool message in a conversation.

Hierarchy (view full)

Constructors

Properties

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

Additional keyword arguments

Type declaration

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

    Use "tool_calls" field on AIMessages instead

  • Optionaltool_calls?: OpenAIToolCall[]

    Use "tool_calls" field on AIMessages instead

artifact?: any

Artifact of the Tool execution which is not meant to be sent to the model.

Should only be specified if it is different from the message content, e.g. if only a subset of the full tool output is being passed as message content but the full output is needed in other parts of the code.

The content of the message.

id?: string

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

name?: string

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

response_metadata: Record<string, any>

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

status?: "success" | "error"

Status of the tool invocation.

0.2.19

tool_call_id: string

Accessors

Methods