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

kwhinnery-openai · web-flow · commit aaa859eaf7fd · 2025-06-02T14:40:37.000-05:00
release: 5.0.2
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -1,3 +1,3 @@
 {
-  ".": "5.0.1"
+  ".": "5.0.2"
 }
diff --git a/.stats.yml b/.stats.yml
@@ -1,4 +1,4 @@
 configured_endpoints: 111
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-d4bcffecf0cdadf746faa6708ed1ec81fac451f9b857deabbab26f0a343b9314.yml
-openapi_spec_hash: 7c54a18b4381248bda7cc34c52142615
-config_hash: e618aa8ff61aea826540916336de65a6
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-2bcc845d8635bf93ddcf9ee723af4d7928248412a417bee5fc10d863a1e13867.yml
+openapi_spec_hash: 865230cb3abeb01bd85de05891af23c4
+config_hash: ed1e6b3c5f93d12b80d31167f55c557c
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,19 @@
 # Changelog
 
+## 5.0.2 (2025-06-02)
+
+Full Changelog: [v5.0.1...v5.0.2](https://github.com/openai/openai-node/compare/v5.0.1...v5.0.2)
+
+### Bug Fixes
+
+* **api:** Fix evals and code interpreter interfaces ([992a9d8](https://github.com/openai/openai-node/commit/992a9d84fe412d96496b11b7a6be5c927f78db6c))
+
+
+### Chores
+
+* **deps:** bump eslint-plugin-prettier ([1428a8b](https://github.com/openai/openai-node/commit/1428a8b4f82e79695c2cbed5e12ca0da4958423b))
+* **internal:** codegen related update ([a65428f](https://github.com/openai/openai-node/commit/a65428fc81e05f681eab806e7efc6ad26062221b))
+
 ## 5.0.1 (2025-05-29)
 
 Full Changelog: [v5.0.0...v5.0.1](https://github.com/openai/openai-node/compare/v5.0.0...v5.0.1)
diff --git a/api.md b/api.md
@@ -709,7 +709,7 @@ Methods:
 - <code title="post /responses">client.responses.<a href="./src/resources/responses/responses.ts">create</a>({ ...params }) -> Response</code>
 - <code title="get /responses/{response_id}">client.responses.<a href="./src/resources/responses/responses.ts">retrieve</a>(responseID, { ...params }) -> Response</code>
 - <code title="delete /responses/{response_id}">client.responses.<a href="./src/resources/responses/responses.ts">delete</a>(responseID) -> void</code>
-- <code title="post /responses/{response_id}/cancel">client.responses.<a href="./src/resources/responses/responses.ts">cancel</a>(responseID) -> void</code>
+- <code title="post /responses/{response_id}/cancel">client.responses.<a href="./src/resources/responses/responses.ts">cancel</a>(responseID) -> Response</code>
 
 ## InputItems
 
diff --git a/jest.config.ts b/jest.config.ts
@@ -15,6 +15,7 @@ const config: JestConfigWithTsJest = {
     '<rootDir>/dist/',
     '<rootDir>/deno/',
     '<rootDir>/deno_tests/',
+    '<rootDir>/packages/',
   ],
   testPathIgnorePatterns: ['scripts'],
   // prettierPath: require.resolve('prettier-2'),
diff --git a/jsr.json b/jsr.json
@@ -1,6 +1,6 @@
 {
   "name": "@openai/openai",
-  "version": "5.0.1",
+  "version": "5.0.2",
   "exports": {
     ".": "./index.ts",
     "./helpers/zod": "./helpers/zod.ts",
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "openai",
-  "version": "5.0.1",
+  "version": "5.0.2",
   "description": "The official TypeScript library for the OpenAI API",
   "author": "OpenAI <support@openai.com>",
   "types": "dist/index.d.ts",
@@ -35,7 +35,7 @@
     "@typescript-eslint/eslint-plugin": "8.31.1",
     "@typescript-eslint/parser": "8.31.1",
     "eslint": "^9.20.1",
-    "eslint-plugin-prettier": "^5.2.3",
+    "eslint-plugin-prettier": "^5.4.1",
     "eslint-plugin-unused-imports": "^4.1.4",
     "execa": "^5.1.1",
     "fast-check": "^3.22.0",
@@ -51,9 +51,6 @@
     "ws": "^8.18.0",
     "zod": "^3.23.8"
   },
-  "resolutions": {
-    "synckit": "0.8.8"
-  },
   "imports": {
     "openai": ".",
     "openai/*": "./src/*"
diff --git a/src/resources/audio/transcriptions.ts b/src/resources/audio/transcriptions.ts
@@ -199,7 +199,7 @@ export namespace TranscriptionTextDeltaEvent {
     /**
      * The bytes that were used to generate the log probability.
      */
-    bytes?: Array<unknown>;
+    bytes?: Array<number>;
 
     /**
      * The log probability of the token.
@@ -244,7 +244,7 @@ export namespace TranscriptionTextDoneEvent {
     /**
      * The bytes that were used to generate the log probability.
      */
-    bytes?: Array<unknown>;
+    bytes?: Array<number>;
 
     /**
      * The log probability of the token.
diff --git a/src/resources/chat/completions/completions.ts b/src/resources/chat/completions/completions.ts
@@ -280,9 +280,9 @@ export interface ChatCompletion {
    *   utilize scale tier credits until they are exhausted.
    * - If set to 'auto', and the Project is not Scale tier enabled, the request will
    *   be processed using the default service tier with a lower uptime SLA and no
-   *   latency guarentee.
+   *   latency guarantee.
    * - If set to 'default', the request will be processed using the default service
-   *   tier with a lower uptime SLA and no latency guarentee.
+   *   tier with a lower uptime SLA and no latency guarantee.
    * - If set to 'flex', the request will be processed with the Flex Processing
    *   service tier.
    *   [Learn more](https://platform.openai.com/docs/guides/flex-processing).
@@ -531,9 +531,9 @@ export interface ChatCompletionChunk {
    *   utilize scale tier credits until they are exhausted.
    * - If set to 'auto', and the Project is not Scale tier enabled, the request will
    *   be processed using the default service tier with a lower uptime SLA and no
-   *   latency guarentee.
+   *   latency guarantee.
    * - If set to 'default', the request will be processed using the default service
-   *   tier with a lower uptime SLA and no latency guarentee.
+   *   tier with a lower uptime SLA and no latency guarantee.
    * - If set to 'flex', the request will be processed with the Flex Processing
    *   service tier.
    *   [Learn more](https://platform.openai.com/docs/guides/flex-processing).
@@ -1453,9 +1453,9 @@ export interface ChatCompletionCreateParamsBase {
    *   utilize scale tier credits until they are exhausted.
    * - If set to 'auto', and the Project is not Scale tier enabled, the request will
    *   be processed using the default service tier with a lower uptime SLA and no
-   *   latency guarentee.
+   *   latency guarantee.
    * - If set to 'default', the request will be processed using the default service
-   *   tier with a lower uptime SLA and no latency guarentee.
+   *   tier with a lower uptime SLA and no latency guarantee.
    * - If set to 'flex', the request will be processed with the Flex Processing
    *   service tier.
    *   [Learn more](https://platform.openai.com/docs/guides/flex-processing).
diff --git a/src/resources/fine-tuning/alpha/graders.ts b/src/resources/fine-tuning/alpha/graders.ts
@@ -20,7 +20,6 @@ export class Graders extends APIResource {
    *     type: 'string_check',
    *   },
    *   model_sample: 'model_sample',
-   *   reference_answer: 'string',
    * });
    * ```
    */
@@ -134,14 +133,20 @@ export interface GraderRunParams {
     | GraderModelsAPI.MultiGrader;
 
   /**
-   * The model sample to be evaluated.
+   * The model sample to be evaluated. This value will be used to populate the
+   * `sample` namespace. See
+   * [the guide](https://platform.openai.com/docs/guides/graders) for more details.
+   * The `output_json` variable will be populated if the model sample is a valid JSON
+   * string.
    */
   model_sample: string;
 
   /**
-   * The reference answer for the evaluation.
+   * The dataset item provided to the grader. This will be used to populate the
+   * `item` namespace. See
+   * [the guide](https://platform.openai.com/docs/guides/graders) for more details.
    */
-  reference_answer: string | unknown | Array<unknown> | number;
+  item?: unknown;
 }
 
 export interface GraderValidateParams {
diff --git a/src/resources/fine-tuning/jobs/jobs.ts b/src/resources/fine-tuning/jobs/jobs.ts
@@ -295,7 +295,7 @@ export namespace FineTuningJob {
      * Number of examples in each batch. A larger batch size means that model
      * parameters are updated less frequently, but with lower variance.
      */
-    batch_size?: unknown | 'auto' | number | null;
+    batch_size?: 'auto' | number | null;
 
     /**
      * Scaling factor for the learning rate. A smaller learning rate may be useful to
diff --git a/src/resources/graders/grader-models.ts b/src/resources/graders/grader-models.ts
@@ -92,10 +92,11 @@ export interface MultiGrader {
    */
   calculate_output: string;
 
-  graders: Record<
-    string,
-    StringCheckGrader | TextSimilarityGrader | PythonGrader | ScoreModelGrader | LabelModelGrader
-  >;
+  /**
+   * A StringCheckGrader object that performs a string comparison between input and
+   * reference using a specified operation.
+   */
+  graders: StringCheckGrader | TextSimilarityGrader | PythonGrader | ScoreModelGrader | LabelModelGrader;
 
   /**
    * The name of the grader.
diff --git a/src/resources/images.ts b/src/resources/images.ts
@@ -193,7 +193,7 @@ export interface ImageEditParams {
    * The image(s) to edit. Must be a supported image file or an array of images.
    *
    * For `gpt-image-1`, each image should be a `png`, `webp`, or `jpg` file less than
-   * 25MB. You can provide up to 16 images.
+   * 50MB. You can provide up to 16 images.
    *
    * For `dall-e-2`, you can only provide one image, and it should be a square `png`
    * file less than 4MB.
diff --git a/src/resources/responses/responses.ts b/src/resources/responses/responses.ts
@@ -185,16 +185,13 @@ export class Responses extends APIResource {
    *
    * @example
    * ```ts
-   * await client.responses.cancel(
+   * const response = await client.responses.cancel(
    *   'resp_677efb5139a88190b512bc3fef8e535d',
    * );
    * ```
    */
-  cancel(responseID: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.post(path`/responses/${responseID}/cancel`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  cancel(responseID: string, options?: RequestOptions): APIPromise<Response> {
+    return this._client.post(path`/responses/${responseID}/cancel`, options);
   }
 }
 
@@ -488,9 +485,9 @@ export interface Response {
    *   utilize scale tier credits until they are exhausted.
    * - If set to 'auto', and the Project is not Scale tier enabled, the request will
    *   be processed using the default service tier with a lower uptime SLA and no
-   *   latency guarentee.
+   *   latency guarantee.
    * - If set to 'default', the request will be processed using the default service
-   *   tier with a lower uptime SLA and no latency guarentee.
+   *   tier with a lower uptime SLA and no latency guarantee.
    * - If set to 'flex', the request will be processed with the Flex Processing
    *   service tier.
    *   [Learn more](https://platform.openai.com/docs/guides/flex-processing).
@@ -643,9 +640,9 @@ export interface ResponseCodeInterpreterCallCodeDeltaEvent {
   sequence_number: number;
 
   /**
-   * The type of the event. Always `response.code_interpreter_call.code.delta`.
+   * The type of the event. Always `response.code_interpreter_call_code.delta`.
    */
-  type: 'response.code_interpreter_call.code.delta';
+  type: 'response.code_interpreter_call_code.delta';
 }
 
 /**
@@ -668,9 +665,9 @@ export interface ResponseCodeInterpreterCallCodeDoneEvent {
   sequence_number: number;
 
   /**
-   * The type of the event. Always `response.code_interpreter_call.code.done`.
+   * The type of the event. Always `response.code_interpreter_call_code.done`.
    */
-  type: 'response.code_interpreter_call.code.done';
+  type: 'response.code_interpreter_call_code.done';
 }
 
 /**
@@ -1875,12 +1872,15 @@ export interface ResponseInProgressEvent {
  *   multi-turn conversations when using the Responses API statelessly (like when
  *   the `store` parameter is set to `false`, or when an organization is enrolled
  *   in the zero data retention program).
+ * - `code_interpreter_call.outputs`: Includes the outputs of python code execution
+ *   in code interpreter tool call items.
  */
 export type ResponseIncludable =
   | 'file_search_call.results'
   | 'message.input_image.image_url'
   | 'computer_call_output.output.image_url'
-  | 'reasoning.encrypted_content';
+  | 'reasoning.encrypted_content'
+  | 'code_interpreter_call.outputs';
 
 /**
  * An event that is emitted when a response finishes as incomplete.
@@ -3296,7 +3296,10 @@ export interface ResponseOutputText {
    * The annotations of the text output.
    */
   annotations: Array<
-    ResponseOutputText.FileCitation | ResponseOutputText.URLCitation | ResponseOutputText.FilePath
+    | ResponseOutputText.FileCitation
+    | ResponseOutputText.URLCitation
+    | ResponseOutputText.ContainerFileCitation
+    | ResponseOutputText.FilePath
   >;
 
   /**
@@ -3363,6 +3366,36 @@ export namespace ResponseOutputText {
     url: string;
   }
 
+  /**
+   * A citation for a container file used to generate a model response.
+   */
+  export interface ContainerFileCitation {
+    /**
+     * The ID of the container file.
+     */
+    container_id: string;
+
+    /**
+     * The index of the last character of the container file citation in the message.
+     */
+    end_index: number;
+
+    /**
+     * The ID of the file.
+     */
+    file_id: string;
+
+    /**
+     * The index of the first character of the container file citation in the message.
+     */
+    start_index: number;
+
+    /**
+     * The type of the container file citation. Always `container_file_citation`.
+     */
+    type: 'container_file_citation';
+  }
+
   /**
    * A path to a file.
    */
@@ -4573,6 +4606,8 @@ export interface ResponseCreateParamsBase {
    *   multi-turn conversations when using the Responses API statelessly (like when
    *   the `store` parameter is set to `false`, or when an organization is enrolled
    *   in the zero data retention program).
+   * - `code_interpreter_call.outputs`: Includes the outputs of python code execution
+   *   in code interpreter tool call items.
    */
   include?: Array<ResponseIncludable> | null;
 
@@ -4631,9 +4666,9 @@ export interface ResponseCreateParamsBase {
    *   utilize scale tier credits until they are exhausted.
    * - If set to 'auto', and the Project is not Scale tier enabled, the request will
    *   be processed using the default service tier with a lower uptime SLA and no
-   *   latency guarentee.
+   *   latency guarantee.
    * - If set to 'default', the request will be processed using the default service
-   *   tier with a lower uptime SLA and no latency guarentee.
+   *   tier with a lower uptime SLA and no latency guarantee.
    * - If set to 'flex', the request will be processed with the Flex Processing
    *   service tier.
    *   [Learn more](https://platform.openai.com/docs/guides/flex-processing).
diff --git a/src/version.ts b/src/version.ts
@@ -1 +1 @@
-export const VERSION = '5.0.1'; // x-release-please-version
+export const VERSION = '5.0.2'; // x-release-please-version
diff --git a/tests/api-resources/fine-tuning/alpha/graders.test.ts b/tests/api-resources/fine-tuning/alpha/graders.test.ts
@@ -12,7 +12,6 @@ describe('resource graders', () => {
     const responsePromise = client.fineTuning.alpha.graders.run({
       grader: { input: 'input', name: 'name', operation: 'eq', reference: 'reference', type: 'string_check' },
       model_sample: 'model_sample',
-      reference_answer: 'string',
     });
     const rawResponse = await responsePromise.asResponse();
     expect(rawResponse).toBeInstanceOf(Response);
@@ -27,7 +26,7 @@ describe('resource graders', () => {
     const response = await client.fineTuning.alpha.graders.run({
       grader: { input: 'input', name: 'name', operation: 'eq', reference: 'reference', type: 'string_check' },
       model_sample: 'model_sample',
-      reference_answer: 'string',
+      item: {},
     });
   });
 
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`		`- ".": "5.0.1"`
	`2`	`+ ".": "5.0.2"`
`3`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@openai/openai",`
`3`		`- "version": "5.0.1",`
	`3`	`+ "version": "5.0.2",`
`4`	`4`	`"exports": {`
`5`	`5`	`".": "./index.ts",`
`6`	`6`	`"./helpers/zod": "./helpers/zod.ts",`