Interface ToolMessageFieldsWithToolCallId

interface ToolMessageFieldsWithToolCallId {
    content: MessageContent;
    tool_call_id: string;
    additional_kwargs?: {
        function_call?: FunctionCall;
        tool_calls?: ToolCall[];
        [key: string]: unknown;
    };
    id?: string;
    name?: string;
    raw_output?: unknown;
    response_metadata?: Record<string, any>;
}

Hierarchy (view full)

Properties

content tool_call_id additional_kwargs? id? name? raw_output? response_metadata?

Properties

content

content: MessageContent

tool_call_id

tool_call_id: string

Optionaladditional_kwargs

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

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

Optionalraw_output

raw_output?: unknown

The raw output of the tool.

Not part of the payload sent to the model. Should only be specified if it is different from the message content, i.e. if only a subset of the full tool output is being passed as message content.

raw_output is excluded when serializing the tool message.

Optionalresponse_metadata

response_metadata?: Record<string, any>

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

Settings

Member Visibility

On This Page

Properties