From 05b44987c699f7683b8706c8de363165150e5f31 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 15 Sep 2025 19:52:24 +0000 Subject: [PATCH 1/2] chore(api): docs and spec refactoring --- .stats.yml | 6 ++-- src/resources/chat/completions/completions.ts | 7 ++-- src/resources/conversations/conversations.ts | 8 +++-- src/resources/evals/runs/runs.ts | 35 +++++++++++++------ 4 files changed, 39 insertions(+), 17 deletions(-) diff --git a/.stats.yml b/.stats.yml index e38971896..905a02c44 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 118 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-94b1e3cb0bdc616ff0c2f267c33dadd95f133b1f64e647aab6c64afb292b2793.yml -openapi_spec_hash: 2395319ac9befd59b6536ae7f9564a05 -config_hash: 930dac3aa861344867e4ac84f037b5df +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-d30ff992a48873c1466c49f3c01f2ec8933faebff23424748f8d056065b1bcef.yml +openapi_spec_hash: e933ec43b46f45c348adb78840e5808d +config_hash: bf45940f0a7805b4ec2017eecdd36893 diff --git a/src/resources/chat/completions/completions.ts b/src/resources/chat/completions/completions.ts index 17269f25b..4c97fb921 100644 --- a/src/resources/chat/completions/completions.ts +++ b/src/resources/chat/completions/completions.ts @@ -1946,9 +1946,12 @@ export interface ChatCompletionUpdateParams { export interface ChatCompletionListParams extends CursorPageParams { /** - * A list of metadata keys to filter the Chat Completions by. Example: + * Set of 16 key-value pairs that can be attached to an object. This can be useful + * for storing additional information about the object in a structured format, and + * querying for objects via API or the dashboard. * - * `metadata[key1]=value1&metadata[key2]=value2` + * Keys are strings with a maximum length of 64 characters. Values are strings with + * a maximum length of 512 characters. */ metadata?: Shared.Metadata | null; diff --git a/src/resources/conversations/conversations.ts b/src/resources/conversations/conversations.ts index 4854d8234..fbd3dcbd9 100644 --- a/src/resources/conversations/conversations.ts +++ b/src/resources/conversations/conversations.ts @@ -361,8 +361,12 @@ export interface ConversationCreateParams { items?: Array | null; /** - * Set of 16 key-value pairs that can be attached to an object. Useful for storing - * additional information about the object in a structured format. + * Set of 16 key-value pairs that can be attached to an object. This can be useful + * for storing additional information about the object in a structured format, and + * querying for objects via API or the dashboard. + * + * Keys are strings with a maximum length of 64 characters. Values are strings with + * a maximum length of 512 characters. */ metadata?: Shared.Metadata | null; } diff --git a/src/resources/evals/runs/runs.ts b/src/resources/evals/runs/runs.ts index f01aa0c88..502a510e9 100644 --- a/src/resources/evals/runs/runs.ts +++ b/src/resources/evals/runs/runs.ts @@ -578,8 +578,11 @@ export namespace RunCreateResponse { model?: string | null; /** - * Optional reasoning effort parameter. This is a query parameter used to select - * responses. + * Constrains effort on reasoning for + * [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently + * supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning + * effort can result in faster responses and fewer tokens used on reasoning in a + * response. */ reasoning_effort?: Shared.ReasoningEffort | null; @@ -1052,8 +1055,11 @@ export namespace RunRetrieveResponse { model?: string | null; /** - * Optional reasoning effort parameter. This is a query parameter used to select - * responses. + * Constrains effort on reasoning for + * [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently + * supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning + * effort can result in faster responses and fewer tokens used on reasoning in a + * response. */ reasoning_effort?: Shared.ReasoningEffort | null; @@ -1523,8 +1529,11 @@ export namespace RunListResponse { model?: string | null; /** - * Optional reasoning effort parameter. This is a query parameter used to select - * responses. + * Constrains effort on reasoning for + * [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently + * supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning + * effort can result in faster responses and fewer tokens used on reasoning in a + * response. */ reasoning_effort?: Shared.ReasoningEffort | null; @@ -2005,8 +2014,11 @@ export namespace RunCancelResponse { model?: string | null; /** - * Optional reasoning effort parameter. This is a query parameter used to select - * responses. + * Constrains effort on reasoning for + * [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently + * supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning + * effort can result in faster responses and fewer tokens used on reasoning in a + * response. */ reasoning_effort?: Shared.ReasoningEffort | null; @@ -2426,8 +2438,11 @@ export namespace RunCreateParams { model?: string | null; /** - * Optional reasoning effort parameter. This is a query parameter used to select - * responses. + * Constrains effort on reasoning for + * [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently + * supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning + * effort can result in faster responses and fewer tokens used on reasoning in a + * response. */ reasoning_effort?: Shared.ReasoningEffort | null; From 820ab48ab130effadc9ea254910cdaa56866f60b Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 15 Sep 2025 19:52:53 +0000 Subject: [PATCH 2/2] release: 5.20.3 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 8 ++++++++ jsr.json | 2 +- package.json | 2 +- src/version.ts | 2 +- 5 files changed, 12 insertions(+), 4 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index afa75b89f..631cf4253 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "5.20.2" + ".": "5.20.3" } diff --git a/CHANGELOG.md b/CHANGELOG.md index 80c50ea85..7a4000e0f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## 5.20.3 (2025-09-15) + +Full Changelog: [v5.20.2...v5.20.3](https://github.com/openai/openai-node/compare/v5.20.2...v5.20.3) + +### Chores + +* **api:** docs and spec refactoring ([05b4498](https://github.com/openai/openai-node/commit/05b44987c699f7683b8706c8de363165150e5f31)) + ## 5.20.2 (2025-09-12) Full Changelog: [v5.20.1...v5.20.2](https://github.com/openai/openai-node/compare/v5.20.1...v5.20.2) diff --git a/jsr.json b/jsr.json index 961bdcde2..240031a5e 100644 --- a/jsr.json +++ b/jsr.json @@ -1,6 +1,6 @@ { "name": "@openai/openai", - "version": "5.20.2", + "version": "5.20.3", "exports": { ".": "./index.ts", "./helpers/zod": "./helpers/zod.ts", diff --git a/package.json b/package.json index 11e6d6361..665166bbf 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "openai", - "version": "5.20.2", + "version": "5.20.3", "description": "The official TypeScript library for the OpenAI API", "author": "OpenAI ", "types": "dist/index.d.ts", diff --git a/src/version.ts b/src/version.ts index da9ff343d..aebe1eb29 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export const VERSION = '5.20.2'; // x-release-please-version +export const VERSION = '5.20.3'; // x-release-please-version