Interface ToolMessageFieldsWithToolCallId<RawOutput>

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

Type Parameters

  • RawOutput = any

Hierarchy (view full)

Properties

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

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

name?: string
raw_output?: RawOutput

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.

response_metadata?: Record<string, any>

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