DOCSAPI reference

INTERFACE

AgentToolCall

Defined in: packages/components/src/agents/types.ts:21

A tool call in the OpenAI-compatible format. Providers may add the internal tool_name and parsed arguments fields.

Properties

Property Type Description Defined in
arguments? string | Record<string, unknown> Parsed arguments, or the raw JSON text while streaming, when the provider adds them. packages/components/src/agents/types.ts:36
function object Function name and raw JSON arguments, as sent by the model. packages/components/src/agents/types.ts:27
function.arguments string Arguments as a JSON string. packages/components/src/agents/types.ts:31
function.name string Name of the tool to call. packages/components/src/agents/types.ts:29
id string Identifier that a tool message uses to answer this call. packages/components/src/agents/types.ts:23
tool_name? string Tool name in the internal format, when the provider adds it. packages/components/src/agents/types.ts:34
type string Call type. Model providers send function. packages/components/src/agents/types.ts:25