openai 4.96.2 → 4.98.0

package/resources/images.d.ts

@@ -3,16 +3,38 @@ import * as Core from "../core.js";
 export declare class Images extends APIResource {
     /**
      * Creates a variation of a given image. This endpoint only supports `dall-e-2`.
+     *
+     * @example
+     * ```ts
+     * const imagesResponse = await client.images.createVariation({
+     *   image: fs.createReadStream('otter.png'),
+     * });
+     * ```
      */
     createVariation(body: ImageCreateVariationParams, options?: Core.RequestOptions): Core.APIPromise<ImagesResponse>;
     /**
      * Creates an edited or extended image given one or more source images and a
      * prompt. This endpoint only supports `gpt-image-1` and `dall-e-2`.
+     *
+     * @example
+     * ```ts
+     * const imagesResponse = await client.images.edit({
+     *   image: fs.createReadStream('path/to/file'),
+     *   prompt: 'A cute baby sea otter wearing a beret',
+     * });
+     * ```
      */
     edit(body: ImageEditParams, options?: Core.RequestOptions): Core.APIPromise<ImagesResponse>;
     /**
      * Creates an image given a prompt.
      * [Learn more](https://platform.openai.com/docs/guides/images).
+     *
+     * @example
+     * ```ts
+     * const imagesResponse = await client.images.generate({
+     *   prompt: 'A cute baby sea otter',
+     * });
+     * ```
      */
     generate(body: ImageGenerateParams, options?: Core.RequestOptions): Core.APIPromise<ImagesResponse>;
 }
@@ -128,10 +150,13 @@ export interface ImageCreateVariationParams {
 }
 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. 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.
      */
     image: Core.Uploadable | Array<Core.Uploadable>;
     /**
@@ -139,6 +164,16 @@ export interface ImageEditParams {
      * characters for `dall-e-2`, and 32000 characters for `gpt-image-1`.
      */
     prompt: string;
+    /**
+     * 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)
      * indicate where `image` should be edited. If there are multiple images provided,
@@ -174,7 +209,7 @@ export interface ImageEditParams {
      * (landscape), `1024x1536` (portrait), or `auto` (default value) for
      * `gpt-image-1`, and one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`.
      */
