Interface ToolMessageFieldsWithToolCallId

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

Hierarchy (view full)

Properties

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

Properties

Optionaladditional_kwargs

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

Type declaration

  • [key: string]: unknown
  • Optionalfunction_call?: FunctionCall

    Deprecated

    Use "tool_calls" field on AIMessages instead

  • Optionaltool_calls?: OpenAIToolCall[]

    Deprecated

    Use "tool_calls" field on AIMessages instead

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.

content

content: string | (DataContentBlock | MessageContentComplex)[]

Optionalid

id?: string

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

Optionalmetadata

metadata?: Record<string, unknown>

Optionalname

name?: string

Optionalresponse_metadata

response_metadata?: Record<string, any>

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

Optionalstatus

status?: "success" | "error"

Status of the tool invocation.

Version

0.2.19

tool_call_id

tool_call_id: string

Settings

Member Visibility

On This Page

Properties