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

tool_call_id: string
additional_kwargs?: {
    function_call?: FunctionCall;
    tool_calls?: ToolCall[];
    [key: string]: unknown;
}
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.

id?: string

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

name?: string
response_metadata?: Record<string, any>

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

status?: "error" | "success"

Status of the tool invocation.

0.2.19