Skip to content

ToolUIApproval

Namespace: Vercel.AI.Ui

public sealed class ToolUIApproval

The approval of a tool call in a ToolUIPart.

Inheritance: object

View source

public ToolUIApproval(string id)

Creates an approval.

Parameters

Name Type Description
id string

View source

public bool? Approved { get; init; }

Whether the call was approved. Null while the approval is requested.

Value: bool?

View source

public string Id { get; }

The approval id.

Value: string

View source

public bool? IsAutomatic { get; init; }

Whether the approval was decided automatically.

Value: bool?

View source

public string? Reason { get; init; }

Why the call was approved or denied.

Value: string

View source

public string? RequestReason { get; init; }

Why the approval was requested.

Value: string

View source

Apache-2.0 · Copyright 2023 Vercel, Inc. · unofficial community port, not an official Vercel product