langchain.js
    Preparing search index...

    Type Alias TavilySearchAPIRetrieverFields

    TavilySearchAPIRetrieverFields: BaseDynamicToolInput & {
        apiKey?: string;
        apiUrl?: string;
        days?: number;
        excludeDomains?: string[];
        includeAnswer?: boolean;
        includeDomains?: string[];
        includeImageDescriptions?: boolean;
        includeImages?: boolean;
        includeRawContent?: boolean;
        kwargs?: Record<string, unknown>;
        maxResults?: number;
        searchDepth?: "basic" | "deep";
        topic?: string;
    }

    Options for the TavilySearchResults tool. (Deprecated)

    Type Declaration

    • OptionalapiKey?: string

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

    • OptionalapiUrl?: string

      The base API url used for the Tavily Search API.

      "https://api.tavily.com"
    • Optionaldays?: number

      The number of days back from the current date to include in the search results.

      3
    • OptionalexcludeDomains?: string[]

      A list of domains to specifically exclude from the search results.

      []
    • OptionalincludeAnswer?: boolean

      Include a short answer to the original query.

      false
    • OptionalincludeDomains?: string[]

      A list of domains to specifically include in the search results.

      []
    • OptionalincludeImageDescriptions?: boolean

      When includeImages is set to True, this option adds descriptive text for each image.

      false
    • OptionalincludeImages?: boolean

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

      false
    • OptionalincludeRawContent?: boolean

      Include the cleaned and parsed HTML content of each search result.

      false
    • Optionalkwargs?: Record<string, unknown>

      Additional keyword arguments to pass to the API.

    • OptionalmaxResults?: number

      The maximum number of search results to return.

      5
    • OptionalsearchDepth?: "basic" | "deep"

      The depth of the search. It can be "basic" or "deep".

      "basic"
    • Optionaltopic?: string

      The category of the search. This will determine which of our agents will be used for the search. Currently, only "general" and "news" are supported. See https://docs.tavily.com/docs/rest-api/api-reference

      "general"

    Please use the TavilySearch tool from the @langchain/tavily package, instead.

    Settings

    Member Visibility