# OpenResponsesWebSearchPreviewTool

Web search preview tool configuration


## Fields

| Field                                                                                                                                                                                                                                                                                          | Type                                                                                                                                                                                                                                                                                           | Required                                                                                                                                                                                                                                                                                       | Description                                                                                                                                                                                                                                                                                    | Example                                                                                                                                                                                                                                                                                        |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type`                                                                                                                                                                                                                                                                                         | [components.OpenResponsesWebSearchPreviewToolType](../components/openresponseswebsearchpreviewtooltype.md)                                                                                                                                                                                     | :heavy_check_mark:                                                                                                                                                                                                                                                                             | N/A                                                                                                                                                                                                                                                                                            |                                                                                                                                                                                                                                                                                                |
| `search_context_size`                                                                                                                                                                                                                                                                          | [Optional[components.ResponsesSearchContextSize]](../components/responsessearchcontextsize.md)                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                             | Size of the search context for web search tools                                                                                                                                                                                                                                                | medium                                                                                                                                                                                                                                                                                         |
| `user_location`                                                                                                                                                                                                                                                                                | [OptionalNullable[components.WebSearchPreviewToolUserLocation]](../components/websearchpreviewtooluserlocation.md)                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                             | N/A                                                                                                                                                                                                                                                                                            |                                                                                                                                                                                                                                                                                                |
| `engine`                                                                                                                                                                                                                                                                                       | [Optional[components.OpenResponsesWebSearchPreviewToolEngine]](../components/openresponseswebsearchpreviewtoolengine.md)                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                             | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search (parameters like max_results, search_context_size, and domain filters are not forwarded to the provider). "exa" forces the Exa search API. | auto                                                                                                                                                                                                                                                                                           |
| `max_results`                                                                                                                                                                                                                                                                                  | *Optional[float]*                                                                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                             | Maximum number of search results to return per search call. Defaults to 5. Only applies when using the Exa engine; ignored with native provider search.                                                                                                                                        | 5                                                                                                                                                                                                                                                                                              |
| `filters`                                                                                                                                                                                                                                                                                      | [OptionalNullable[components.OpenResponsesWebSearchPreviewToolFilters]](../components/openresponseswebsearchpreviewtoolfilters.md)                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                             | N/A                                                                                                                                                                                                                                                                                            |                                                                                                                                                                                                                                                                                                |