TavilyMapInput

class langchain_tavily.tavily_map.TavilyMapInput

Bases: BaseModel

Input for [TavilyMap]

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

param allow_external: bool | None = False

Allow the crawler to follow external links.

Use when the user explicitly asks to allow or deny external links.

param categories: List[Literal['Careers', 'Blog', 'Documentation', 'About', 'Pricing', 'Community', 'Developers', 'Contact', 'Media']] | None = None

Direct the crawler to crawl specific categories of a website.

Set this field to the category that best matches the user’s request. Use the following guide to choose the appropriate category:

Careers: Crawl pages related to job listings, open positions, and company career information. Blog: Crawl blog posts, news articles, and editorial content. Documentation: Crawl technical documentation, user guides, API references, and manuals. About: Crawl ‘About Us’ pages, company background, mission statements, and team information. Pricing: Crawl pages that detail product or service pricing, plans, and cost comparisons. Community: Crawl forums, discussion boards, user groups, and community-driven content. Developers: Crawl developer portals, SDKs, API documentation, and resources for software developers. Contact: Crawl contact information pages, support forms, and customer service details. Media: Crawl press releases, media kits, newsrooms, and multimedia content.

ex. “Crawl apple.com for career opportunities” —> categories=”Careers” ex. “Crawl tavily.com for API documentation” —> categories=”Documentation”

param exclude_domains: List[str] | None = None

Regex patterns to exclude URLs from specific domains or subdomains.

Use when the user explicitly asks to exclude a specific domain or subdomain from a website.

ex. “Map tavily.com but exclude the docs.tavily.com subdomain from the map” —> [“^docs.tavily.com$”]

param exclude_paths: List[str] | None = None

Regex patterns to exclude URLs from the map with specific path patterns.

Use when the user explicitly asks to exclude a specific path from a website.

ex. “Map example.com but exclude the /api/v1 path form the map” —> [“/api/v1.*”] ex. “Map example.com but exclude the /documentation path from the map” —> [“/documentation/.*”]

param instructions: str | None = None

Natural language instructions for the mapper.

The instructions parameter allows the mapper to intelligently navigate through a website using natural language. Take the users request to set the instructions parameter to guide the mapper in the direction of the users request.

ex. “I want to find all the Javascript SDK documentation from Tavily” —> instructions = “Javascript SDK documentation”

param limit: int | None = 50

Total number of links the mapper will process before stopping.

limit must be greater than 0

param max_breadth: int | None = 20

Max number of links to follow per level of the tree (i.e., per page).

tavily-map uses a BFS Depth: referring to the number of link hops from the root URL. A page directly linked from the root is at BFS depth 1, regardless of its URL structure.

Increase this parameter when: 1. You want many links from each page to be mapped.

max_breadth must be greater than 0

param max_depth: int | None = 1

Max depth of the mapping. Defines how far from the base URL the crawler can explore.

Increase this parameter when: 1. To map large websites and get a comprehensive overview of its structure. 2. To map a website that has a lot of links to other pages.

Set this parameter to 1 when: 1. To stay local to the base_url 2. To map a single page

max_depth must be greater than 0

param select_domains: List[str] | None = None

Regex patterns to select only URLs from specific domains or subdomains.

Use when the user explicitly asks for a specific domain or subdomain from a website.

ex. “Map only the docs.tavily.com subdomain” —> [“^docs.tavily.com$”]

param select_paths: List[str] | None = None

Regex patterns to select only URLs with specific path patterns.

Use when the user explicitly asks for a specific path from a website.

ex. “Only map the /api/v1 path” —> [“/api/v1.*”] ex. “Only map the /documentation path” —> [“/documentation/.*”]

param url: str [Required]

The root URL to begin the mapping.