Merge pull request #1603 from openai/release-please--branches--master--changes--next--components--openai

release: 5.12.0

Author: kwhinnery-openai

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "5.11.0"
+  ".": "5.12.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 111
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-721e6ccaa72205ee14c71f8163129920464fb814b95d3df9567a9476bbd9b7fb.yml
-openapi_spec_hash: 2115413a21df8b5bf9e4552a74df4312
-config_hash: 9606bb315a193bfd8da0459040143242
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-d6a16b25b969c3e5382e7d413de15bf83d5f7534d5c3ecce64d3a7e847418f9e.yml
+openapi_spec_hash: 0c0bcf4aee9ca2a948dd14b890dfe728
+config_hash: aeff9289bd7f8c8482e4d738c3c2fde1

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 5.12.0 (2025-08-05)
+
+Full Changelog: [v5.11.0...v5.12.0](https://github.com/openai/openai-node/compare/v5.11.0...v5.12.0)
+
+### Features
+
+* **api:** manual updates ([f0d3056](https://github.com/openai/openai-node/commit/f0d3056932adb8e448fd1141eae4b07ad0c66ddb))
+
 ## 5.11.0 (2025-07-30)
 
 Full Changelog: [v5.10.3...v5.11.0](https://github.com/openai/openai-node/compare/v5.10.3...v5.11.0)

api.md

@@ -711,12 +711,12 @@ Types:
 - <code><a href="./src/resources/responses/responses.ts">ResponsePrompt</a></code>
 - <code><a href="./src/resources/responses/responses.ts">ResponseQueuedEvent</a></code>
 - <code><a href="./src/resources/responses/responses.ts">ResponseReasoningItem</a></code>
-- <code><a href="./src/resources/responses/responses.ts">ResponseReasoningSummaryDeltaEvent</a></code>
-- <code><a href="./src/resources/responses/responses.ts">ResponseReasoningSummaryDoneEvent</a></code>
 - <code><a href="./src/resources/responses/responses.ts">ResponseReasoningSummaryPartAddedEvent</a></code>
 - <code><a href="./src/resources/responses/responses.ts">ResponseReasoningSummaryPartDoneEvent</a></code>
 - <code><a href="./src/resources/responses/responses.ts">ResponseReasoningSummaryTextDeltaEvent</a></code>
 - <code><a href="./src/resources/responses/responses.ts">ResponseReasoningSummaryTextDoneEvent</a></code>
+- <code><a href="./src/resources/responses/responses.ts">ResponseReasoningTextDeltaEvent</a></code>
+- <code><a href="./src/resources/responses/responses.ts">ResponseReasoningTextDoneEvent</a></code>
 - <code><a href="./src/resources/responses/responses.ts">ResponseRefusalDeltaEvent</a></code>
 - <code><a href="./src/resources/responses/responses.ts">ResponseRefusalDoneEvent</a></code>
 - <code><a href="./src/resources/responses/responses.ts">ResponseStatus</a></code>

jsr.json

@@ -1,6 +1,6 @@
 {
   "name": "@openai/openai",
-  "version": "5.11.0",
+  "version": "5.12.0",
   "exports": {
     ".": "./index.ts",
     "./helpers/zod": "./helpers/zod.ts",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai",
-  "version": "5.11.0",
+  "version": "5.12.0",
   "description": "The official TypeScript library for the OpenAI API",
   "author": "OpenAI <[email protected]>",
   "types": "dist/index.d.ts",

src/resources/responses/responses.ts

@@ -3690,7 +3690,7 @@ export interface ResponseReasoningItem {
   id: string;
 
   /**
-   * Reasoning text contents.
+   * Reasoning summary content.
    */
   summary: Array<ResponseReasoningItem.Summary>;
 
@@ -3699,6 +3699,11 @@ export interface ResponseReasoningItem {
    */
   type: 'reasoning';
 
+  /**
+   * Reasoning text content.
+   */
+  content?: Array<ResponseReasoningItem.Content>;
+
   /**
    * The encrypted content of the reasoning item - populated when a response is
    * generated with `reasoning.encrypted_content` in the `include` parameter.
@@ -3715,7 +3720,7 @@ export interface ResponseReasoningItem {
 export namespace ResponseReasoningItem {
   export interface Summary {
     /**
-     * A short summary of the reasoning used by the model when generating the response.
+     * A summary of the reasoning output from the model so far.
      */
     text: string;
 
@@ -3724,77 +3729,18 @@ export namespace ResponseReasoningItem {
      */
     type: 'summary_text';
   }
-}
-
-/**
- * Emitted when there is a delta (partial update) to the reasoning summary content.
- */
-export interface ResponseReasoningSummaryDeltaEvent {
-  /**
-   * The partial update to the reasoning summary content.
-   */
-  delta: unknown;
-
-  /**
-   * The unique identifier of the item for which the reasoning summary is being
-   * updated.
-   */
-  item_id: string;
-
-  /**
-   * The index of the output item in the response's output array.
-   */
-  output_index: number;
-
-  /**
-   * The sequence number of this event.
-   */
-  sequence_number: number;
-
-  /**
-   * The index of the summary part within the output item.
-   */
-  summary_index: number;
-
-  /**
-   * The type of the event. Always 'response.reasoning_summary.delta'.
-   */
-  type: 'response.reasoning_summary.delta';
-}
-
-/**
- * Emitted when the reasoning summary content is finalized for an item.
- */
-export interface ResponseReasoningSummaryDoneEvent {
-  /**
-   * The unique identifier of the item for which the reasoning summary is finalized.
-   */
-  item_id: string;
 
-  /**
-   * The index of the output item in the response's output array.
-   */
-  output_index: number;
-
-  /**
-   * The sequence number of this event.
-   */
-  sequence_number: number;
-
-  /**
-   * The index of the summary part within the output item.
-   */
-  summary_index: number;
-
-  /**
-   * The finalized reasoning summary text.
-   */
-  text: string;
+  export interface Content {
+    /**
+     * Reasoning text output from the model.
+     */
+    text: string;
 
-  /**
-   * The type of the event. Always 'response.reasoning_summary.done'.
-   */
-  type: 'response.reasoning_summary.done';
+    /**
+     * The type of the object. Always `reasoning_text`.
+     */
+    type: 'reasoning_text';
+  }
 }
 
 /**
@@ -3971,6 +3917,76 @@ export interface ResponseReasoningSummaryTextDoneEvent {
   type: 'response.reasoning_summary_text.done';
 }
 
+/**
+ * Emitted when a delta is added to a reasoning text.
+ */
+export interface ResponseReasoningTextDeltaEvent {
+  /**
+   * The index of the reasoning content part this delta is associated with.
+   */
+  content_index: number;
+
+  /**
+   * The text delta that was added to the reasoning content.
+   */
+  delta: string;
+
+  /**
+   * The ID of the item this reasoning text delta is associated with.
+   */
+  item_id: string;
+
+  /**
+   * The index of the output item this reasoning text delta is associated with.
+   */
+  output_index: number;
+
+  /**
+   * The sequence number of this event.
+   */
+  sequence_number: number;
+
+  /**
+   * The type of the event. Always `response.reasoning_text.delta`.
+   */
+  type: 'response.reasoning_text.delta';
+}
+
+/**
+ * Emitted when a reasoning text is completed.
+ */
+export interface ResponseReasoningTextDoneEvent {
+  /**
+   * The index of the reasoning content part.
+   */
+  content_index: number;
+
+  /**
+   * The ID of the item this reasoning text is associated with.
+   */
+  item_id: string;
+
+  /**
+   * The index of the output item this reasoning text is associated with.
+   */
+  output_index: number;
+
+  /**
+   * The sequence number of this event.
+   */
+  sequence_number: number;
+
+  /**
+   * The full text of the completed reasoning content.
+   */
+  text: string;
+
+  /**
+   * The type of the event. Always `response.reasoning_text.done`.
+   */
+  type: 'response.reasoning_text.done';
+}
+
 /**
  * Emitted when there is a partial refusal text.
  */
@@ -4079,6 +4095,8 @@ export type ResponseStreamEvent =
   | ResponseReasoningSummaryPartDoneEvent
   | ResponseReasoningSummaryTextDeltaEvent
   | ResponseReasoningSummaryTextDoneEvent
+  | ResponseReasoningTextDeltaEvent
+  | ResponseReasoningTextDoneEvent
   | ResponseRefusalDeltaEvent
   | ResponseRefusalDoneEvent
   | ResponseTextDeltaEvent
@@ -4099,9 +4117,7 @@ export type ResponseStreamEvent =
   | ResponseMcpListToolsFailedEvent
   | ResponseMcpListToolsInProgressEvent
   | ResponseOutputTextAnnotationAddedEvent
-  | ResponseQueuedEvent
-  | ResponseReasoningSummaryDeltaEvent
-  | ResponseReasoningSummaryDoneEvent;
+  | ResponseQueuedEvent;
 
 /**
  * Configuration options for a text response from the model. Can be plain text or
@@ -5148,12 +5164,12 @@ export declare namespace Responses {
     type ResponsePrompt as ResponsePrompt,
     type ResponseQueuedEvent as ResponseQueuedEvent,
     type ResponseReasoningItem as ResponseReasoningItem,
-    type ResponseReasoningSummaryDeltaEvent as ResponseReasoningSummaryDeltaEvent,
-    type ResponseReasoningSummaryDoneEvent as ResponseReasoningSummaryDoneEvent,
     type ResponseReasoningSummaryPartAddedEvent as ResponseReasoningSummaryPartAddedEvent,
     type ResponseReasoningSummaryPartDoneEvent as ResponseReasoningSummaryPartDoneEvent,
     type ResponseReasoningSummaryTextDeltaEvent as ResponseReasoningSummaryTextDeltaEvent,
     type ResponseReasoningSummaryTextDoneEvent as ResponseReasoningSummaryTextDoneEvent,
+    type ResponseReasoningTextDeltaEvent as ResponseReasoningTextDeltaEvent,
+    type ResponseReasoningTextDoneEvent as ResponseReasoningTextDoneEvent,
     type ResponseRefusalDeltaEvent as ResponseRefusalDeltaEvent,
     type ResponseRefusalDoneEvent as ResponseRefusalDoneEvent,
     type ResponseStatus as ResponseStatus,

src/resources/vector-stores/vector-stores.ts

@@ -498,7 +498,10 @@ export namespace VectorStoreSearchParams {
    * Ranking options for search.
    */
   export interface RankingOptions {
-    ranker?: 'auto' | 'default-2024-11-15';
+    /**
+     * Enable re-ranking; set to `none` to disable, which can help reduce latency.
+     */
+    ranker?: 'none' | 'auto' | 'default-2024-11-15';
 
     score_threshold?: number;
   }

src/version.ts

@@ -1 +1 @@
-export const VERSION = '5.11.0'; // x-release-please-version
+export const VERSION = '5.12.0'; // x-release-please-version

tests/api-resources/vector-stores/vector-stores.test.ts

@@ -89,7 +89,7 @@ describe('resource vectorStores', () => {
       query: 'string',
       filters: { key: 'key', type: 'eq', value: 'string' },
       max_num_results: 1,
-      ranking_options: { ranker: 'auto', score_threshold: 0 },
+      ranking_options: { ranker: 'none', score_threshold: 0 },
       rewrite_query: true,
     });
   });