Interface: TavilySearchOptions
Defined in: packages/tools/src/web/web-search.ts:60
Properties
apiKey?
optionalapiKey?:Secret
Defined in: packages/tools/src/web/web-search.ts:62
The key, or a function that reads it at call time (env, vault, per-tenant store). Default process.env.TAVILY_API_KEY.
excludeDomains?
optionalexcludeDomains?:string[]
Defined in: packages/tools/src/web/web-search.ts:71
fetch?
optionalfetch?: {(input,init?):Promise<Response>; (input,init?):Promise<Response>; }
Defined in: packages/tools/src/web/web-search.ts:78
Call Signature
(
input,init?):Promise<Response>
Parameters
input
URL | RequestInfo
init?
RequestInit
Returns
Promise<Response>
Call Signature
(
input,init?):Promise<Response>
Parameters
input
string | URL | Request
init?
RequestInit
Returns
Promise<Response>
includeAnswer?
optionalincludeAnswer?:boolean
Defined in: packages/tools/src/web/web-search.ts:68
Ask Tavily for a short written answer. Default false.
includeDomains?
optionalincludeDomains?:string[]
Defined in: packages/tools/src/web/web-search.ts:70
Restrict or exclude domains.
includeImages?
optionalincludeImages?:boolean
Defined in: packages/tools/src/web/web-search.ts:66
Ask Tavily for image results with captions. Default false.
modelParameters?
optionalmodelParameters?:object
Defined in: packages/tools/src/web/web-search.ts:77
Let the model choose, per search: site (search within one domain) and
thorough (a deeper, costlier search). Off by default, so the tool's
schema stays small unless you want these.
site?
optionalsite?:boolean
thorough?
optionalthorough?:boolean
searchDepth?
optionalsearchDepth?:"basic"|"advanced"
Defined in: packages/tools/src/web/web-search.ts:64
basic (default) or advanced (deeper, costs more).