Skip to content

PrepareResponsesToolsOptions

Namespace: Vercel.AI.OpenAI

public sealed class PrepareResponsesToolsOptions

Options of PrepareResponsesToolsOptions) besides the tools and the tool choice.

Inheritance: object

View source

public OpenAIResponsesAllowedTools? AllowedTools { get; init; }

When set, replaces toolChoice with an allowed_tools choice.

Value: OpenAIResponsesAllowedTools

View source

public ISet<string>? CustomProviderToolNames { get; init; }

Receives the names of the openai.custom tools.

Value: ISet<string>

View source

public ISet<string>? OutputSchemaToolNames { get; init; }

Receives the names of the function tools that declare an output schema.

Value: ISet<string>

View source

public bool SupportsAsyncToolCalling { get; init; }

Whether the model accepts async tools. When false, the option is dropped with a warning. Default true.

Value: bool

View source

public ToolNameMapping? ToolNameMapping { get; init; }

Maps tool names of the request to provider tool names such as web_search.

Value: ToolNameMapping

View source

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