WebFetchToolOptions

Namespace: Vercel.AI.WebFetch

public sealed class WebFetchToolOptions

Options of the web fetch tool. Maps to the options of createWebFetchTool.

Inheritance: object

View source

Properties

AllowedDomains

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

Only allow fetching from these domains and their subdomains. Cannot be combined with BlockedDomains.

Value: IReadOnlyList<string>

View source

BlockedDomains

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

Never fetch from these domains or their subdomains. Cannot be combined with AllowedDomains.

Value: IReadOnlyList<string>

View source

DefuddleOptions

public WebFetchDefuddleOptions? DefuddleOptions { get; set; }

Options for the HTML content extractor, e.g. ContentSelector to choose the main content element.

Value: WebFetchDefuddleOptions

View source

Fetch

public DownloadFetch? Fetch { get; set; }

Custom fetch implementation. It must validate resolved addresses, like a DNS-pinned transport would.

Value: DownloadFetch

View source

MaxBytes

public long MaxBytes { get; set; }

Maximum response size in bytes. Defaults to 10 MiB.

Value: long

View source

MaxLength

public int MaxLength { get; set; }

Maximum characters returned per call. Longer content can be read with the offset input. Defaults to 50,000.

Value: int

View source

RequireUrlInUserMessage

public bool RequireUrlInUserMessage { get; set; }

Only fetch URLs that appear in user messages. Prevents the model from fetching URLs it constructed itself, e.g. to exfiltrate data. Defaults to false.

Value: bool

View source

Timeout

public TimeSpan Timeout { get; set; }

Timeout for fetching each URL, including redirects. Defaults to 30 seconds.

Value: TimeSpan

View source