GeneratedToolResult

public sealed class GeneratedToolResult : GeneratedContent

A tool result: one the provider produced itself, such as a web or file search, or one the generation loop produced by running a client tool.

Inheritance: object → GeneratedContent

Constructors

public GeneratedToolResult(string toolCallId, string toolName, string resultJson, bool isError = false)

Creates a provider-executed tool result.

Parameters

public bool Dynamic { get; init; }

True when the tool is dynamic. Maps to the result’s dynamic.

Value: bool

public Exception? Error { get; init; }

The exception the tool threw, when the generation loop ran a client tool that failed.

Value: Exception

public bool IsError { get; }

Whether the tool failed.

Value: bool

public JsonElement? ProviderMetadata { get; init; }

Provider-specific metadata for this result, keyed by provider name.

Value: JsonElement?

public string ResultJson { get; }

JSON result.

Value: string

public string ToolCallId { get; }

Matching tool call id.

Value: string

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

Metadata of the tool, apart from provider metadata. Maps to the result’s toolMetadata.

Value: IReadOnlyDictionary<string, JsonElement>

public string ToolName { get; }

Tool name.

Value: string