Class WebSearchTool

src/agents/tool.py:688–711

A hosted tool that lets the LLM search the web. Currently only supported with OpenAI models, using the Responses API.

@dataclass
class WebSearchTool:
    """A hosted tool that lets the LLM search the web. Currently only supported with OpenAI models,
    using the Responses API.
    """

    user_location: UserLocation | None = None
    """Optional location for the search. Lets you customize results to be relevant to a location."""

    filters: WebSearchToolFilters | None = None
    """A filter to apply based on file attributes."""

    search_context_size: Literal["low", "medium", "high"] = "medium"
    """The amount of context to use for the search."""

    external_web_access: bool | None = None
    """Whether the web search tool may fetch live internet content.

    When omitted, the API default is used. Set to `False` to request cached or
    indexed-only behavior where supported.
    """

    @property
    def name(self):
        return "web_search"


@dataclass(eq=False)