openai - npm Package Compare versions

Comparing version 4.96.2 to 4.97.0

package.json

 {
   "name": "openai",
-  "version": "4.96.2",
+  "version": "4.97.0",
   "description": "The official TypeScript library for the OpenAI API",
@@ -5,0 +5,0 @@ "author": "OpenAI <[e-mail]>",

README.md

@@ -154,3 +154,3 @@ # OpenAI TypeScript and JavaScript API Library
 
-Error codes are as followed:
+Error codes are as follows:
 
@@ -157,0 +157,0 @@ | Status Code | Error Type                 |

resources/audio/speech.d.ts

@@ -40,3 +40,3 @@ import { APIResource } from "../../resource.js";
      * The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is
-     * the default.
+     * the default. Does not work with `gpt-4o-mini-tts`.
      */
@@ -43,0 +43,0 @@ speed?: number;

resources/chat/completions/completions.d.ts

@@ -958,3 +958,3 @@ import { APIResource } from "../../../resource.js";
     /**
-     * Deprecated in favor of `tool_choice`.
+     * @deprecated Deprecated in favor of `tool_choice`.
      *
@@ -976,3 +976,3 @@ * Controls which (if any) function is called by the model.
     /**
-     * Deprecated in favor of `tools`.
+     * @deprecated Deprecated in favor of `tools`.
      *
@@ -1006,4 +1006,4 @@ * A list of functions the model may generate JSON inputs for.
     /**
-     * The maximum number of [tokens](/tokenizer) that can be generated in the chat
-     * completion. This value can be used to control
+     * @deprecated The maximum number of [tokens](/tokenizer) that can be generated in
+     * the chat completion. This value can be used to control
      * [costs](https://openai.com/api/pricing/) for text generated via API.
@@ -1010,0 +1010,0 @@ *

resources/fine-tuning/jobs/jobs.d.ts

@@ -364,4 +364,5 @@ import { APIResource } from "../../../resource.js";
     /**
-     * The hyperparameters used for the fine-tuning job. This value is now deprecated
-     * in favor of `method`, and should be passed in under the `method` parameter.
+     * @deprecated The hyperparameters used for the fine-tuning job. This value is now
+     * deprecated in favor of `method`, and should be passed in under the `method`
+     * parameter.
      */
@@ -368,0 +369,0 @@ hyperparameters?: JobCreateParams.Hyperparameters;

resources/images.d.ts

@@ -131,6 +131,9 @@ import { APIResource } from "../resource.js";
     /**
-     * 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. For `dall-e-2`, you can only provide one image, and it should be a square
-     * `png` file less than 4MB.
+     * 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.
+     *
+     * For `dall-e-2`, you can only provide one image, and it should be a square `png`
+     * file less than 4MB.
      */
@@ -144,2 +147,12 @@ image: Core.Uploadable | Array<Core.Uploadable>;
     /**
+     * Allows to set transparency for the background of the generated image(s). This
+     * parameter is only supported for `gpt-image-1`. Must be one of `transparent`,
+     * `opaque` or `auto` (default value). When `auto` is used, the model will
+     * automatically determine the best background for the image.
+     *
+     * If `transparent`, the output format needs to support transparency, so it should
+     * be set to either `png` (default value) or `webp`.
+     */
+    background?: 'transparent' | 'opaque' | 'auto' | null;
+    /**
      * An additional image whose fully transparent areas (e.g. where alpha is zero)
@@ -179,3 +192,3 @@ * indicate where `image` should be edited. If there are multiple images provided,
      */
-    size?: '256x256' | '512x512' | '1024x1024' | null;
+    size?: '256x256' | '512x512' | '1024x1024' | '1536x1024' | '1024x1536' | 'auto' | null;
     /**
@@ -182,0 +195,0 @@ * A unique identifier representing your end-user, which can help OpenAI to monitor

src/resources/audio/speech.ts

@@ -69,3 +69,3 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
    * The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is
-   * the default.
+   * the default. Does not work with `gpt-4o-mini-tts`.
    */
@@ -72,0 +72,0 @@ speed?: number;

src/resources/chat/completions/completions.ts

@@ -1172,3 +1172,3 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
   /**
-   * Deprecated in favor of `tool_choice`.
+   * @deprecated Deprecated in favor of `tool_choice`.
    *
@@ -1191,3 +1191,3 @@ * Controls which (if any) function is called by the model.
   /**
-   * Deprecated in favor of `tools`.
+   * @deprecated Deprecated in favor of `tools`.
    *
@@ -1225,4 +1225,4 @@ * A list of functions the model may generate JSON inputs for.
   /**
-   * The maximum number of [tokens](/tokenizer) that can be generated in the chat
-   * completion. This value can be used to control
+   * @deprecated The maximum number of [tokens](/tokenizer) that can be generated in
+   * the chat completion. This value can be used to control
    * [costs](https://openai.com/api/pricing/) for text generated via API.
@@ -1229,0 +1229,0 @@ *

src/resources/fine-tuning/jobs/jobs.ts

@@ -469,4 +469,5 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
   /**
-   * The hyperparameters used for the fine-tuning job. This value is now deprecated
-   * in favor of `method`, and should be passed in under the `method` parameter.
+   * @deprecated The hyperparameters used for the fine-tuning job. This value is now
+   * deprecated in favor of `method`, and should be passed in under the `method`
+   * parameter.
    */
@@ -473,0 +474,0 @@ hyperparameters?: JobCreateParams.Hyperparameters;

src/resources/images.ts

@@ -165,6 +165,9 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
   /**
-   * 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. For `dall-e-2`, you can only provide one image, and it should be a square
-   * `png` file less than 4MB.
+   * 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.
+   *
+   * For `dall-e-2`, you can only provide one image, and it should be a square `png`
+   * file less than 4MB.
    */
@@ -180,2 +183,13 @@ image: Core.Uploadable | Array<Core.Uploadable>;
   /**
+   * Allows to set transparency for the background of the generated image(s). This
+   * parameter is only supported for `gpt-image-1`. Must be one of `transparent`,
+   * `opaque` or `auto` (default value). When `auto` is used, the model will
+   * automatically determine the best background for the image.
+   *
+   * If `transparent`, the output format needs to support transparency, so it should
+   * be set to either `png` (default value) or `webp`.
+   */
+  background?: 'transparent' | 'opaque' | 'auto' | null;
+
+  /**
    * An additional image whose fully transparent areas (e.g. where alpha is zero)
@@ -220,3 +234,3 @@ * indicate where `image` should be edited. If there are multiple images provided,
    */
-  size?: '256x256' | '512x512' | '1024x1024' | null;
+  size?: '256x256' | '512x512' | '1024x1024' | '1536x1024' | '1024x1536' | 'auto' | null;
 
@@ -223,0 +237,0 @@ /**

src/version.ts

@@ -1,1 +0,1 @@
-export const VERSION = '4.96.2'; // x-release-please-version
+export const VERSION = '4.97.0'; // x-release-please-version

version.d.ts

@@ -1,2 +0,2 @@
-export declare const VERSION = "4.96.2";
+export declare const VERSION = "4.97.0";
 //# sourceMappingURL=version.d.ts.map

version.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '4.96.2'; // x-release-please-version
+exports.VERSION = '4.97.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

No alert changes

Improved metrics

Total package byte prevSize

3976309

0.13%

Lines of code

73550

0.09%

No dependency changes