Optional
apiOptional
apiAn API wrapper that can be used to interact with the Tavily Extract API. Useful for testing.
If specified, the tool will use this API wrapper instead of creating a new one, and fields used in API Wrapper initialization, like TavilyExtractAPIRetrieverFields.tavilyApiKey, will be ignored.
Optional
description?: undefined | stringThe description of the tool.
Optional
extractThe depth of the extract. It can be "basic" or "advanced".
Optional
format?: undefined | "markdown" | "text"The format of the respose. It can be "markdown" or "text"
Optional
includeWhether to include the favicon URL for each result.
Optional
includeInclude a list of query-related images in the response.
Optional
name?: undefined | stringThe name of the tool.
Optional
returnWhether to return the tool's output directly.
Setting this to true means that after the tool is called, an agent should stop looping.
Optional
tavilyThe API key used for authentication with the Tavily Search API.
The base URL to be used for the Tavily Extract API.