# ChatGenerationParamsPluginWeb


## Fields

| Field                                                                                                                                         | Type                                                                                                                                          | Required                                                                                                                                      | Description                                                                                                                                   | Example                                                                                                                                       |
| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`                                                                                                                                          | [components.ChatGenerationParamsIDWeb](../components/chatgenerationparamsidweb.md)                                                            | :heavy_check_mark:                                                                                                                            | N/A                                                                                                                                           |                                                                                                                                               |
| `enabled`                                                                                                                                     | *Optional[bool]*                                                                                                                              | :heavy_minus_sign:                                                                                                                            | Set to false to disable the web-search plugin for this request. Defaults to true.                                                             |                                                                                                                                               |
| `max_results`                                                                                                                                 | *Optional[float]*                                                                                                                             | :heavy_minus_sign:                                                                                                                            | N/A                                                                                                                                           |                                                                                                                                               |
| `search_prompt`                                                                                                                               | *Optional[str]*                                                                                                                               | :heavy_minus_sign:                                                                                                                            | N/A                                                                                                                                           |                                                                                                                                               |
| `engine`                                                                                                                                      | [Optional[components.WebSearchEngine]](../components/websearchengine.md)                                                                      | :heavy_minus_sign:                                                                                                                            | The search engine to use for web search.                                                                                                      |                                                                                                                                               |
| `include_domains`                                                                                                                             | List[*str*]                                                                                                                                   | :heavy_minus_sign:                                                                                                                            | A list of domains to restrict web search results to. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog").  | [<br/>"example.com",<br/>"*.substack.com",<br/>"openai.com/blog"<br/>]                                                                        |
| `exclude_domains`                                                                                                                             | List[*str*]                                                                                                                                   | :heavy_minus_sign:                                                                                                                            | A list of domains to exclude from web search results. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog"). | [<br/>"example.com",<br/>"*.substack.com",<br/>"openai.com/blog"<br/>]                                                                        |