Skip to main content

Interface: WebSearchToolOptions

Defined in: packages/tools/src/web/web-search.ts:161

Properties​

description?​

optional description?: string

Defined in: packages/tools/src/web/web-search.ts:167


maxResults?​

optional maxResults?: number

Defined in: packages/tools/src/web/web-search.ts:166

Results per search when the model does not ask. Default 5; the model may ask for up to 20.


name?​

optional name?: string

Defined in: packages/tools/src/web/web-search.ts:164

Tool name. Default web_search.


parameters?​

optional parameters?: Readonly<{[k: string]: $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>; }>

Defined in: packages/tools/src/web/web-search.ts:173

More inputs for the model, beyond the provider's own parameters. Their values reach the provider as options.params (so a wrapping provider can act on them).


provider​

provider: WebSearchProvider

Defined in: packages/tools/src/web/web-search.ts:162