ExecutedTool

Namespace: Vercel.AI

public sealed class ExecutedTool

The result of executing a tool.

Inheritance: object

View source

Constructors

ExecutedTool(string, string, string, bool)

public ExecutedTool(string toolCallId, string toolName, string outputJson, bool isError)

Creates a tool result.

Parameters

Name	Type	Description
toolCallId	string
toolName	string
outputJson	string
isError	bool

View source

Properties

Dynamic

public bool Dynamic { get; init; }

True when the tool is dynamic: a dynamic tool, a provider-executed dynamic call, or an invalid call. Maps to the result’s dynamic.

Value: bool

View source

Error

public Exception? Error { get; init; }

The exception the tool threw, when IsError is set by a failed execution. Maps to the error part’s error.

Value: Exception

View source

InputJson

public string? InputJson { get; init; }

The JSON input of the tool call this result answers, after any repair and refinement. Maps to the result’s input.

Value: string

View source

IsError

public bool IsError { get; }

Whether execution failed or was denied.

Value: bool

View source

OutputJson

public string OutputJson { get; }

JSON output.

Value: string

View source

ProviderExecuted

public bool ProviderExecuted { get; init; }

True when the provider ran the tool. Maps to the result’s providerExecuted.

Value: bool

View source

ProviderMetadata

public JsonElement? ProviderMetadata { get; init; }

Provider-specific metadata of the result, keyed by provider name.

Value: JsonElement?

View source

Title

public string? Title { get; init; }

Display title of the tool. Maps to the result’s title.

Value: string

View source

ToolCallId

public string ToolCallId { get; }

Tool call id.

Value: string

View source

ToolMetadata

public IReadOnlyDictionary<string, JsonElement>? ToolMetadata { get; init; }

Metadata of the tool. It stays apart from ProviderMetadata. Maps to the result’s toolMetadata.

Value: IReadOnlyDictionary<string, JsonElement>

View source

ToolName

public string ToolName { get; }

Tool name.

Value: string

View source