Type Alias TavilyCrawlAPIRetrieverFields

TavilyCrawlAPIRetrieverFields: {
    allowExternal?: undefined | boolean;
    apiBaseUrl?: undefined | string;
    apiWrapper?: undefined | TavilyCrawlAPIWrapper;
    callbacks: undefined | Callbacks;
    categories?: undefined | CrawlCategory[];
    description?: undefined | string;
    excludeDomains?: undefined | string[];
    excludePaths?: undefined | string[];
    extractDepth?: undefined | ExtractDepth;
    format?: undefined | "markdown" | "text";
    includeFavicon?: undefined | boolean;
    includeImages?: undefined | boolean;
    instructions?: undefined | string;
    limit?: undefined | number;
    maxBreadth?: undefined | number;
    maxDepth?: undefined | number;
    metadata: undefined | Record<string, unknown>;
    name?: undefined | string;
    responseFormat: undefined | string;
    returnDirect?: undefined | boolean;
    selectDomains?: undefined | string[];
    selectPaths?: undefined | string[];
    tags: undefined | string[];
    tavilyApiKey?: undefined | string;
    verbose: undefined | boolean;
    verboseParsingErrors: undefined | boolean;
}

Type declaration

  • OptionalallowExternal?: undefined | boolean

    Allow crawling external domains.

    Default

    undefined
  • OptionalapiBaseUrl?: undefined | string

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

  • OptionalapiWrapper?: undefined | TavilyCrawlAPIWrapper

    An API wrapper that can be used to interact with the Tavily Crawl 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 TavilyCrawlAPIRetrieverFields.tavilyApiKey, will be ignored.

  • callbacks: undefined | Callbacks
  • Optionalcategories?: undefined | CrawlCategory[]

    Only crawl URLs containing these categories.

    Default

    undefined
  • Optionaldescription?: undefined | string

    The description of the tool.

    Default

    "Starts a smart web crawl from a given URL."
  • OptionalexcludeDomains?: undefined | string[]

    Exclude these domains.

    Default

    undefined
  • OptionalexcludePaths?: undefined | string[]

    Exclude these paths.

    Default

    undefined
  • OptionalextractDepth?: undefined | ExtractDepth

    The depth of the extractions. 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

    Include the favicon URL for each crawl result.

    Default

    false
  • OptionalincludeImages?: undefined | boolean

    Include images in the crawl results.

    Default

    false
  • Optionalinstructions?: undefined | string

    Natural language instructions to guide the crawler

    Default

    undefined
  • Optionallimit?: undefined | number

    The maximum number of pages to crawl.

    Default

    100
  • OptionalmaxBreadth?: undefined | number

    The maximum number of pages to crawl per level.

    Default

    50
  • OptionalmaxDepth?: undefined | number

    The maximum number of hops from the starting URL.

    Default

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

    The name of the tool.

    Default

    "tavily_crawl"
  • 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
  • OptionalselectDomains?: undefined | string[]

    Only crawl these domains.

    Default

    undefined
  • OptionalselectPaths?: undefined | string[]

    Only crawl URLs containing these paths.

    Default

    undefined
  • 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