Type Alias TavilyExtractAPIRetrieverFields

TavilyExtractAPIRetrieverFields: {
    apiBaseUrl?: undefined | string;
    apiWrapper?: undefined | TavilyExtractAPIWrapper;
    callbacks: undefined | Callbacks;
    description?: undefined | string;
    extractDepth?: undefined | ExtractDepth;
    format?: undefined | "markdown" | "text";
    includeFavicon?: undefined | boolean;
    includeImages?: undefined | boolean;
    metadata: undefined | Record<string, unknown>;
    name?: undefined | string;
    responseFormat: undefined | string;
    returnDirect?: undefined | boolean;
    tags: undefined | string[];
    tavilyApiKey?: undefined | string;
    verbose: undefined | boolean;
    verboseParsingErrors: undefined | boolean;
}

Type declaration

  • OptionalapiBaseUrl?: undefined | string

    The base URL to be used for the Tavily Extract API.

  • OptionalapiWrapper?: undefined | TavilyExtractAPIWrapper

    An 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.

  • callbacks: undefined | Callbacks
  • Optionaldescription?: undefined | string

    The description of the tool.

    Default

    "Extracts comprehensive content from web pages based on provided URLs. Useful for when you need to answer questions about current events. Input should be a list of one or more URLs."
  • OptionalextractDepth?: undefined | ExtractDepth

    The depth of the extract. It can be "basic" or "advanced".

  • Optionalformat?: undefined | "markdown" | "text"

    The format of the respose. It can be "markdown" or "text"

    Default

    "markdown"
  • OptionalincludeFavicon?: undefined | boolean

    Whether to include the favicon URL for each result.

    Default

    false
  • OptionalincludeImages?: undefined | boolean

    Include a list of query-related images in the response.

    Default

    false
  • metadata: undefined | Record<string, unknown>
  • Optionalname?: undefined | string

    The name of the tool.

    Default

    "tavily_extract"
  • responseFormat: undefined | string
  • OptionalreturnDirect?: undefined | boolean

    Whether to return the tool's output directly.

    Setting this to true means that after the tool is called, an agent should stop looping.

    Default

    false
  • tags: undefined | string[]
  • OptionaltavilyApiKey?: undefined | string

    The API key used for authentication with the Tavily Search API.

  • verbose: undefined | boolean
  • verboseParsingErrors: undefined | boolean

Settings

Member Visibility