Class ToolMessage

Represents a tool message in a conversation.

Hierarchy (view full)

Constructors

constructor

Properties

additional_kwargs content response_metadata tool_call_id artifact? id? name? status?

Accessors

[toStringTag] text

Methods

toDict toJSON toJSONNotImplemented isInstance

Constructors

constructor

Properties

additional_kwargs

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

Additional keyword arguments

content

content: MessageContent

The content of the message.

response_metadata

response_metadata: Record<string, any>

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

tool_call_id

tool_call_id: string

Optionalartifact

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.

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.

Optionalstatus

status?: "error" | "success"

Status of the tool invocation.

Version

0.2.19

Accessors

[toStringTag]

text

Methods

toDict

toJSON

toJSONNotImplemented

StaticisInstance

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods