diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 772cb738..4c5b76c9 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -21,10 +21,10 @@ jobs: runs-on: ${{ github.repository == 'stainless-sdks/llama-stack-client-node' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} if: (github.event_name == 'push' || github.event.pull_request.head.repo.fork) && (github.event_name != 'push' || github.event.head_commit.message != 'codegen metadata') steps: - - uses: actions/checkout@v6 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Set up Node - uses: actions/setup-node@v4 + uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 with: node-version: '18' @@ -43,10 +43,10 @@ jobs: contents: read id-token: write steps: - - uses: actions/checkout@v6 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Set up Node - uses: actions/setup-node@v4 + uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 with: node-version: '18' @@ -61,7 +61,7 @@ jobs: github.repository == 'stainless-sdks/llama-stack-client-node' && !startsWith(github.ref, 'refs/heads/stl/') id: github-oidc - uses: actions/github-script@v8 + uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0 with: script: core.setOutput('github_token', await core.getIDToken()); @@ -80,10 +80,10 @@ jobs: runs-on: ${{ github.repository == 'stainless-sdks/llama-stack-client-node' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} if: github.event_name == 'push' || github.event.pull_request.head.repo.fork steps: - - uses: actions/checkout@v6 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Set up Node - uses: actions/setup-node@v4 + uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 with: node-version: '20' diff --git a/.github/workflows/release-doctor.yml b/.github/workflows/release-doctor.yml index 6608df33..92dd23ad 100644 --- a/.github/workflows/release-doctor.yml +++ b/.github/workflows/release-doctor.yml @@ -12,7 +12,7 @@ jobs: if: github.repository == 'ogx-ai/ogx-client-typescript' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next') steps: - - uses: actions/checkout@v6 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Check release environment run: | diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 5fcdf117..92efb56c 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.5.0-alpha.5" + ".": "0.5.0-alpha.6" } diff --git a/.stats.yml b/.stats.yml index 3b60db3f..262002ae 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 67 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/llamastack/llama-stack-client-0a1c852eda740c79412d2aa642e24f7ed057e69e472885e8fb9463e3d5515b55.yml -openapi_spec_hash: 36c10a2fd3d75032e220697bd5b30b7f +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/llamastack/llama-stack-client-9efa42764597a51fe41e4de7533252cd7a62b5d34cf74021dd818d5344b90de7.yml +openapi_spec_hash: e964910532c33975390739a9d635fd2b config_hash: 3d294831d7b8066ba59a8934b980a943 diff --git a/CHANGELOG.md b/CHANGELOG.md index e3fb40c4..90b9305a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,19 @@ # Changelog +## 0.5.0-alpha.6 (2026-06-01) + +Full Changelog: [v0.5.0-alpha.5...v0.5.0-alpha.6](https://github.com/ogx-ai/ogx-client-typescript/compare/v0.5.0-alpha.5...v0.5.0-alpha.6) + +### ⚠ BREAKING CHANGES + +* **api:** add post-generation schema transforms for Responses API conformance + +### Bug Fixes + +* **api:** add post-generation schema transforms for Responses API conformance ([59d5f80](https://github.com/ogx-ai/ogx-client-typescript/commit/59d5f806e394ca40034b70c3277895d4b786e6cf)) +* **api:** fix field-level schema mismatches in Responses models ([a4364a3](https://github.com/ogx-ai/ogx-client-typescript/commit/a4364a3ab2f046d3b29267d5db75c147e564ecad)) +* **brave-search:** align result slicing with search_context_size count ([0b0984e](https://github.com/ogx-ai/ogx-client-typescript/commit/0b0984ead8282130b2f6f5380736753e957a4d8b)) + ## 0.5.0-alpha.5 (2026-05-12) Full Changelog: [v0.5.0-alpha.4...v0.5.0-alpha.5](https://github.com/ogx-ai/ogx-client-typescript/compare/v0.5.0-alpha.4...v0.5.0-alpha.5) diff --git a/package.json b/package.json index 160be2fd..c3a9c384 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "ogx-client", - "version": "0.5.0-alpha.5", + "version": "0.5.0-alpha.6", "description": "The official TypeScript library for the Ogx Client API", "author": "Ogx Client ", "types": "dist/index.d.ts", diff --git a/src/resources/conversations/conversations.ts b/src/resources/conversations/conversations.ts index 2e8b2514..743d1e08 100644 --- a/src/resources/conversations/conversations.ts +++ b/src/resources/conversations/conversations.ts @@ -113,7 +113,7 @@ export interface ConversationCreateParams { */ items?: Array< | ConversationCreateParams.OpenAIResponseMessageInput - | ConversationCreateParams.OpenAIResponseOutputMessageWebSearchToolCall + | ConversationCreateParams.OpenAIResponseOutputMessageWebSearchToolCallInput | ConversationCreateParams.OpenAIResponseOutputMessageFileSearchToolCall | ConversationCreateParams.OpenAIResponseOutputMessageFunctionToolCall | ConversationCreateParams.OpenAIResponseInputFunctionToolCallOutput @@ -335,14 +335,69 @@ export namespace ConversationCreateParams { /** * Web search tool call output message for OpenAI responses. */ - export interface OpenAIResponseOutputMessageWebSearchToolCall { + export interface OpenAIResponseOutputMessageWebSearchToolCallInput { id: string; status: string; + /** + * Web search action: performs a search query. + */ + action?: + | OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionSearch + | OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionOpenPage + | OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionFind + | null; + type?: 'web_search_call'; } + export namespace OpenAIResponseOutputMessageWebSearchToolCallInput { + /** + * Web search action: performs a search query. + */ + export interface WebSearchActionSearch { + query: string; + + queries?: Array | null; + + sources?: Array | null; + + type?: 'search'; + } + + export namespace WebSearchActionSearch { + /** + * A source URL returned by a web search action. + */ + export interface Source { + url: string; + + type?: 'url'; + } + } + + /** + * Web search action: opens a specific URL from search results. + */ + export interface WebSearchActionOpenPage { + type?: 'open_page'; + + url?: string | null; + } + + /** + * Web search action: searches for a pattern within a loaded page. + */ + export interface WebSearchActionFind { + pattern: string; + + url: string; + + type?: 'find_in_page'; + } + } + /** * File search tool call output message for OpenAI responses. */ diff --git a/src/resources/conversations/items.ts b/src/resources/conversations/items.ts index abe6aedd..307e0da9 100644 --- a/src/resources/conversations/items.ts +++ b/src/resources/conversations/items.ts @@ -103,7 +103,7 @@ export interface ItemCreateResponse { */ data: Array< | ItemCreateResponse.OpenAIResponseMessageOutput - | ItemCreateResponse.OpenAIResponseOutputMessageWebSearchToolCall + | ItemCreateResponse.OpenAIResponseOutputMessageWebSearchToolCallOutput | ItemCreateResponse.OpenAIResponseOutputMessageFileSearchToolCall | ItemCreateResponse.OpenAIResponseOutputMessageFunctionToolCall | ItemCreateResponse.OpenAIResponseInputFunctionToolCallOutput @@ -340,14 +340,69 @@ export namespace ItemCreateResponse { /** * Web search tool call output message for OpenAI responses. */ - export interface OpenAIResponseOutputMessageWebSearchToolCall { + export interface OpenAIResponseOutputMessageWebSearchToolCallOutput { id: string; status: string; + /** + * Web search action: performs a search query. + */ + action?: + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionSearch + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionOpenPage + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionFind + | null; + type?: 'web_search_call'; } + export namespace OpenAIResponseOutputMessageWebSearchToolCallOutput { + /** + * Web search action: performs a search query. + */ + export interface WebSearchActionSearch { + query: string; + + queries?: Array | null; + + sources?: Array | null; + + type?: 'search'; + } + + export namespace WebSearchActionSearch { + /** + * A source URL returned by a web search action. + */ + export interface Source { + url: string; + + type?: 'url'; + } + } + + /** + * Web search action: opens a specific URL from search results. + */ + export interface WebSearchActionOpenPage { + type?: 'open_page'; + + url?: string | null; + } + + /** + * Web search action: searches for a pattern within a loaded page. + */ + export interface WebSearchActionFind { + pattern: string; + + url: string; + + type?: 'find_in_page'; + } + } + /** * File search tool call output message for OpenAI responses. */ @@ -614,7 +669,7 @@ export namespace ItemCreateResponse { */ export type ItemListResponse = | ItemListResponse.OpenAIResponseMessageOutput - | ItemListResponse.OpenAIResponseOutputMessageWebSearchToolCall + | ItemListResponse.OpenAIResponseOutputMessageWebSearchToolCallOutput | ItemListResponse.OpenAIResponseOutputMessageFileSearchToolCall | ItemListResponse.OpenAIResponseOutputMessageFunctionToolCall | ItemListResponse.OpenAIResponseInputFunctionToolCallOutput @@ -829,14 +884,69 @@ export namespace ItemListResponse { /** * Web search tool call output message for OpenAI responses. */ - export interface OpenAIResponseOutputMessageWebSearchToolCall { + export interface OpenAIResponseOutputMessageWebSearchToolCallOutput { id: string; status: string; + /** + * Web search action: performs a search query. + */ + action?: + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionSearch + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionOpenPage + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionFind + | null; + type?: 'web_search_call'; } + export namespace OpenAIResponseOutputMessageWebSearchToolCallOutput { + /** + * Web search action: performs a search query. + */ + export interface WebSearchActionSearch { + query: string; + + queries?: Array | null; + + sources?: Array | null; + + type?: 'search'; + } + + export namespace WebSearchActionSearch { + /** + * A source URL returned by a web search action. + */ + export interface Source { + url: string; + + type?: 'url'; + } + } + + /** + * Web search action: opens a specific URL from search results. + */ + export interface WebSearchActionOpenPage { + type?: 'open_page'; + + url?: string | null; + } + + /** + * Web search action: searches for a pattern within a loaded page. + */ + export interface WebSearchActionFind { + pattern: string; + + url: string; + + type?: 'find_in_page'; + } + } + /** * File search tool call output message for OpenAI responses. */ @@ -1103,7 +1213,7 @@ export namespace ItemListResponse { */ export type ItemGetResponse = | ItemGetResponse.OpenAIResponseMessageOutput - | ItemGetResponse.OpenAIResponseOutputMessageWebSearchToolCall + | ItemGetResponse.OpenAIResponseOutputMessageWebSearchToolCallOutput | ItemGetResponse.OpenAIResponseOutputMessageFileSearchToolCall | ItemGetResponse.OpenAIResponseOutputMessageFunctionToolCall | ItemGetResponse.OpenAIResponseInputFunctionToolCallOutput @@ -1318,14 +1428,69 @@ export namespace ItemGetResponse { /** * Web search tool call output message for OpenAI responses. */ - export interface OpenAIResponseOutputMessageWebSearchToolCall { + export interface OpenAIResponseOutputMessageWebSearchToolCallOutput { id: string; status: string; + /** + * Web search action: performs a search query. + */ + action?: + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionSearch + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionOpenPage + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionFind + | null; + type?: 'web_search_call'; } + export namespace OpenAIResponseOutputMessageWebSearchToolCallOutput { + /** + * Web search action: performs a search query. + */ + export interface WebSearchActionSearch { + query: string; + + queries?: Array | null; + + sources?: Array | null; + + type?: 'search'; + } + + export namespace WebSearchActionSearch { + /** + * A source URL returned by a web search action. + */ + export interface Source { + url: string; + + type?: 'url'; + } + } + + /** + * Web search action: opens a specific URL from search results. + */ + export interface WebSearchActionOpenPage { + type?: 'open_page'; + + url?: string | null; + } + + /** + * Web search action: searches for a pattern within a loaded page. + */ + export interface WebSearchActionFind { + pattern: string; + + url: string; + + type?: 'find_in_page'; + } + } + /** * File search tool call output message for OpenAI responses. */ @@ -1592,7 +1757,7 @@ export interface ItemCreateParams { */ items: Array< | ItemCreateParams.OpenAIResponseMessageInput - | ItemCreateParams.OpenAIResponseOutputMessageWebSearchToolCall + | ItemCreateParams.OpenAIResponseOutputMessageWebSearchToolCallInput | ItemCreateParams.OpenAIResponseOutputMessageFileSearchToolCall | ItemCreateParams.OpenAIResponseOutputMessageFunctionToolCall | ItemCreateParams.OpenAIResponseInputFunctionToolCallOutput @@ -1809,14 +1974,69 @@ export namespace ItemCreateParams { /** * Web search tool call output message for OpenAI responses. */ - export interface OpenAIResponseOutputMessageWebSearchToolCall { + export interface OpenAIResponseOutputMessageWebSearchToolCallInput { id: string; status: string; + /** + * Web search action: performs a search query. + */ + action?: + | OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionSearch + | OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionOpenPage + | OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionFind + | null; + type?: 'web_search_call'; } + export namespace OpenAIResponseOutputMessageWebSearchToolCallInput { + /** + * Web search action: performs a search query. + */ + export interface WebSearchActionSearch { + query: string; + + queries?: Array | null; + + sources?: Array | null; + + type?: 'search'; + } + + export namespace WebSearchActionSearch { + /** + * A source URL returned by a web search action. + */ + export interface Source { + url: string; + + type?: 'url'; + } + } + + /** + * Web search action: opens a specific URL from search results. + */ + export interface WebSearchActionOpenPage { + type?: 'open_page'; + + url?: string | null; + } + + /** + * Web search action: searches for a pattern within a loaded page. + */ + export interface WebSearchActionFind { + pattern: string; + + url: string; + + type?: 'find_in_page'; + } + } + /** * File search tool call output message for OpenAI responses. */ diff --git a/src/resources/responses/input-items.ts b/src/resources/responses/input-items.ts index b90bcc40..bb427c3a 100644 --- a/src/resources/responses/input-items.ts +++ b/src/resources/responses/input-items.ts @@ -41,7 +41,7 @@ export class InputItems extends APIResource { export interface InputItemListResponse { data: Array< | InputItemListResponse.OpenAIResponseMessageOutput - | InputItemListResponse.OpenAIResponseOutputMessageWebSearchToolCall + | InputItemListResponse.OpenAIResponseOutputMessageWebSearchToolCallOutput | InputItemListResponse.OpenAIResponseOutputMessageFileSearchToolCall | InputItemListResponse.OpenAIResponseOutputMessageFunctionToolCall | InputItemListResponse.OpenAIResponseOutputMessageMcpCall @@ -260,14 +260,69 @@ export namespace InputItemListResponse { /** * Web search tool call output message for OpenAI responses. */ - export interface OpenAIResponseOutputMessageWebSearchToolCall { + export interface OpenAIResponseOutputMessageWebSearchToolCallOutput { id: string; status: string; + /** + * Web search action: performs a search query. + */ + action?: + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionSearch + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionOpenPage + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionFind + | null; + type?: 'web_search_call'; } + export namespace OpenAIResponseOutputMessageWebSearchToolCallOutput { + /** + * Web search action: performs a search query. + */ + export interface WebSearchActionSearch { + query: string; + + queries?: Array | null; + + sources?: Array | null; + + type?: 'search'; + } + + export namespace WebSearchActionSearch { + /** + * A source URL returned by a web search action. + */ + export interface Source { + url: string; + + type?: 'url'; + } + } + + /** + * Web search action: opens a specific URL from search results. + */ + export interface WebSearchActionOpenPage { + type?: 'open_page'; + + url?: string | null; + } + + /** + * Web search action: searches for a pattern within a loaded page. + */ + export interface WebSearchActionFind { + pattern: string; + + url: string; + + type?: 'find_in_page'; + } + } + /** * File search tool call output message for OpenAI responses. */ diff --git a/src/resources/responses/responses.ts b/src/resources/responses/responses.ts index 3ec8e9ea..25a93d43 100644 --- a/src/resources/responses/responses.ts +++ b/src/resources/responses/responses.ts @@ -101,7 +101,7 @@ export interface CompactedResponse { output: Array< | CompactedResponse.OpenAIResponseMessageOutput - | CompactedResponse.OpenAIResponseOutputMessageWebSearchToolCall + | CompactedResponse.OpenAIResponseOutputMessageWebSearchToolCallOutput | CompactedResponse.OpenAIResponseOutputMessageFileSearchToolCall | CompactedResponse.OpenAIResponseOutputMessageFunctionToolCall | CompactedResponse.OpenAIResponseOutputMessageMcpCall @@ -325,14 +325,69 @@ export namespace CompactedResponse { /** * Web search tool call output message for OpenAI responses. */ - export interface OpenAIResponseOutputMessageWebSearchToolCall { + export interface OpenAIResponseOutputMessageWebSearchToolCallOutput { id: string; status: string; + /** + * Web search action: performs a search query. + */ + action?: + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionSearch + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionOpenPage + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionFind + | null; + type?: 'web_search_call'; } + export namespace OpenAIResponseOutputMessageWebSearchToolCallOutput { + /** + * Web search action: performs a search query. + */ + export interface WebSearchActionSearch { + query: string; + + queries?: Array | null; + + sources?: Array | null; + + type?: 'search'; + } + + export namespace WebSearchActionSearch { + /** + * A source URL returned by a web search action. + */ + export interface Source { + url: string; + + type?: 'url'; + } + } + + /** + * Web search action: opens a specific URL from search results. + */ + export interface WebSearchActionOpenPage { + type?: 'open_page'; + + url?: string | null; + } + + /** + * Web search action: searches for a pattern within a loaded page. + */ + export interface WebSearchActionFind { + pattern: string; + + url: string; + + type?: 'find_in_page'; + } + } + /** * File search tool call output message for OpenAI responses. */ @@ -657,9 +712,64 @@ export namespace ResponseInput { status: string; + /** + * Web search action: performs a search query. + */ + action?: + | OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionSearch + | OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionOpenPage + | OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionFind + | null; + type?: 'web_search_call'; } + export namespace OpenAIResponseOutputMessageWebSearchToolCall { + /** + * Web search action: performs a search query. + */ + export interface WebSearchActionSearch { + query: string; + + queries?: Array | null; + + sources?: Array | null; + + type?: 'search'; + } + + export namespace WebSearchActionSearch { + /** + * A source URL returned by a web search action. + */ + export interface Source { + url: string; + + type?: 'url'; + } + } + + /** + * Web search action: opens a specific URL from search results. + */ + export interface WebSearchActionOpenPage { + type?: 'open_page'; + + url?: string | null; + } + + /** + * Web search action: searches for a pattern within a loaded page. + */ + export interface WebSearchActionFind { + pattern: string; + + url: string; + + type?: 'find_in_page'; + } + } + /** * File search tool call output message for OpenAI responses. */ @@ -1131,7 +1241,7 @@ export interface ResponseObject { output: Array< | ResponseObject.OpenAIResponseMessageOutput - | ResponseObject.OpenAIResponseOutputMessageWebSearchToolCall + | ResponseObject.OpenAIResponseOutputMessageWebSearchToolCallOutput | ResponseObject.OpenAIResponseOutputMessageFileSearchToolCall | ResponseObject.OpenAIResponseOutputMessageFunctionToolCall | ResponseObject.OpenAIResponseOutputMessageMcpCall @@ -1166,7 +1276,7 @@ export interface ResponseObject { max_tool_calls?: number | null; - metadata?: { [key: string]: string } | null; + metadata?: unknown; object?: 'response'; @@ -1225,7 +1335,11 @@ export interface ResponseObject { top_p?: number; - truncation?: string | null; + /** + * Controls how the service truncates input when it exceeds the model context + * window. + */ + truncation?: 'auto' | 'disabled'; /** * Usage information for OpenAI response. @@ -1437,14 +1551,69 @@ export namespace ResponseObject { /** * Web search tool call output message for OpenAI responses. */ - export interface OpenAIResponseOutputMessageWebSearchToolCall { + export interface OpenAIResponseOutputMessageWebSearchToolCallOutput { id: string; status: string; + /** + * Web search action: performs a search query. + */ + action?: + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionSearch + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionOpenPage + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionFind + | null; + type?: 'web_search_call'; } + export namespace OpenAIResponseOutputMessageWebSearchToolCallOutput { + /** + * Web search action: performs a search query. + */ + export interface WebSearchActionSearch { + query: string; + + queries?: Array | null; + + sources?: Array | null; + + type?: 'search'; + } + + export namespace WebSearchActionSearch { + /** + * A source URL returned by a web search action. + */ + export interface Source { + url: string; + + type?: 'url'; + } + } + + /** + * Web search action: opens a specific URL from search results. + */ + export interface WebSearchActionOpenPage { + type?: 'open_page'; + + url?: string | null; + } + + /** + * Web search action: searches for a pattern within a loaded page. + */ + export interface WebSearchActionFind { + pattern: string; + + url: string; + + type?: 'find_in_page'; + } + } + /** * File search tool call output message for OpenAI responses. */ @@ -1695,6 +1864,11 @@ export namespace ResponseObject { export interface Reasoning { effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | null; + /** + * @deprecated Deprecated: use 'summary' instead. + */ + generate_summary?: 'auto' | 'concise' | 'detailed' | null; + /** * Summary mode for reasoning output. One of 'auto', 'concise', or 'detailed'. */ @@ -1788,9 +1962,43 @@ export namespace ResponseObject { * Web search tool configuration for OpenAI response inputs. */ export interface OpenAIResponseInputToolWebSearch { - search_context_size?: string | null; + /** + * Domain filters for web search results. + */ + filters?: OpenAIResponseInputToolWebSearch.Filters | null; + + search_context_size?: 'low' | 'medium' | 'high' | null; type?: 'web_search' | 'web_search_preview' | 'web_search_preview_2025_03_11' | 'web_search_2025_08_26'; + + /** + * Approximate user location to refine web search results. + */ + user_location?: OpenAIResponseInputToolWebSearch.UserLocation | null; + } + + export namespace OpenAIResponseInputToolWebSearch { + /** + * Domain filters for web search results. + */ + export interface Filters { + allowed_domains?: Array | null; + } + + /** + * Approximate user location to refine web search results. + */ + export interface UserLocation { + city?: string | null; + + country?: string | null; + + region?: string | null; + + timezone?: string | null; + + type?: 'approximate'; + } } /** @@ -2059,9 +2267,64 @@ export namespace ResponseObjectStream { status: string; + /** + * Web search action: performs a search query. + */ + action?: + | OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionSearch + | OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionOpenPage + | OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionFind + | null; + type?: 'web_search_call'; } + export namespace OpenAIResponseOutputMessageWebSearchToolCall { + /** + * Web search action: performs a search query. + */ + export interface WebSearchActionSearch { + query: string; + + queries?: Array | null; + + sources?: Array | null; + + type?: 'search'; + } + + export namespace WebSearchActionSearch { + /** + * A source URL returned by a web search action. + */ + export interface Source { + url: string; + + type?: 'url'; + } + } + + /** + * Web search action: opens a specific URL from search results. + */ + export interface WebSearchActionOpenPage { + type?: 'open_page'; + + url?: string | null; + } + + /** + * Web search action: searches for a pattern within a loaded page. + */ + export interface WebSearchActionFind { + pattern: string; + + url: string; + + type?: 'find_in_page'; + } + } + /** * File search tool call output message for OpenAI responses. */ @@ -2271,9 +2534,64 @@ export namespace ResponseObjectStream { status: string; + /** + * Web search action: performs a search query. + */ + action?: + | OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionSearch + | OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionOpenPage + | OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionFind + | null; + type?: 'web_search_call'; } + export namespace OpenAIResponseOutputMessageWebSearchToolCall { + /** + * Web search action: performs a search query. + */ + export interface WebSearchActionSearch { + query: string; + + queries?: Array | null; + + sources?: Array | null; + + type?: 'search'; + } + + export namespace WebSearchActionSearch { + /** + * A source URL returned by a web search action. + */ + export interface Source { + url: string; + + type?: 'url'; + } + } + + /** + * Web search action: opens a specific URL from search results. + */ + export interface WebSearchActionOpenPage { + type?: 'open_page'; + + url?: string | null; + } + + /** + * Web search action: searches for a pattern within a loaded page. + */ + export interface WebSearchActionFind { + pattern: string; + + url: string; + + type?: 'find_in_page'; + } + } + /** * File search tool call output message for OpenAI responses. */ @@ -3402,9 +3720,64 @@ export namespace ResponseOutput { status: string; + /** + * Web search action: performs a search query. + */ + action?: + | OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionSearch + | OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionOpenPage + | OpenAIResponseOutputMessageWebSearchToolCall.WebSearchActionFind + | null; + type?: 'web_search_call'; } + export namespace OpenAIResponseOutputMessageWebSearchToolCall { + /** + * Web search action: performs a search query. + */ + export interface WebSearchActionSearch { + query: string; + + queries?: Array | null; + + sources?: Array | null; + + type?: 'search'; + } + + export namespace WebSearchActionSearch { + /** + * A source URL returned by a web search action. + */ + export interface Source { + url: string; + + type?: 'url'; + } + } + + /** + * Web search action: opens a specific URL from search results. + */ + export interface WebSearchActionOpenPage { + type?: 'open_page'; + + url?: string | null; + } + + /** + * Web search action: searches for a pattern within a loaded page. + */ + export interface WebSearchActionFind { + pattern: string; + + url: string; + + type?: 'find_in_page'; + } + } + /** * File search tool call output message for OpenAI responses. */ @@ -3587,7 +3960,7 @@ export interface ResponseListResponse { input: Array< | ResponseListResponse.OpenAIResponseMessageOutput - | ResponseListResponse.OpenAIResponseOutputMessageWebSearchToolCall + | ResponseListResponse.OpenAIResponseOutputMessageWebSearchToolCallOutput | ResponseListResponse.OpenAIResponseOutputMessageFileSearchToolCall | ResponseListResponse.OpenAIResponseOutputMessageFunctionToolCall | ResponseListResponse.OpenAIResponseOutputMessageMcpCall @@ -3603,7 +3976,7 @@ export interface ResponseListResponse { output: Array< | ResponseListResponse.OpenAIResponseMessageOutput - | ResponseListResponse.OpenAIResponseOutputMessageWebSearchToolCall + | ResponseListResponse.OpenAIResponseOutputMessageWebSearchToolCallOutput | ResponseListResponse.OpenAIResponseOutputMessageFileSearchToolCall | ResponseListResponse.OpenAIResponseOutputMessageFunctionToolCall | ResponseListResponse.OpenAIResponseOutputMessageMcpCall @@ -3697,7 +4070,11 @@ export interface ResponseListResponse { top_p?: number; - truncation?: string | null; + /** + * Controls how the service truncates input when it exceeds the model context + * window. + */ + truncation?: 'auto' | 'disabled' | null; /** * Usage information for OpenAI response. @@ -3909,14 +4286,69 @@ export namespace ResponseListResponse { /** * Web search tool call output message for OpenAI responses. */ - export interface OpenAIResponseOutputMessageWebSearchToolCall { + export interface OpenAIResponseOutputMessageWebSearchToolCallOutput { id: string; status: string; + /** + * Web search action: performs a search query. + */ + action?: + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionSearch + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionOpenPage + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionFind + | null; + type?: 'web_search_call'; } + export namespace OpenAIResponseOutputMessageWebSearchToolCallOutput { + /** + * Web search action: performs a search query. + */ + export interface WebSearchActionSearch { + query: string; + + queries?: Array | null; + + sources?: Array | null; + + type?: 'search'; + } + + export namespace WebSearchActionSearch { + /** + * A source URL returned by a web search action. + */ + export interface Source { + url: string; + + type?: 'url'; + } + } + + /** + * Web search action: opens a specific URL from search results. + */ + export interface WebSearchActionOpenPage { + type?: 'open_page'; + + url?: string | null; + } + + /** + * Web search action: searches for a pattern within a loaded page. + */ + export interface WebSearchActionFind { + pattern: string; + + url: string; + + type?: 'find_in_page'; + } + } + /** * File search tool call output message for OpenAI responses. */ @@ -4378,14 +4810,69 @@ export namespace ResponseListResponse { /** * Web search tool call output message for OpenAI responses. */ - export interface OpenAIResponseOutputMessageWebSearchToolCall { + export interface OpenAIResponseOutputMessageWebSearchToolCallOutput { id: string; status: string; + /** + * Web search action: performs a search query. + */ + action?: + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionSearch + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionOpenPage + | OpenAIResponseOutputMessageWebSearchToolCallOutput.WebSearchActionFind + | null; + type?: 'web_search_call'; } + export namespace OpenAIResponseOutputMessageWebSearchToolCallOutput { + /** + * Web search action: performs a search query. + */ + export interface WebSearchActionSearch { + query: string; + + queries?: Array | null; + + sources?: Array | null; + + type?: 'search'; + } + + export namespace WebSearchActionSearch { + /** + * A source URL returned by a web search action. + */ + export interface Source { + url: string; + + type?: 'url'; + } + } + + /** + * Web search action: opens a specific URL from search results. + */ + export interface WebSearchActionOpenPage { + type?: 'open_page'; + + url?: string | null; + } + + /** + * Web search action: searches for a pattern within a loaded page. + */ + export interface WebSearchActionFind { + pattern: string; + + url: string; + + type?: 'find_in_page'; + } + } + /** * File search tool call output message for OpenAI responses. */ @@ -4636,6 +5123,11 @@ export namespace ResponseListResponse { export interface Reasoning { effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | null; + /** + * @deprecated Deprecated: use 'summary' instead. + */ + generate_summary?: 'auto' | 'concise' | 'detailed' | null; + /** * Summary mode for reasoning output. One of 'auto', 'concise', or 'detailed'. */ @@ -4729,9 +5221,43 @@ export namespace ResponseListResponse { * Web search tool configuration for OpenAI response inputs. */ export interface OpenAIResponseInputToolWebSearch { - search_context_size?: string | null; + /** + * Domain filters for web search results. + */ + filters?: OpenAIResponseInputToolWebSearch.Filters | null; + + search_context_size?: 'low' | 'medium' | 'high' | null; type?: 'web_search' | 'web_search_preview' | 'web_search_preview_2025_03_11' | 'web_search_2025_08_26'; + + /** + * Approximate user location to refine web search results. + */ + user_location?: OpenAIResponseInputToolWebSearch.UserLocation | null; + } + + export namespace OpenAIResponseInputToolWebSearch { + /** + * Domain filters for web search results. + */ + export interface Filters { + allowed_domains?: Array | null; + } + + /** + * Approximate user location to refine web search results. + */ + export interface UserLocation { + city?: string | null; + + country?: string | null; + + region?: string | null; + + timezone?: string | null; + + type?: 'approximate'; + } } /** @@ -4913,7 +5439,7 @@ export interface ResponseCreateParamsBase { | string | Array< | ResponseCreateParams.OpenAIResponseMessageInput - | ResponseCreateParams.OpenAIResponseOutputMessageWebSearchToolCall + | ResponseCreateParams.OpenAIResponseOutputMessageWebSearchToolCallInput | ResponseCreateParams.OpenAIResponseOutputMessageFileSearchToolCall | ResponseCreateParams.OpenAIResponseOutputMessageFunctionToolCall | ResponseCreateParams.OpenAIResponseOutputMessageMcpCall @@ -5093,7 +5619,7 @@ export interface ResponseCreateParamsBase { * Controls how the service truncates input when it exceeds the model context * window. */ - truncation?: 'auto' | 'disabled' | null; + truncation?: 'auto' | 'disabled'; [k: string]: unknown; } @@ -5302,14 +5828,69 @@ export namespace ResponseCreateParams { /** * Web search tool call output message for OpenAI responses. */ - export interface OpenAIResponseOutputMessageWebSearchToolCall { + export interface OpenAIResponseOutputMessageWebSearchToolCallInput { id: string; status: string; + /** + * Web search action: performs a search query. + */ + action?: + | OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionSearch + | OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionOpenPage + | OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionFind + | null; + type?: 'web_search_call'; } + export namespace OpenAIResponseOutputMessageWebSearchToolCallInput { + /** + * Web search action: performs a search query. + */ + export interface WebSearchActionSearch { + query: string; + + queries?: Array | null; + + sources?: Array | null; + + type?: 'search'; + } + + export namespace WebSearchActionSearch { + /** + * A source URL returned by a web search action. + */ + export interface Source { + url: string; + + type?: 'url'; + } + } + + /** + * Web search action: opens a specific URL from search results. + */ + export interface WebSearchActionOpenPage { + type?: 'open_page'; + + url?: string | null; + } + + /** + * Web search action: searches for a pattern within a loaded page. + */ + export interface WebSearchActionFind { + pattern: string; + + url: string; + + type?: 'find_in_page'; + } + } + /** * File search tool call output message for OpenAI responses. */ @@ -5646,6 +6227,11 @@ export namespace ResponseCreateParams { export interface Reasoning { effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | null; + /** + * @deprecated Deprecated: use 'summary' instead. + */ + generate_summary?: 'auto' | 'concise' | 'detailed' | null; + /** * Summary mode for reasoning output. One of 'auto', 'concise', or 'detailed'. */ @@ -5749,9 +6335,43 @@ export namespace ResponseCreateParams { * Web search tool configuration for OpenAI response inputs. */ export interface OpenAIResponseInputToolWebSearch { - search_context_size?: string | null; + /** + * Domain filters for web search results. + */ + filters?: OpenAIResponseInputToolWebSearch.Filters | null; + + search_context_size?: 'low' | 'medium' | 'high' | null; type?: 'web_search' | 'web_search_preview' | 'web_search_preview_2025_03_11' | 'web_search_2025_08_26'; + + /** + * Approximate user location to refine web search results. + */ + user_location?: OpenAIResponseInputToolWebSearch.UserLocation | null; + } + + export namespace OpenAIResponseInputToolWebSearch { + /** + * Domain filters for web search results. + */ + export interface Filters { + allowed_domains?: Array | null; + } + + /** + * Approximate user location to refine web search results. + */ + export interface UserLocation { + city?: string | null; + + country?: string | null; + + region?: string | null; + + timezone?: string | null; + + type?: 'approximate'; + } } /** @@ -5943,7 +6563,7 @@ export interface ResponseCompactParams { | string | Array< | ResponseCompactParams.OpenAIResponseMessageInput - | ResponseCompactParams.OpenAIResponseOutputMessageWebSearchToolCall + | ResponseCompactParams.OpenAIResponseOutputMessageWebSearchToolCallInput | ResponseCompactParams.OpenAIResponseOutputMessageFileSearchToolCall | ResponseCompactParams.OpenAIResponseOutputMessageFunctionToolCall | ResponseCompactParams.OpenAIResponseOutputMessageMcpCall @@ -6207,14 +6827,69 @@ export namespace ResponseCompactParams { /** * Web search tool call output message for OpenAI responses. */ - export interface OpenAIResponseOutputMessageWebSearchToolCall { + export interface OpenAIResponseOutputMessageWebSearchToolCallInput { id: string; status: string; + /** + * Web search action: performs a search query. + */ + action?: + | OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionSearch + | OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionOpenPage + | OpenAIResponseOutputMessageWebSearchToolCallInput.WebSearchActionFind + | null; + type?: 'web_search_call'; } + export namespace OpenAIResponseOutputMessageWebSearchToolCallInput { + /** + * Web search action: performs a search query. + */ + export interface WebSearchActionSearch { + query: string; + + queries?: Array | null; + + sources?: Array | null; + + type?: 'search'; + } + + export namespace WebSearchActionSearch { + /** + * A source URL returned by a web search action. + */ + export interface Source { + url: string; + + type?: 'url'; + } + } + + /** + * Web search action: opens a specific URL from search results. + */ + export interface WebSearchActionOpenPage { + type?: 'open_page'; + + url?: string | null; + } + + /** + * Web search action: searches for a pattern within a loaded page. + */ + export interface WebSearchActionFind { + pattern: string; + + url: string; + + type?: 'find_in_page'; + } + } + /** * File search tool call output message for OpenAI responses. */ @@ -6481,6 +7156,11 @@ export namespace ResponseCompactParams { export interface Reasoning { effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | null; + /** + * @deprecated Deprecated: use 'summary' instead. + */ + generate_summary?: 'auto' | 'concise' | 'detailed' | null; + /** * Summary mode for reasoning output. One of 'auto', 'concise', or 'detailed'. */ @@ -6520,9 +7200,43 @@ export namespace ResponseCompactParams { * Web search tool configuration for OpenAI response inputs. */ export interface OpenAIResponseInputToolWebSearch { - search_context_size?: string | null; + /** + * Domain filters for web search results. + */ + filters?: OpenAIResponseInputToolWebSearch.Filters | null; + + search_context_size?: 'low' | 'medium' | 'high' | null; type?: 'web_search' | 'web_search_preview' | 'web_search_preview_2025_03_11' | 'web_search_2025_08_26'; + + /** + * Approximate user location to refine web search results. + */ + user_location?: OpenAIResponseInputToolWebSearch.UserLocation | null; + } + + export namespace OpenAIResponseInputToolWebSearch { + /** + * Domain filters for web search results. + */ + export interface Filters { + allowed_domains?: Array | null; + } + + /** + * Approximate user location to refine web search results. + */ + export interface UserLocation { + city?: string | null; + + country?: string | null; + + region?: string | null; + + timezone?: string | null; + + type?: 'approximate'; + } } /** diff --git a/src/version.ts b/src/version.ts index de3d1536..65c82dca 100644 --- a/src/version.ts +++ b/src/version.ts @@ -4,4 +4,4 @@ // This source code is licensed under the terms described in the LICENSE file in // the root directory of this source tree. -export const VERSION = '0.5.0-alpha.5'; // x-release-please-version +export const VERSION = '0.5.0-alpha.6'; // x-release-please-version diff --git a/tests/api-resources/responses/responses.test.ts b/tests/api-resources/responses/responses.test.ts index 57a4ea14..c12c5add 100644 --- a/tests/api-resources/responses/responses.test.ts +++ b/tests/api-resources/responses/responses.test.ts @@ -46,7 +46,11 @@ describe('resource responses', () => { version: 'version', }, prompt_cache_key: 'prompt_cache_key', - reasoning: { effort: 'none', summary: 'auto' }, + reasoning: { + effort: 'none', + generate_summary: 'auto', + summary: 'auto', + }, service_tier: 'auto', store: true, stream: false, @@ -63,7 +67,20 @@ describe('resource responses', () => { verbosity: 'low', }, tool_choice: 'auto', - tools: [{ search_context_size: 'S?oC"high', type: 'web_search' }], + tools: [ + { + filters: { allowed_domains: ['string'] }, + search_context_size: 'low', + type: 'web_search', + user_location: { + city: 'city', + country: 'country', + region: 'region', + timezone: 'timezone', + type: 'approximate', + }, + }, + ], top_logprobs: 0, top_p: 0, truncation: 'auto', @@ -158,7 +175,11 @@ describe('resource responses', () => { parallel_tool_calls: true, previous_response_id: 'previous_response_id', prompt_cache_key: 'prompt_cache_key', - reasoning: { effort: 'none', summary: 'auto' }, + reasoning: { + effort: 'none', + generate_summary: 'auto', + summary: 'auto', + }, text: { format: { description: 'description', @@ -169,7 +190,20 @@ describe('resource responses', () => { }, verbosity: 'low', }, - tools: [{ search_context_size: 'S?oC"high', type: 'web_search' }], + tools: [ + { + filters: { allowed_domains: ['string'] }, + search_context_size: 'low', + type: 'web_search', + user_location: { + city: 'city', + country: 'country', + region: 'region', + timezone: 'timezone', + type: 'approximate', + }, + }, + ], }); }); });