Skip to content

feat(web-search): add domain filtering, user location, and structured search actions #5817

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leseb merged 23 commits into from
May 27, 2026
Merged

feat(web-search): add domain filtering, user location, and structured search actions #5817

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
b1176d6
feat(api): add filters and user_location to web search tool model
leseb May 7, 2026
98e3766
feat(responses): thread web search config through tool executor
leseb May 7, 2026
c615e26
feat(brave-search): add domain filtering, user location, and context …
leseb May 7, 2026
036e072
feat(bing-search): add domain filtering, user location, and context size
leseb May 7, 2026
b4640e4
feat(tavily-search): add domain filtering and search context size
leseb May 7, 2026
69b64b9
feat!(api): add WebSearchToolCall action models for search/open_page/…
leseb May 7, 2026
67daae1
feat(search): return structured source metadata from all search backends
leseb May 7, 2026
f1bda43
feat(responses): populate WebSearchToolCall.action with source URLs
leseb May 7, 2026
fa71063
chore: add missing __init__.py for test package
leseb May 7, 2026
a5c1a16
chore: regenerate OpenAPI specs after rebase against upstream/main
leseb May 12, 2026
dedf012
fix(brave-search): align result slicing with search_context_size count
leseb May 12, 2026
b51550e
fix(test): use exact URL match to satisfy CodeQL substring sanitizati…
leseb May 13, 2026
f0fa67a
fix(test): use set equality to avoid CodeQL URL substring sanitizatio…
leseb May 13, 2026
e917e2b
Merge remote-tracking branch 'origin/main' into plan-development-for-…
leseb May 13, 2026
f68548e
Merge remote-tracking branch 'upstream/main' into plan-development-fo…
leseb May 13, 2026
0db4cae
fix(test): update bing and tavily tests for persistent client refactor
leseb May 13, 2026
851aee3
Merge remote-tracking branch 'upstream/main' into plan-development-fo…
leseb May 13, 2026
6abbf5a
fix(api): default search_context_size to None to preserve recording c…
leseb May 13, 2026
76d1745
fix(test): add recordings for web search with search_context_size: low
leseb May 13, 2026
8632a93
chore(api): remove :param docstrings from web search models
leseb May 26, 2026
14b7b8d
refactor(responses): make web_search its own elif branch in tool exec…
leseb May 26, 2026
d57f6d6
Merge remote-tracking branch 'upstream/main' into plan-development-fo…
leseb May 27, 2026
164f5e4
refactor(test): move web search config tests to dedicated test file
leseb May 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
254 changes: 225 additions & 29 deletions client-sdks/stainless/openapi.yml
View file
Open in desktop

Large diffs are not rendered by default.

