ToolChoiceViolationException

Namespace: Vercel.AI.GenerateText

public sealed class ToolChoiceViolationException : AiSdkException, ISerializable

The model response did not satisfy toolChoice. Maps to ToolChoiceViolationError.

Inheritance: object → Exception → AiSdkException

Implements: ISerializable

View source

Constructors

ToolChoiceViolationException(string, ToolChoice, FinishReason, string, string, IReadOnlyList<GeneratedContent>)

public ToolChoiceViolationException(string message, ToolChoice toolChoice, FinishReason finishReason, string provider, string modelId, IReadOnlyList<GeneratedContent> content)

Creates the exception.

Parameters

Name	Type	Description
message	string
toolChoice	ToolChoice
finishReason	FinishReason
provider	string
modelId	string
content	IReadOnlyList<GeneratedContent>

View source

Properties

Content

public IReadOnlyList<GeneratedContent> Content { get; }

Content from the rejected model call.

Value: IReadOnlyList<GeneratedContent>

View source

FinishReason

public FinishReason FinishReason { get; }

Finish reason from the model call.

Value: FinishReason

View source

ModelId

public string ModelId { get; }

Model id.

Value: string

View source

Name

public string Name { get; }

Stable error name.

Value: string

View source

Provider

public string Provider { get; }

Model provider id.

Value: string

View source

ToolChoice

public ToolChoice ToolChoice { get; }

Tool choice that was violated.

Value: ToolChoice

View source