# WebSearchTool

> **Class** in `langchain_azure_ai`

📖 [View in docs](https://reference.langchain.com/python/langchain-azure-ai/tools/builtin/_tools/WebSearchTool)

A tool that searches the internet for sources related to the prompt.

Wraps :class:`openai.types.responses.WebSearchToolParam`.

Example::

    from langchain_azure_ai.tools.builtin import WebSearchTool

    tool = WebSearchTool(search_context_size="high")
    model_with_search = model.bind_tools([tool])

## Signature

```python
WebSearchTool(
    self,
    *,
    search_context_size: Optional[str] = None,
    user_location: Optional[UserLocation] = None,
    filters: Optional[WebSearchFilters] = None,
)
```

## Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `search_context_size` | `Optional[str]` | No | High-level guidance for the amount of context window space to use for the search.  One of ``"low"``, ``"medium"`` (default), or ``"high"``. (default: `None`) |
| `user_location` | `Optional[UserLocation]` | No | Approximate location of the user.  Use :class:`~openai.types.responses.web_search_tool_param.UserLocation` or a plain :class:`dict` with optional keys ``city``, ``country`` (ISO-3166 two-letter code), ``region``, ``timezone`` (IANA), and ``type="approximate"``. (default: `None`) |
| `filters` | `Optional[WebSearchFilters]` | No | Search filters.  Use :class:`~openai.types.responses.web_search_tool_param.Filters` or a plain :class:`dict` with an optional ``allowed_domains`` list. (default: `None`) |

## Extends

- `BuiltinTool`

## Constructors

```python
__init__(
    self,
    *,
    search_context_size: Optional[str] = None,
    user_location: Optional[UserLocation] = None,
    filters: Optional[WebSearchFilters] = None,
) -> None
```

| Name | Type |
|------|------|
| `search_context_size` | `Optional[str]` |
| `user_location` | `Optional[UserLocation]` |
| `filters` | `Optional[WebSearchFilters]` |


---

[View source on GitHub](https://github.com/langchain-ai/langchain-azure/blob/7a6a664d617264df8dcb12fcfb1bacc09f21d504/libs/azure-ai/langchain_azure_ai/tools/builtin/_tools.py#L157)