238 changes: 217 additions & 21 deletions docs/static/deprecated-ogx-spec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2090,24 +2090,35 @@ components:
title: OpenAIResponseOutputMessageMCPListTools
description: MCP list tools output message containing available tools from an MCP server.
OpenAIResponseOutputMessageWebSearchToolCall:
description: Web search tool call output message for OpenAI responses.
properties:
id:
type: string
title: Id
status:
type: string
status:
title: Status
type:
type: string
type:
title: Type
type: string
enum:
- web_search_call
type: object
action:
anyOf:
- $ref: '#/components/schemas/WebSearchActionSearch'
title: WebSearchActionSearch
- $ref: '#/components/schemas/WebSearchActionOpenPage'
title: WebSearchActionOpenPage
- $ref: '#/components/schemas/WebSearchActionFind'
title: WebSearchActionFind
- type: 'null'
title: WebSearchActionSearch | WebSearchActionOpenPage | WebSearchActionFind
nullable: true
required:
- id
- status
title: OpenAIResponseOutputMessageWebSearchToolCall
description: Web search tool call output message for OpenAI responses.
type: object
CreateConversationRequest:
properties:
items:
Expand All @@ -2116,8 +2127,8 @@ components:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseMessage-Input'
title: OpenAIResponseMessage-Input
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
title: OpenAIResponseOutputMessageWebSearchToolCall
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall-Input'
title: OpenAIResponseOutputMessageWebSearchToolCall-Input
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
title: OpenAIResponseOutputMessageFileSearchToolCall
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
Expand Down Expand Up @@ -2149,7 +2160,7 @@ components:
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage-Input'
reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall-Input'
title: OpenAIResponseMessage-Input | ... (11 variants)
type: array
- type: 'null'
Expand Down Expand Up @@ -2242,8 +2253,8 @@ components:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseMessage-Output'
title: OpenAIResponseMessage-Output
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
title: OpenAIResponseOutputMessageWebSearchToolCall
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall-Output'
title: OpenAIResponseOutputMessageWebSearchToolCall-Output
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
title: OpenAIResponseOutputMessageFileSearchToolCall
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
Expand Down Expand Up @@ -2275,7 +2286,7 @@ components:
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage-Output'
reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall-Output'
title: OpenAIResponseMessage-Output | ... (11 variants)
type: array
title: Data
Expand Down Expand Up @@ -2309,8 +2320,8 @@ components:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseMessage-Input'
title: OpenAIResponseMessage-Input
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
title: OpenAIResponseOutputMessageWebSearchToolCall
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall-Input'
title: OpenAIResponseOutputMessageWebSearchToolCall-Input
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
title: OpenAIResponseOutputMessageFileSearchToolCall
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
Expand Down Expand Up @@ -2342,7 +2353,7 @@ components:
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage-Input'
reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall-Input'
title: OpenAIResponseMessage-Input | ... (11 variants)
type: array
maxItems: 20
Expand Down Expand Up @@ -3143,9 +3154,24 @@ components:
search_context_size:
anyOf:
- type: string
pattern: ^low|medium|high$
enum:
- low
- medium
- high
- type: 'null'
default: medium
filters:
anyOf:
- $ref: '#/components/schemas/WebSearchFilters'
title: WebSearchFilters
- type: 'null'
title: WebSearchFilters
user_location:
anyOf:
- $ref: '#/components/schemas/WebSearchUserLocation'
title: WebSearchUserLocation
- type: 'null'
title: WebSearchUserLocation
type: object
title: OpenAIResponseInputToolWebSearch
description: Web search tool configuration for OpenAI response inputs.
Expand Down Expand Up @@ -7526,6 +7552,64 @@ components:
- text
title: OpenAIResponseOutputMessageReasoningSummary
description: A summary of reasoning output from the model.
OpenAIResponseOutputMessageWebSearchToolCall-Input:
properties:
id:
type: string
title: Id
status:
type: string
title: Status
type:
type: string
title: Type
enum:
- web_search_call
action:
anyOf:
- $ref: '#/components/schemas/WebSearchActionSearch'
title: WebSearchActionSearch
- $ref: '#/components/schemas/WebSearchActionOpenPage'
title: WebSearchActionOpenPage
- $ref: '#/components/schemas/WebSearchActionFind'
title: WebSearchActionFind
- type: 'null'
title: WebSearchActionSearch | WebSearchActionOpenPage | WebSearchActionFind
type: object
required:
- id
- status
title: OpenAIResponseOutputMessageWebSearchToolCall
description: Web search tool call output message for OpenAI responses.
OpenAIResponseOutputMessageWebSearchToolCall-Output:
properties:
id:
type: string
title: Id
status:
type: string
title: Status
type:
type: string
title: Type
enum:
- web_search_call
action:
anyOf:
- $ref: '#/components/schemas/WebSearchActionSearch'
title: WebSearchActionSearch
- $ref: '#/components/schemas/WebSearchActionOpenPage'
title: WebSearchActionOpenPage
- $ref: '#/components/schemas/WebSearchActionFind'
title: WebSearchActionFind
- type: 'null'
title: WebSearchActionSearch | WebSearchActionOpenPage | WebSearchActionFind
type: object
required:
- id
- status
title: OpenAIResponseOutputMessageWebSearchToolCall
description: Web search tool call output message for OpenAI responses.
OpenAIResponseReasoning:
properties:
effort:
Expand Down Expand Up @@ -8030,6 +8114,118 @@ components:
- file_id
title: VectorStoreFileBatchFileEntry
description: A file entry for creating a vector store file batch with per-file options.
WebSearchActionFind:
properties:
type:
type: string
title: Type
enum:
- find_in_page
url:
type: string
title: Url
pattern:
type: string
title: Pattern
type: object
required:
- url
- pattern
title: WebSearchActionFind
description: 'Web search action: searches for a pattern within a loaded page.'
WebSearchActionOpenPage:
properties:
type:
type: string
title: Type
enum:
- open_page
url:
anyOf:
- type: string
- type: 'null'
type: object
title: WebSearchActionOpenPage
description: 'Web search action: opens a specific URL from search results.'
WebSearchActionSearch:
properties:
type:
type: string
title: Type
enum:
- search
query:
type: string
title: Query
queries:
anyOf:
- items:
type: string
type: array
- type: 'null'
sources:
anyOf:
- items:
$ref: '#/components/schemas/WebSearchSource'
type: array
- type: 'null'
type: object
required:
- query
title: WebSearchActionSearch
description: 'Web search action: performs a search query.'
WebSearchFilters:
properties:
allowed_domains:
anyOf:
- items:
type: string
type: array
- type: 'null'
type: object
title: WebSearchFilters
description: Domain filters for web search results.
WebSearchSource:
properties:
type:
type: string
title: Type
enum:
- url
url:
type: string
title: Url
type: object
required:
- url
title: WebSearchSource
description: A source URL returned by a web search action.
WebSearchUserLocation:
properties:
type:
type: string
title: Type
enum:
- approximate
city:
anyOf:
- type: string
- type: 'null'
country:
anyOf:
- type: string
- type: 'null'
region:
anyOf:
- type: string
- type: 'null'
timezone:
anyOf:
- type: string
- type: 'null'
type: object
title: WebSearchUserLocation
description: Approximate user location to refine web search results.
_URLOrData:
properties:
url:
Expand Down Expand Up @@ -10068,8 +10264,8 @@ components:
- oneOf:
- $ref: '#/components/schemas/OpenAIResponseMessage-Output'
title: OpenAIResponseMessage-Output
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
title: OpenAIResponseOutputMessageWebSearchToolCall
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall-Output'
title: OpenAIResponseOutputMessageWebSearchToolCall-Output
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
title: OpenAIResponseOutputMessageFileSearchToolCall
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
Expand All @@ -10092,7 +10288,7 @@ components:
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage-Output'
reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall-Output'
x-stainless-naming: OpenAIResponseMessageOutputOneOf
title: OpenAIResponseMessage-Output | ... (8 variants)
- $ref: '#/components/schemas/OpenAIResponseInputFunctionToolCallOutput'
Expand All @@ -10107,8 +10303,8 @@ components:
oneOf:
- $ref: '#/components/schemas/OpenAIResponseMessage-Output'
title: OpenAIResponseMessage-Output
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
title: OpenAIResponseOutputMessageWebSearchToolCall
- $ref: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall-Output'
title: OpenAIResponseOutputMessageWebSearchToolCall-Output
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFileSearchToolCall'
title: OpenAIResponseOutputMessageFileSearchToolCall
- $ref: '#/components/schemas/OpenAIResponseOutputMessageFunctionToolCall'
Expand All @@ -10131,7 +10327,7 @@ components:
mcp_list_tools: '#/components/schemas/OpenAIResponseOutputMessageMCPListTools'
message: '#/components/schemas/OpenAIResponseMessage-Output'
reasoning: '#/components/schemas/OpenAIResponseOutputMessageReasoningItem'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall'
web_search_call: '#/components/schemas/OpenAIResponseOutputMessageWebSearchToolCall-Output'
x-stainless-naming: OpenAIResponseOutputItem
title: OpenAIResponseMessage-Output | ... (8 variants)
ChatCompletionMessageToolCall:
Expand Down
Loading
Loading