-    size?: '256x256' | '512x512' | '1024x1024' | null;
+    size?: '256x256' | '512x512' | '1024x1024' | '1536x1024' | '1024x1536' | 'auto' | null;
     /**
      * A unique identifier representing your end-user, which can help OpenAI to monitor
      * and detect abuse.

package/resources/images.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"images.d.ts","sourceRoot":"","sources":["../src/resources/images.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,eAAe,CACb,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;IAIlC;;;OAGG;IACH,IAAI,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;IAI3F;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;CAGpG;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,UAAU,GAAG,aAAa,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC,KAAK,CAAC;CAC9B;AAED,yBAAiB,cAAc,CAAC;IAC9B;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,oBAAoB,EAAE,KAAK,CAAC,kBAAkB,CAAC;QAE/C;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,KAAK,CAAC;QACrB;;WAEG;QACH,UAAiB,kBAAkB;YACjC;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;SACrB;KACF;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC;IAEvB;;;OAGG;IACH,KAAK,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElB;;;;OAIG;IACH,eAAe,CAAC,EAAE,KAAK,GAAG,UAAU,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,IAAI,CAAC;IAElD;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,eAAe;IAC9B;;;;;OAKG;IACH,KAAK,EAAE,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAEhD;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,IAAI,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC;IAEvB;;;;OAIG;IACH,KAAK,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElB;;;;OAIG;IACH,OAAO,CAAC,EAAE,UAAU,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAEjE;;;;;OAKG;IACH,eAAe,CAAC,EAAE,KAAK,GAAG,UAAU,GAAG,IAAI,CAAC;IAE5C;;;;OAIG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,IAAI,CAAC;IAElD;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,aAAa,GAAG,QAAQ,GAAG,MAAM,GAAG,IAAI,CAAC;IAEtD;;;;OAIG;IACH,KAAK,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC;IAE1C;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAE/C;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAExE;;;;;OAKG;IACH,eAAe,CAAC,EAAE,KAAK,GAAG,UAAU,GAAG,IAAI,CAAC;IAE5C;;;;;OAKG;IACH,IAAI,CAAC,EACD,MAAM,GACN,WAAW,GACX,WAAW,GACX,WAAW,GACX,SAAS,GACT,SAAS,GACT,WAAW,GACX,WAAW,GACX,IAAI,CAAC;IAET;;;;;OAKG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"images.d.ts","sourceRoot":"","sources":["../src/resources/images.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,eAAe,CACb,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;IAIlC;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;IAI3F;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;CAGpG;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,UAAU,GAAG,aAAa,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC,KAAK,CAAC;CAC9B;AAED,yBAAiB,cAAc,CAAC;IAC9B;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,oBAAoB,EAAE,KAAK,CAAC,kBAAkB,CAAC;QAE/C;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,KAAK,CAAC;QACrB;;WAEG;QACH,UAAiB,kBAAkB;YACjC;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;SACrB;KACF;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC;IAEvB;;;OAGG;IACH,KAAK,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElB;;;;OAIG;IACH,eAAe,CAAC,EAAE,KAAK,GAAG,UAAU,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,IAAI,CAAC;IAElD;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,eAAe;IAC9B;;;;;;;;OAQG;IACH,KAAK,EAAE,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAEhD;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,aAAa,GAAG,QAAQ,GAAG,MAAM,GAAG,IAAI,CAAC;IAEtD;;;;;OAKG;IACH,IAAI,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC;IAEvB;;;;OAIG;IACH,KAAK,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElB;;;;OAIG;IACH,OAAO,CAAC,EAAE,UAAU,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAEjE;;;;;OAKG;IACH,eAAe,CAAC,EAAE,KAAK,GAAG,UAAU,GAAG,IAAI,CAAC;IAE5C;;;;OAIG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,GAAG,MAAM,GAAG,IAAI,CAAC;IAEvF;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,aAAa,GAAG,QAAQ,GAAG,MAAM,GAAG,IAAI,CAAC;IAEtD;;;;OAIG;IACH,KAAK,CAAC,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC;IAE1C;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAE/C;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAExE;;;;;OAKG;IACH,eAAe,CAAC,EAAE,KAAK,GAAG,UAAU,GAAG,IAAI,CAAC;IAE5C;;;;;OAKG;IACH,IAAI,CAAC,EACD,MAAM,GACN,WAAW,GACX,WAAW,GACX,WAAW,GACX,SAAS,GACT,SAAS,GACT,WAAW,GACX,WAAW,GACX,IAAI,CAAC;IAET;;;;;OAKG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/images.js

@@ -30,6 +30,13 @@ const Core = __importStar(require("../core.js"));
 class Images extends resource_1.APIResource {
     /**
      * Creates a variation of a given image. This endpoint only supports `dall-e-2`.
+     *
+     * @example
+     * ```ts
+     * const imagesResponse = await client.images.createVariation({
+     *   image: fs.createReadStream('otter.png'),
+     * });
+     * ```
      */
     createVariation(body, options) {
         return this._client.post('/images/variations', Core.multipartFormRequestOptions({ body, ...options }));
@@ -37,6 +44,14 @@ class Images extends resource_1.APIResource {
     /**
      * Creates an edited or extended image given one or more source images and a
      * prompt. This endpoint only supports `gpt-image-1` and `dall-e-2`.
+     *
+     * @example
+     * ```ts
+     * const imagesResponse = await client.images.edit({
+     *   image: fs.createReadStream('path/to/file'),
+     *   prompt: 'A cute baby sea otter wearing a beret',
+     * });
+     * ```
      */
     edit(body, options) {
         return this._client.post('/images/edits', Core.multipartFormRequestOptions({ body, ...options }));
@@ -44,6 +59,13 @@ class Images extends resource_1.APIResource {
     /**
      * Creates an image given a prompt.
      * [Learn more](https://platform.openai.com/docs/guides/images).
+     *
+     * @example
+     * ```ts
+     * const imagesResponse = await client.images.generate({
+     *   prompt: 'A cute baby sea otter',
+     * });
+     * ```
      */
     generate(body, options) {
         return this._client.post('/images/generations', { body, ...options });

package/resources/images.js.map

@@ -1 +1 @@
-{"version":3,"file":"images.js","sourceRoot":"","sources":["../src/resources/images.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,6CAA0C;AAC1C,iDAAgC;AAEhC,MAAa,MAAO,SAAQ,sBAAW;IACrC;;OAEG;IACH,eAAe,CACb,IAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,IAAI,CAAC,2BAA2B,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC;IACzG,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,IAAqB,EAAE,OAA6B;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,2BAA2B,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC;IACpG,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,IAAyB,EAAE,OAA6B;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF;AA1BD,wBA0BC"}
+{"version":3,"file":"images.js","sourceRoot":"","sources":["../src/resources/images.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,6CAA0C;AAC1C,iDAAgC;AAEhC,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;OASG;IACH,eAAe,CACb,IAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,IAAI,CAAC,2BAA2B,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,IAAqB,EAAE,OAA6B;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,2BAA2B,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,IAAyB,EAAE,OAA6B;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF;AAhDD,wBAgDC"}

package/resources/images.mjs

@@ -4,6 +4,13 @@ import * as Core from "../core.mjs";
 export class Images extends APIResource {
     /**
      * Creates a variation of a given image. This endpoint only supports `dall-e-2`.
+     *
+     * @example
+     * ```ts
+     * const imagesResponse = await client.images.createVariation({
+     *   image: fs.createReadStream('otter.png'),
+     * });
+     * ```
      */
     createVariation(body, options) {
         return this._client.post('/images/variations', Core.multipartFormRequestOptions({ body, ...options }));
@@ -11,6 +18,14 @@ export class Images extends APIResource {
     /**
      * Creates an edited or extended image given one or more source images and a
      * prompt. This endpoint only supports `gpt-image-1` and `dall-e-2`.
+     *
+     * @example
+     * ```ts
+     * const imagesResponse = await client.images.edit({
+     *   image: fs.createReadStream('path/to/file'),
+     *   prompt: 'A cute baby sea otter wearing a beret',
+     * });
+     * ```
      */
     edit(body, options) {
         return this._client.post('/images/edits', Core.multipartFormRequestOptions({ body, ...options }));
@@ -18,6 +33,13 @@ export class Images extends APIResource {
     /**
      * Creates an image given a prompt.
      * [Learn more](https://platform.openai.com/docs/guides/images).
+     *
+     * @example
+     * ```ts
+     * const imagesResponse = await client.images.generate({
+     *   prompt: 'A cute baby sea otter',
+     * });
+     * ```
      */
     generate(body, options) {
         return this._client.post('/images/generations', { body, ...options });

package/resources/images.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"images.mjs","sourceRoot":"","sources":["../src/resources/images.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,IAAI;AAEhB,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,eAAe,CACb,IAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,IAAI,CAAC,2BAA2B,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC;IACzG,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,IAAqB,EAAE,OAA6B;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,2BAA2B,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC;IACpG,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,IAAyB,EAAE,OAA6B;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF"}
+{"version":3,"file":"images.mjs","sourceRoot":"","sources":["../src/resources/images.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,IAAI;AAEhB,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,eAAe,CACb,IAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,IAAI,CAAC,2BAA2B,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,IAAqB,EAAE,OAA6B;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,2BAA2B,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,IAAyB,EAAE,OAA6B;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF"}

package/resources/index.d.ts

@@ -5,9 +5,10 @@ export { BatchesPage, Batches, type Batch, type BatchError, type BatchRequestCou
 export { Beta } from "./beta/beta.js";
 export { Completions, type Completion, type CompletionChoice, type CompletionUsage, type CompletionCreateParams, type CompletionCreateParamsNonStreaming, type CompletionCreateParamsStreaming, } from "./completions.js";
 export { Embeddings, type CreateEmbeddingResponse, type Embedding, type EmbeddingModel, type EmbeddingCreateParams, } from "./embeddings.js";
-export { EvalListResponsesPage, Evals, type EvalCustomDataSourceConfig, type EvalLabelModelGrader, type EvalStoredCompletionsDataSourceConfig, type EvalStringCheckGrader, type EvalTextSimilarityGrader, type EvalCreateResponse, type EvalRetrieveResponse, type EvalUpdateResponse, type EvalListResponse, type EvalDeleteResponse, type EvalCreateParams, type EvalUpdateParams, type EvalListParams, } from "./evals/evals.js";
+export { EvalListResponsesPage, Evals, type EvalCustomDataSourceConfig, type EvalStoredCompletionsDataSourceConfig, type EvalCreateResponse, type EvalRetrieveResponse, type EvalUpdateResponse, type EvalListResponse, type EvalDeleteResponse, type EvalCreateParams, type EvalUpdateParams, type EvalListParams, } from "./evals/evals.js";
 export { FileObjectsPage, Files, type FileContent, type FileDeleted, type FileObject, type FilePurpose, type FileCreateParams, type FileListParams, } from "./files.js";
 export { FineTuning } from "./fine-tuning/fine-tuning.js";
+export { Graders } from "./graders/graders.js";
 export { Images, type Image, type ImageModel, type ImagesResponse, type ImageCreateVariationParams, type ImageEditParams, type ImageGenerateParams, } from "./images.js";
 export { ModelsPage, Models, type Model, type ModelDeleted } from "./models.js";
 export { Moderations, type Moderation, type ModerationImageURLInput, type ModerationModel, type ModerationMultiModalInput, type ModerationTextInput, type ModerationCreateResponse, type ModerationCreateParams, } from "./moderations.js";

package/resources/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAEA,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,OAAO,EAAE,KAAK,EAAE,KAAK,UAAU,EAAE,KAAK,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACjF,OAAO,EACL,WAAW,EACX,OAAO,EACP,KAAK,KAAK,EACV,KAAK,UAAU,EACf,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,eAAe,GACrB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACnC,OAAO,EACL,WAAW,EACX,KAAK,UAAU,EACf,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,sBAAsB,EAC3B,KAAK,kCAAkC,EACvC,KAAK,+BAA+B,GACrC,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,UAAU,EACV,KAAK,uBAAuB,EAC5B,KAAK,SAAS,EACd,KAAK,cAAc,EACnB,KAAK,qBAAqB,GAC3B,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,qBAAqB,EACrB,KAAK,EACL,KAAK,0BAA0B,EAC/B,KAAK,oBAAoB,EACzB,KAAK,qCAAqC,EAC1C,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,cAAc,GACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,eAAe,EACf,KAAK,EACL,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,gBAAgB,EACrB,KAAK,cAAc,GACpB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EACL,MAAM,EACN,KAAK,KAAK,EACV,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,0BAA0B,EAC/B,KAAK,eAAe,EACpB,KAAK,mBAAmB,GACzB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,KAAK,EAAE,KAAK,YAAY,EAAE,MAAM,UAAU,CAAC;AAC7E,OAAO,EACL,WAAW,EACX,KAAK,UAAU,EACf,KAAK,uBAAuB,EAC5B,KAAK,eAAe,EACpB,KAAK,yBAAyB,EAC9B,KAAK,mBAAmB,EACxB,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,GAC5B,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,kBAAkB,EAAE,KAAK,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAC7G,OAAO,EACL,gBAAgB,EAChB,8BAA8B,EAC9B,YAAY,EACZ,KAAK,6BAA6B,EAClC,KAAK,oBAAoB,EACzB,KAAK,yBAAyB,EAC9B,KAAK,+BAA+B,EACpC,KAAK,0BAA0B,EAC/B,KAAK,gCAAgC,EACrC,KAAK,qCAAqC,EAC1C,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,GAC7B,MAAM,+BAA+B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAEA,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,OAAO,EAAE,KAAK,EAAE,KAAK,UAAU,EAAE,KAAK,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACjF,OAAO,EACL,WAAW,EACX,OAAO,EACP,KAAK,KAAK,EACV,KAAK,UAAU,EACf,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,eAAe,GACrB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACnC,OAAO,EACL,WAAW,EACX,KAAK,UAAU,EACf,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,sBAAsB,EAC3B,KAAK,kCAAkC,EACvC,KAAK,+BAA+B,GACrC,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,UAAU,EACV,KAAK,uBAAuB,EAC5B,KAAK,SAAS,EACd,KAAK,cAAc,EACnB,KAAK,qBAAqB,GAC3B,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,qBAAqB,EACrB,KAAK,EACL,KAAK,0BAA0B,EAC/B,KAAK,qCAAqC,EAC1C,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,cAAc,GACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,eAAe,EACf,KAAK,EACL,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,gBAAgB,EACrB,KAAK,cAAc,GACpB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EACL,MAAM,EACN,KAAK,KAAK,EACV,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,0BAA0B,EAC/B,KAAK,eAAe,EACpB,KAAK,mBAAmB,GACzB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,KAAK,EAAE,KAAK,YAAY,EAAE,MAAM,UAAU,CAAC;AAC7E,OAAO,EACL,WAAW,EACX,KAAK,UAAU,EACf,KAAK,uBAAuB,EAC5B,KAAK,eAAe,EACpB,KAAK,yBAAyB,EAC9B,KAAK,mBAAmB,EACxB,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,GAC5B,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,kBAAkB,EAAE,KAAK,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAC7G,OAAO,EACL,gBAAgB,EAChB,8BAA8B,EAC9B,YAAY,EACZ,KAAK,6BAA6B,EAClC,KAAK,oBAAoB,EACzB,KAAK,yBAAyB,EAC9B,KAAK,+BAA+B,EACpC,KAAK,0BAA0B,EAC/B,KAAK,gCAAgC,EACrC,KAAK,qCAAqC,EAC1C,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,GAC7B,MAAM,+BAA+B,CAAC"}

package/resources/index.js

@@ -15,7 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VectorStores = exports.VectorStoreSearchResponsesPage = exports.VectorStoresPage = exports.Uploads = exports.Responses = exports.Moderations = exports.Models = exports.ModelsPage = exports.Images = exports.FineTuning = exports.Files = exports.FileObjectsPage = exports.Evals = exports.EvalListResponsesPage = exports.Embeddings = exports.Completions = exports.Beta = exports.Batches = exports.BatchesPage = exports.Audio = void 0;
+exports.VectorStores = exports.VectorStoreSearchResponsesPage = exports.VectorStoresPage = exports.Uploads = exports.Responses = exports.Moderations = exports.Models = exports.ModelsPage = exports.Images = exports.Graders = exports.FineTuning = exports.Files = exports.FileObjectsPage = exports.Evals = exports.EvalListResponsesPage = exports.Embeddings = exports.Completions = exports.Beta = exports.Batches = exports.BatchesPage = exports.Audio = void 0;
 __exportStar(require("./chat/index.js"), exports);
 __exportStar(require("./shared.js"), exports);
 var audio_1 = require("./audio/audio.js");
@@ -37,6 +37,8 @@ Object.defineProperty(exports, "FileObjectsPage", { enumerable: true, get: funct
 Object.defineProperty(exports, "Files", { enumerable: true, get: function () { return files_1.Files; } });
 var fine_tuning_1 = require("./fine-tuning/fine-tuning.js");
 Object.defineProperty(exports, "FineTuning", { enumerable: true, get: function () { return fine_tuning_1.FineTuning; } });
+var graders_1 = require("./graders/graders.js");
+Object.defineProperty(exports, "Graders", { enumerable: true, get: function () { return graders_1.Graders; } });
 var images_1 = require("./images.js");
 Object.defineProperty(exports, "Images", { enumerable: true, get: function () { return images_1.Images; } });
 var models_1 = require("./models.js");

package/resources/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;AAEtF,kDAA6B;AAC7B,8CAAyB;AACzB,0CAAiF;AAAxE,8FAAA,KAAK,OAAA;AACd,wCAQmB;AAPjB,sGAAA,WAAW,OAAA;AACX,kGAAA,OAAO,OAAA;AAOT,uCAAmC;AAA1B,4FAAA,IAAI,OAAA;AACb,gDAQuB;AAPrB,0GAAA,WAAW,OAAA;AAQb,8CAMsB;AALpB,wGAAA,UAAU,OAAA;AAMZ,0CAgBuB;AAfrB,8GAAA,qBAAqB,OAAA;AACrB,8FAAA,KAAK,OAAA;AAeP,oCASiB;AARf,wGAAA,eAAe,OAAA;AACf,8FAAA,KAAK,OAAA;AAQP,4DAAuD;AAA9C,yGAAA,UAAU,OAAA;AACnB,sCAQkB;AAPhB,gGAAA,MAAM,OAAA;AAQR,sCAA6E;AAApE,oGAAA,UAAU,OAAA;AAAE,gGAAA,MAAM,OAAA;AAC3B,gDASuB;AARrB,0GAAA,WAAW,OAAA;AASb,sDAAkD;AAAzC,sGAAA,SAAS,OAAA;AAClB,gDAA6G;AAApG,kGAAA,OAAO,OAAA;AAChB,kEAkBuC;AAjBrC,iHAAA,gBAAgB,OAAA;AAChB,+HAAA,8BAA8B,OAAA;AAC9B,6GAAA,YAAY,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;AAEtF,kDAA6B;AAC7B,8CAAyB;AACzB,0CAAiF;AAAxE,8FAAA,KAAK,OAAA;AACd,wCAQmB;AAPjB,sGAAA,WAAW,OAAA;AACX,kGAAA,OAAO,OAAA;AAOT,uCAAmC;AAA1B,4FAAA,IAAI,OAAA;AACb,gDAQuB;AAPrB,0GAAA,WAAW,OAAA;AAQb,8CAMsB;AALpB,wGAAA,UAAU,OAAA;AAMZ,0CAauB;AAZrB,8GAAA,qBAAqB,OAAA;AACrB,8FAAA,KAAK,OAAA;AAYP,oCASiB;AARf,wGAAA,eAAe,OAAA;AACf,8FAAA,KAAK,OAAA;AAQP,4DAAuD;AAA9C,yGAAA,UAAU,OAAA;AACnB,gDAA4C;AAAnC,kGAAA,OAAO,OAAA;AAChB,sCAQkB;AAPhB,gGAAA,MAAM,OAAA;AAQR,sCAA6E;AAApE,oGAAA,UAAU,OAAA;AAAE,gGAAA,MAAM,OAAA;AAC3B,gDASuB;AARrB,0GAAA,WAAW,OAAA;AASb,sDAAkD;AAAzC,sGAAA,SAAS,OAAA;AAClB,gDAA6G;AAApG,kGAAA,OAAO,OAAA;AAChB,kEAkBuC;AAjBrC,iHAAA,gBAAgB,OAAA;AAChB,+HAAA,8BAA8B,OAAA;AAC9B,6GAAA,YAAY,OAAA"}

package/resources/index.mjs

@@ -9,6 +9,7 @@ export { Embeddings, } from "./embeddings.mjs";
 export { EvalListResponsesPage, Evals, } from "./evals/evals.mjs";
 export { FileObjectsPage, Files, } from "./files.mjs";
 export { FineTuning } from "./fine-tuning/fine-tuning.mjs";
+export { Graders } from "./graders/graders.mjs";
 export { Images, } from "./images.mjs";
 export { ModelsPage, Models } from "./models.mjs";
 export { Moderations, } from "./moderations.mjs";

package/resources/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;;OAI/E,EAAE,KAAK,EAA6C;OACpD,EACL,WAAW,EACX,OAAO,GAMR;OACM,EAAE,IAAI,EAAE;OACR,EACL,WAAW,GAOZ;OACM,EACL,UAAU,GAKX;OACM,EACL,qBAAqB,EACrB,KAAK,GAcN;OACM,EACL,eAAe,EACf,KAAK,GAON;OACM,EAAE,UAAU,EAAE;OACd,EACL,MAAM,GAOP;OACM,EAAE,UAAU,EAAE,MAAM,EAAiC;OACrD,EACL,WAAW,GAQZ;OACM,EAAE,SAAS,EAAE;OACb,EAAE,OAAO,EAAmE;OAC5E,EACL,gBAAgB,EAChB,8BAA8B,EAC9B,YAAY,GAeb"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;;OAI/E,EAAE,KAAK,EAA6C;OACpD,EACL,WAAW,EACX,OAAO,GAMR;OACM,EAAE,IAAI,EAAE;OACR,EACL,WAAW,GAOZ;OACM,EACL,UAAU,GAKX;OACM,EACL,qBAAqB,EACrB,KAAK,GAWN;OACM,EACL,eAAe,EACf,KAAK,GAON;OACM,EAAE,UAAU,EAAE;OACd,EAAE,OAAO,EAAE;OACX,EACL,MAAM,GAOP;OACM,EAAE,UAAU,EAAE,MAAM,EAAiC;OACrD,EACL,WAAW,GAQZ;OACM,EAAE,SAAS,EAAE;OACb,EAAE,OAAO,EAAmE;OAC5E,EACL,gBAAgB,EAChB,8BAA8B,EAC9B,YAAY,GAeb"}

package/resources/responses/input-items.d.ts

@@ -6,6 +6,16 @@ import { type CursorPageParams } from "../../pagination.js";
 export declare class InputItems extends APIResource {
     /**
      * Returns a list of input items for a given response.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const responseItem of client.responses.inputItems.list(
+     *   'response_id',
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     list(responseId: string, query?: InputItemListParams, options?: Core.RequestOptions): Core.PagePromise<ResponseItemsPage, ResponsesAPI.ResponseItem>;
     list(responseId: string, options?: Core.RequestOptions): Core.PagePromise<ResponseItemsPage, ResponsesAPI.ResponseItem>;

package/resources/responses/input-items.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"input-items.d.ts","sourceRoot":"","sources":["../../src/resources/responses/input-items.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,YAAY,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEzD,qBAAa,UAAW,SAAQ,WAAW;IACzC;;OAEG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,YAAY,CAAC,YAAY,CAAC;IACjE,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,YAAY,CAAC,YAAY,CAAC;CAclE;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IAEvC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;IAEjD;;;;;OAKG;IACH,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;CACvG;AAED,OAAO,EAAE,iBAAiB,EAAE,CAAC"}
+{"version":3,"file":"input-items.d.ts","sourceRoot":"","sources":["../../src/resources/responses/input-items.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,YAAY,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEzD,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,YAAY,CAAC,YAAY,CAAC;IACjE,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,YAAY,CAAC,YAAY,CAAC;CAclE;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IAEvC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;IAEjD;;;;;OAKG;IACH,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;CACvG;AAED,OAAO,EAAE,iBAAiB,EAAE,CAAC"}

package/resources/responses/input-items.js.map

@@ -1 +1 @@
-{"version":3,"file":"input-items.js","sourceRoot":"","sources":["../../src/resources/responses/input-items.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAG9C,8CAAgD;AAsFvC,kGAtFA,6BAAiB,OAsFA;AAnF1B,MAAa,UAAW,SAAQ,sBAAW;IAazC,IAAI,CACF,UAAkB,EAClB,QAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,UAAU,cAAc,EAAE,6BAAiB,EAAE;YACxF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA1BD,gCA0BC"}
+{"version":3,"file":"input-items.js","sourceRoot":"","sources":["../../src/resources/responses/input-items.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAG9C,8CAAgD;AAgGvC,kGAhGA,6BAAiB,OAgGA;AA7F1B,MAAa,UAAW,SAAQ,sBAAW;IAuBzC,IAAI,CACF,UAAkB,EAClB,QAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,UAAU,cAAc,EAAE,6BAAiB,EAAE;YACxF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AApCD,gCAoCC"}

package/resources/responses/input-items.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"input-items.mjs","sourceRoot":"","sources":["../../src/resources/responses/input-items.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,EAAE,iBAAiB,EAAE;AAG5B,MAAM,OAAO,UAAW,SAAQ,WAAW;IAazC,IAAI,CACF,UAAkB,EAClB,QAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,UAAU,cAAc,EAAE,iBAAiB,EAAE;YACxF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAyDD,OAAO,EAAE,iBAAiB,EAAE,CAAC"}
+{"version":3,"file":"input-items.mjs","sourceRoot":"","sources":["../../src/resources/responses/input-items.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,EAAE,iBAAiB,EAAE;AAG5B,MAAM,OAAO,UAAW,SAAQ,WAAW;IAuBzC,IAAI,CACF,UAAkB,EAClB,QAAmD,EAAE,EACrD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,UAAU,cAAc,EAAE,iBAAiB,EAAE;YACxF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAyDD,OAAO,EAAE,iBAAiB,EAAE,CAAC"}

package/resources/responses/responses.d.ts

@@ -39,17 +39,39 @@ export declare class Responses extends APIResource {
      * [web search](https://platform.openai.com/docs/guides/tools-web-search) or
      * [file search](https://platform.openai.com/docs/guides/tools-file-search) to use
      * your own data as input for the model's response.
+     *
+     * @example
+     * ```ts
+     * const response = await client.responses.create({
+     *   input: 'string',
+     *   model: 'gpt-4o',
+     * });
+     * ```
      */
     create(body: ResponseCreateParamsNonStreaming, options?: Core.RequestOptions): APIPromise<Response>;
     create(body: ResponseCreateParamsStreaming, options?: Core.RequestOptions): APIPromise<Stream<ResponseStreamEvent>>;
     create(body: ResponseCreateParamsBase, options?: Core.RequestOptions): APIPromise<Stream<ResponseStreamEvent> | Response>;
     /**
      * Retrieves a model response with the given ID.
+     *
+     * @example
+     * ```ts
+     * const response = await client.responses.retrieve(
+     *   'resp_677efb5139a88190b512bc3fef8e535d',
+     * );
+     * ```
      */
     retrieve(responseId: string, query?: ResponseRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<Response>;
     retrieve(responseId: string, options?: Core.RequestOptions): Core.APIPromise<Response>;
     /**
      * Deletes a model response with the given ID.
+     *
+     * @example
+     * ```ts
+     * await client.responses.del(
+     *   'resp_677efb5139a88190b512bc3fef8e535d',
+     * );
+     * ```
      */
     del(responseId: string, options?: Core.RequestOptions): Core.APIPromise<void>;
     parse<Params extends ResponseCreateParamsWithTools, ParsedT = ExtractParsedContentFromParams<Params>>(body: Params, options?: Core.RequestOptions): Core.APIPromise<ParsedResponse<ParsedT>>;
@@ -76,7 +98,7 @@ export interface ComputerTool {
     /**
      * The type of computer environment to control.
      */
-    environment: 'mac' | 'windows' | 'ubuntu' | 'browser';
+    environment: 'windows' | 'mac' | 'linux' | 'ubuntu' | 'browser';
     /**
      * The type of the computer use tool. Always `computer_use_preview`.
      */
@@ -120,9 +142,9 @@ export interface FileSearchTool {
      */
     vector_store_ids: Array<string>;
     /**
-     * A filter to apply based on file attributes.
+     * A filter to apply.
      */
-    filters?: Shared.ComparisonFilter | Shared.CompoundFilter;
+    filters?: Shared.ComparisonFilter | Shared.CompoundFilter | null;
     /**
      * The maximum number of results to return. This number should be between 1 and 50
      * inclusive.
@@ -163,11 +185,11 @@ export interface FunctionTool {
     /**
      * A JSON schema object describing the parameters of the function.
      */
-    parameters: Record<string, unknown>;
+    parameters: Record<string, unknown> | null;
     /**
      * Whether to enforce strict parameter validation. Default `true`.
      */
-    strict: boolean;
+    strict: boolean | null;
     /**
      * The type of the function tool. Always `function`.
      */
@@ -1271,8 +1293,13 @@ export interface ResponseInProgressEvent {
  * - `message.input_image.image_url`: Include image urls from the input message.
  * - `computer_call_output.output.image_url`: Include image urls from the computer
  *   call output.
+ * - `reasoning.encrypted_content`: Includes an encrypted version of reasoning
+ *   tokens in reasoning item outputs. This enables reasoning items to be used in
+ *   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).
  */
-export type ResponseIncludable = 'file_search_call.results' | 'message.input_image.image_url' | 'computer_call_output.output.image_url';
+export type ResponseIncludable = 'file_search_call.results' | 'message.input_image.image_url' | 'computer_call_output.output.image_url' | 'reasoning.encrypted_content';
 /**
  * An event that is emitted when a response finishes as incomplete.
  */
@@ -1327,7 +1354,7 @@ export interface ResponseInputFile {
     /**
      * The ID of the file to be sent to the model.
      */
-    file_id?: string;
+    file_id?: string | null;
     /**
      * The name of the file to be sent to the model.
      */
@@ -1342,7 +1369,7 @@ export interface ResponseInputImage {
      * The detail level of the image to be sent to the model. One of `high`, `low`, or
      * `auto`. Defaults to `auto`.
      */
-    detail: 'high' | 'low' | 'auto';
+    detail: 'low' | 'high' | 'auto';
     /**
      * The type of the input item. Always `input_image`.
      */
@@ -1410,17 +1437,17 @@ export declare namespace ResponseInputItem {
         /**
          * The ID of the computer tool call output.
          */
-        id?: string;
+        id?: string | null;
         /**
          * The safety checks reported by the API that have been acknowledged by the
          * developer.
          */
-        acknowledged_safety_checks?: Array<ComputerCallOutput.AcknowledgedSafetyCheck>;
+        acknowledged_safety_checks?: Array<ComputerCallOutput.AcknowledgedSafetyCheck> | null;
         /**
          * The status of the message input. One of `in_progress`, `completed`, or
          * `incomplete`. Populated when input items are returned via API.
          */
-        status?: 'in_progress' | 'completed' | 'incomplete';
+        status?: 'in_progress' | 'completed' | 'incomplete' | null;
     }
     namespace ComputerCallOutput {
         /**
@@ -1434,11 +1461,11 @@ export declare namespace ResponseInputItem {
             /**
              * The type of the pending safety check.
              */
-            code: string;
+            code?: string | null;
             /**
              * Details about the pending safety check.
              */
-            message: string;
+            message?: string | null;
         }
     }
     /**
@@ -1461,12 +1488,12 @@ export declare namespace ResponseInputItem {
          * The unique ID of the function tool call output. Populated when this item is
          * returned via API.
          */
-        id?: string;
+        id?: string | null;
         /**
          * The status of the item. One of `in_progress`, `completed`, or `incomplete`.
          * Populated when items are returned via API.
          */
-        status?: 'in_progress' | 'completed' | 'incomplete';
+        status?: 'in_progress' | 'completed' | 'incomplete' | null;
     }
     /**
      * An internal identifier for an item to reference.
@@ -1479,7 +1506,7 @@ export declare namespace ResponseInputItem {
         /**
          * The type of item to reference. Always `item_reference`.
          */
-        type: 'item_reference';
+        type?: 'item_reference' | null;
     }
 }
 /**
@@ -1702,7 +1729,9 @@ export declare namespace ResponseOutputText {
 }
 /**
  * A description of the chain of thought used by a reasoning model while generating
- * a response.
+ * a response. Be sure to include these items in your `input` to the Responses API
+ * for subsequent turns of a conversation if you are manually
+ * [managing context](https://platform.openai.com/docs/guides/conversation-state).
  */
 export interface ResponseReasoningItem {
     /**
@@ -1717,6 +1746,11 @@ export interface ResponseReasoningItem {
      * The type of the object. Always `reasoning`.
      */
     type: 'reasoning';
+    /**
+     * The encrypted content of the reasoning item - populated when a response is
+     * generated with `reasoning.encrypted_content` in the `include` parameter.
+     */
+    encrypted_content?: string | null;
     /**
      * The status of the item. One of `in_progress`, `completed`, or `incomplete`.
      * Populated when items are returned via API.
@@ -2188,11 +2222,9 @@ export interface ResponseWebSearchCallSearchingEvent {
     type: 'response.web_search_call.searching';
 }
 /**
- * A tool that searches for relevant content from uploaded files. Learn more about
- * the
- * [file search tool](https://platform.openai.com/docs/guides/tools-file-search).
+ * A tool that can be used to generate a response.
  */
-export type Tool = FileSearchTool | FunctionTool | ComputerTool | WebSearchTool;
+export type Tool = FileSearchTool | FunctionTool | WebSearchTool | ComputerTool;
 /**
  * Use this option to force the model to call a specific function.
  */
@@ -2241,10 +2273,8 @@ export interface ToolChoiceTypes {
  */
 export interface WebSearchTool {
     /**
-     * The type of the web search tool. One of:
-     *
-     * - `web_search_preview`
-     * - `web_search_preview_2025_03_11`
+     * The type of the web search tool. One of `web_search_preview` or
+     * `web_search_preview_2025_03_11`.
      */
     type: 'web_search_preview' | 'web_search_preview_2025_03_11';
     /**
@@ -2252,9 +2282,15 @@ export interface WebSearchTool {
      * search. One of `low`, `medium`, or `high`. `medium` is the default.
      */
     search_context_size?: 'low' | 'medium' | 'high';
+    /**
+     * The user's location.
+     */
     user_location?: WebSearchTool.UserLocation | null;
 }
 export declare namespace WebSearchTool {
+    /**
+     * The user's location.
+     */
     interface UserLocation {
         /**
          * The type of location approximation. Always `approximate`.
@@ -2263,21 +2299,21 @@ export declare namespace WebSearchTool {
         /**
          * Free text input for the city of the user, e.g. `San Francisco`.
          */
-        city?: string;
+        city?: string | null;
         /**
          * The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of
          * the user, e.g. `US`.
          */
-        country?: string;
+        country?: string | null;
         /**
          * Free text input for the region of the user, e.g. `California`.
          */
-        region?: string;
+        region?: string | null;
         /**
          * The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the
          * user, e.g. `America/Los_Angeles`.
          */
-        timezone?: string;
+        timezone?: string | null;
     }
 }
 export type ResponseCreateParams = ResponseCreateParamsNonStreaming | ResponseCreateParamsStreaming;
@@ -2311,6 +2347,11 @@ export interface ResponseCreateParamsBase {
      * - `message.input_image.image_url`: Include image urls from the input message.
      * - `computer_call_output.output.image_url`: Include image urls from the computer
      *   call output.
+     * - `reasoning.encrypted_content`: Includes an encrypted version of reasoning
+     *   tokens in reasoning item outputs. This enables reasoning items to be used in
+     *   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).
      */
     include?: Array<ResponseIncludable> | null;
     /**