ToolExecutionOptions

Namespace: Vercel.AI

public sealed class ToolExecutionOptions

The options a tool receives when it runs. Maps to the second argument of execute.

Inheritance: object

Constructors

public ToolExecutionOptions(string toolCallId, IReadOnlyList<ModelMessage> messages, CancellationToken abortSignal)

Creates the options.

Parameters

Name	Type	Description
`toolCallId`	string
`messages`	IReadOnlyList<ModelMessage>
`abortSignal`	CancellationToken

public CancellationToken AbortSignal { get; }

Cancellation signal of the call.

Value: CancellationToken

public IReadOnlyList<ModelMessage> Messages { get; }

Messages sent to the model in the step that made the call.

Value: IReadOnlyList<ModelMessage>

public string ToolCallId { get; }

Id of the tool call.

Value: string