WebSearchPlugin - Go SDK

WebSearchPlugin type definition

The Go SDK and docs are currently in beta. Report issues on GitHub.

Fields

FieldTypeRequiredDescriptionExample
Enabled*boolSet to false to disable the web-search plugin for this request. Defaults to true.
Engine*components.WebSearchEngineThe search engine to use for web search.exa
ExcludeDomains[]stringA list of domains to exclude from web search results. Supports wildcards (e.g. “*.substack.com”) and path filtering (e.g. “openai.com/blog”).[
“example.com”,
“*.substack.com”,
“openai.com/blog”
]
IDcomponents.WebSearchPluginID✔️N/A
IncludeDomains[]stringA list of domains to restrict web search results to. Supports wildcards (e.g. “*.substack.com”) and path filtering (e.g. “openai.com/blog”).[
“example.com”,
“*.substack.com”,
“openai.com/blog”
]
MaxResults*int64N/A
MaxUses*int64Maximum number of times the model can invoke web search in a single turn. Passed through to native providers that support it (e.g. Anthropic).
SearchPrompt*stringN/A
UserLocationoptionalnullable.OptionalNullable[components.UserLocation]N/A{"city": "San Francisco","country": "US","region": "California","timezone": "America/Los_Angeles","type": "approximate"}