Interface ToolMessageFieldsWithToolCallId

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

Hierarchy (view full)

Properties

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

Properties

content

content: MessageContent

tool_call_id

tool_call_id: string

Optionaladditional_kwargs

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

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

Optionalresponse_metadata

response_metadata?: Record<string, any>

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

Optionalstatus

status?: "error" | "success"

Status of the tool invocation.

Version

0.2.19

Settings

Member Visibility

On This Page

Properties