Web SDK documentation
  1. Interfaces
  2. ToolCallPart

File

ai/ai.model.ts

Description

The part of an AI message representing a call to a tool (which may or may not have completed and a result is available).

Index

Properties

Properties

error
error: boolean
Type : boolean
Optional

Set to true for a tool-result where an error occurred. The error message or JSON is in the output field.
input
input: TInput
Type : TInput
Optional

An object representing the input arguments given to the tool. This field is set once it is available, and is complete once the type changes to tool-executing.
output
output: TOutput
Type : TOutput
Optional

The output generated by the tool. This field is set once the type is tool-result. It can also be updated by the UI client.

This can be a string, a JSON-serializable object, or (for multi-part outputs) an array of content parts.
outputType
outputType: "content" | string
Type : "content" | string
Optional

If the output was not a string or a JSON object, records the format it was received in to support accurate round-tripping when the tool output is included in future requests. For example, "content" indicates the output is a multi-part content array.
toolCallId
toolCallId: string
Type : string

Unique identifier for this invocation of the tool, used to match calls with results.
toolName
toolName: string
Type : string

Unique identifier for the tool, as specified in the MCP server and agent definition.
type
type: "tool-input-streaming" | "tool-executing" | "tool-result"
Type : "tool-input-streaming" | "tool-executing" | "tool-result"

The status of the tool call - whether it is currently streaming its input, in progress, or has completed and a result (output or error) is available

results matching ""

    No results matching ""