ToolInputStartStreamPart

Namespace: Vercel.AI.Provider

public sealed class ToolInputStartStreamPart : LanguageModelStreamPart

Marks the start of streamed tool input.

Inheritance: object → LanguageModelStreamPart

View source

Constructors

ToolInputStartStreamPart(string, string, JsonElement?, bool?, bool?, string?, ToolInputEncoding?)

public ToolInputStartStreamPart(string id, string toolName, JsonElement? providerMetadata = null, bool? providerExecuted = null, bool? dynamic = null, string? title = null, ToolInputEncoding? inputEncoding = null)

Creates a tool-input-start part.

Parameters

Name	Type	Description
id	string
toolName	string
providerMetadata	JsonElement?
providerExecuted	bool?
dynamic	bool?
title	string
inputEncoding	ToolInputEncoding?

View source

Properties

Dynamic

public bool? Dynamic { get; }

True for a tool the caller did not declare.

Value: bool?

View source

Id

public string Id { get; }

Tool call id.

Value: string

View source

InputEncoding

public ToolInputEncoding? InputEncoding { get; }

Encoding of the input deltas. Defaults to JSON when <a href=“https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null"&gt;null&lt;/a>. Text deltas concatenate to a raw string. The final tool call input must still be JSON-encoded, whatever the delta encoding.

Value: ToolInputEncoding?

View source

ProviderExecuted

public bool? ProviderExecuted { get; }

True when the provider executes the tool.

Value: bool?

View source

ProviderMetadata

public JsonElement? ProviderMetadata { get; }

Provider metadata for this tool input.

Value: JsonElement?

View source

Title

public string? Title { get; }

Optional tool title.

Value: string

View source

ToolName

public string ToolName { get; }

Tool name.

Value: string

View source