Version Notice

This documentation is ahead of the last release by 1 commit. You may see documentation for features not yet supported in the latest release v0.0.29 2025-02-27.

pydantic_ai.common_tools

duckduckgo_search_tool

duckduckgo_search_tool(
    duckduckgo_client: DDGS | None = None,
    max_results: int | None = None,
)

Creates a DuckDuckGo search tool.

Parameters:

Name	Type	Description	Default
duckduckgo_client	DDGS | None	The DuckDuckGo search client.	None
max_results	int | None	The maximum number of results. If None, returns results only from the first response.	None

Source code in pydantic_ai_slim/pydantic_ai/common_tools/duckduckgo.py

def duckduckgo_search_tool(duckduckgo_client: DDGS | None = None, max_results: int | None = None):
    """Creates a DuckDuckGo search tool.

    Args:
        duckduckgo_client: The DuckDuckGo search client.
        max_results: The maximum number of results. If None, returns results only from the first response.
    """
    return Tool(
        DuckDuckGoSearchTool(client=duckduckgo_client or DDGS(), max_results=max_results).__call__,
        name='duckduckgo_search',
        description='Searches DuckDuckGo for the given query and returns the results.',
    )

tavily_search_tool

tavily_search_tool(api_key: str)

Creates a Tavily search tool.

Parameters:

Name	Type	Description	Default
api_key	str	The Tavily API key. You can get one by signing up at https://app.tavily.com/home.	required

Source code in pydantic_ai_slim/pydantic_ai/common_tools/tavily.py

def tavily_search_tool(api_key: str):
    """Creates a Tavily search tool.

    Args:
        api_key: The Tavily API key.

            You can get one by signing up at [https://app.tavily.com/home](https://app.tavily.com/home).
    """
    return Tool(
        TavilySearchTool(client=AsyncTavilyClient(api_key)).__call__,
        name='tavily_search',
        description='Searches Tavily for the given query and returns the results.',
    )