CollectedToolApproval

Namespace: Vercel.AI.GenerateText

public sealed class CollectedToolApproval

One approval that still needs execution or denial handling.

Inheritance: object

View source

Constructors

CollectedToolApproval(ApprovalRequestPart, ApprovalResponsePart, ApprovalToolCallPart, ApprovalToolResultPart?)

public CollectedToolApproval(ApprovalRequestPart approvalRequest, ApprovalResponsePart approvalResponse, ApprovalToolCallPart toolCall, ApprovalToolResultPart? existingToolResult = null)

Creates a collected approval.

Parameters

Name	Type	Description
approvalRequest	ApprovalRequestPart
approvalResponse	ApprovalResponsePart
toolCall	ApprovalToolCallPart
existingToolResult	ApprovalToolResultPart

View source

Properties

ApprovalRequest

public ApprovalRequestPart ApprovalRequest { get; }

Matching approval request.

Value: ApprovalRequestPart

View source

ApprovalResponse

public ApprovalResponsePart ApprovalResponse { get; }

Approval response.

Value: ApprovalResponsePart

View source

ExistingToolResult

public ApprovalToolResultPart? ExistingToolResult { get; }

Existing tool result, when a denied call already has an execution-denied output.

Value: ApprovalToolResultPart

View source

ToolCall

public ApprovalToolCallPart ToolCall { get; }

Tool call the approval refers to.

Value: ApprovalToolCallPart

View source