Skip to content

OpenAIWebSearchToolOptions

Namespace: Vercel.AI.OpenAI

public sealed class OpenAIWebSearchToolOptions

Options of WebSearch(OpenAIWebSearchToolOptions).

Inheritance: object

View source

public IReadOnlyList<string>? AllowedDomains { get; set; }

Domains the search may use.

Value: IReadOnlyList<string>

View source

public IReadOnlyList<string>? BlockedDomains { get; set; }

Domains the search must not use.

Value: IReadOnlyList<string>

View source

public bool? ExternalWebAccess { get; set; }

Whether the tool may reach the live web.

Value: bool?

View source

public string? SearchContextSize { get; set; }

Search context size: low, medium, or high.

Value: string

View source

public OpenAIApproximateLocation? UserLocation { get; set; }

Approximate user location.

Value: OpenAIApproximateLocation

View source

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