openai 4.8.0 → 4.9.0

package/resources/images.d.ts

@@ -1,139 +1,136 @@
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
-import * as API from './index.js';
+import * as API from "./index.js";
 import { type Uploadable } from 'openai/core';
 export declare class Images extends APIResource {
-  /**
-   * Creates a variation of a given image.
-   */
-  createVariation(
-    body: ImageCreateVariationParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ImagesResponse>;
-  /**
-   * Creates an edited or extended image given an original image and a prompt.
-   */
-  edit(body: ImageEditParams, options?: Core.RequestOptions): Core.APIPromise<ImagesResponse>;
-  /**
-   * Creates an image given a prompt.
-   */
-  generate(body: ImageGenerateParams, options?: Core.RequestOptions): Core.APIPromise<ImagesResponse>;
+    /**
+     * Creates a variation of a given image.
+     */
+    createVariation(body: ImageCreateVariationParams, options?: Core.RequestOptions): Core.APIPromise<ImagesResponse>;
+    /**
+     * Creates an edited or extended image given an original image and a prompt.
+     */
+    edit(body: ImageEditParams, options?: Core.RequestOptions): Core.APIPromise<ImagesResponse>;
+    /**
+     * Creates an image given a prompt.
+     */
+    generate(body: ImageGenerateParams, options?: Core.RequestOptions): Core.APIPromise<ImagesResponse>;
 }
 /**
  * Represents the url or the content of an image generated by the OpenAI API.
  */
 export interface Image {
-  /**
-   * The base64-encoded JSON of the generated image, if `response_format` is
-   * `b64_json`.
-   */
-  b64_json?: string;
-  /**
-   * The URL of the generated image, if `response_format` is `url` (default).
-   */
-  url?: string;
+    /**
+     * The base64-encoded JSON of the generated image, if `response_format` is
+     * `b64_json`.
+     */
+    b64_json?: string;
+    /**
+     * The URL of the generated image, if `response_format` is `url` (default).
+     */
+    url?: string;
 }
 export interface ImagesResponse {
-  created: number;
-  data: Array<Image>;
+    created: number;
+    data: Array<Image>;
 }
 export interface ImageCreateVariationParams {
-  /**
-   * The image to use as the basis for the variation(s). Must be a valid PNG file,
-   * less than 4MB, and square.
-   */
-  image: Uploadable;
-  /**
-   * The number of images to generate. Must be between 1 and 10.
-   */
-  n?: number | null;
-  /**
-   * The format in which the generated images are returned. Must be one of `url` or
-   * `b64_json`.
-   */
-  response_format?: 'url' | 'b64_json' | null;
-  /**
-   * The size of the generated images. Must be one of `256x256`, `512x512`, or
-   * `1024x1024`.
-   */
-  size?: '256x256' | '512x512' | '1024x1024' | null;
-  /**
-   * A unique identifier representing your end-user, which can help OpenAI to monitor
-   * and detect abuse.
-   * [Learn more](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids).
-   */
-  user?: string;
+    /**
+     * The image to use as the basis for the variation(s). Must be a valid PNG file,
+     * less than 4MB, and square.
+     */
+    image: Uploadable;
+    /**
+     * The number of images to generate. Must be between 1 and 10.
+     */
+    n?: number | null;
+    /**
+     * The format in which the generated images are returned. Must be one of `url` or
+     * `b64_json`.
+     */
+    response_format?: 'url' | 'b64_json' | null;
+    /**
+     * The size of the generated images. Must be one of `256x256`, `512x512`, or
+     * `1024x1024`.
+     */
+    size?: '256x256' | '512x512' | '1024x1024' | null;
+    /**
+     * A unique identifier representing your end-user, which can help OpenAI to monitor
+     * and detect abuse.
+     * [Learn more](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids).
+     */
+    user?: string;
 }
 export interface ImageEditParams {
-  /**
-   * The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask
-   * is not provided, image must have transparency, which will be used as the mask.
-   */
-  image: Uploadable;
-  /**
-   * A text description of the desired image(s). The maximum length is 1000
-   * characters.
-   */
-  prompt: string;
-  /**
-   * An additional image whose fully transparent areas (e.g. where alpha is zero)
-   * indicate where `image` should be edited. Must be a valid PNG file, less than
-   * 4MB, and have the same dimensions as `image`.
-   */
-  mask?: Uploadable;
-  /**
-   * The number of images to generate. Must be between 1 and 10.
-   */
-  n?: number | null;
-  /**
-   * The format in which the generated images are returned. Must be one of `url` or
-   * `b64_json`.
-   */
-  response_format?: 'url' | 'b64_json' | null;
-  /**
-   * The size of the generated images. Must be one of `256x256`, `512x512`, or
-   * `1024x1024`.
-   */
-  size?: '256x256' | '512x512' | '1024x1024' | null;
-  /**
-   * A unique identifier representing your end-user, which can help OpenAI to monitor
-   * and detect abuse.
-   * [Learn more](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids).
-   */
-  user?: string;
+    /**
+     * The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask
+     * is not provided, image must have transparency, which will be used as the mask.
+     */
+    image: Uploadable;
+    /**
+     * A text description of the desired image(s). The maximum length is 1000
+     * characters.
+     */
+    prompt: string;
+    /**
+     * An additional image whose fully transparent areas (e.g. where alpha is zero)
+     * indicate where `image` should be edited. Must be a valid PNG file, less than
+     * 4MB, and have the same dimensions as `image`.
+     */
+    mask?: Uploadable;
+    /**
+     * The number of images to generate. Must be between 1 and 10.
+     */
+    n?: number | null;
+    /**
+     * The format in which the generated images are returned. Must be one of `url` or
+     * `b64_json`.
+     */
+    response_format?: 'url' | 'b64_json' | null;
+    /**
+     * The size of the generated images. Must be one of `256x256`, `512x512`, or
+     * `1024x1024`.
+     */
+    size?: '256x256' | '512x512' | '1024x1024' | null;
+    /**
+     * A unique identifier representing your end-user, which can help OpenAI to monitor
+     * and detect abuse.
+     * [Learn more](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids).
+     */
+    user?: string;
 }
 export interface ImageGenerateParams {
-  /**
-   * A text description of the desired image(s). The maximum length is 1000
-   * characters.
-   */
-  prompt: string;
-  /**
-   * The number of images to generate. Must be between 1 and 10.
-   */
-  n?: number | null;
-  /**
-   * The format in which the generated images are returned. Must be one of `url` or
-   * `b64_json`.
-   */
-  response_format?: 'url' | 'b64_json' | null;
-  /**
-   * The size of the generated images. Must be one of `256x256`, `512x512`, or
-   * `1024x1024`.
-   */
-  size?: '256x256' | '512x512' | '1024x1024' | null;
-  /**
-   * A unique identifier representing your end-user, which can help OpenAI to monitor
-   * and detect abuse.
-   * [Learn more](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids).
-   */
-  user?: string;
+    /**
+     * A text description of the desired image(s). The maximum length is 1000
+     * characters.
+     */
+    prompt: string;
+    /**
+     * The number of images to generate. Must be between 1 and 10.
+     */
+    n?: number | null;
+    /**
+     * The format in which the generated images are returned. Must be one of `url` or
+     * `b64_json`.
+     */
+    response_format?: 'url' | 'b64_json' | null;
+    /**
+     * The size of the generated images. Must be one of `256x256`, `512x512`, or
+     * `1024x1024`.
+     */
+    size?: '256x256' | '512x512' | '1024x1024' | null;
+    /**
+     * A unique identifier representing your end-user, which can help OpenAI to monitor
+     * and detect abuse.
+     * [Learn more](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids).
+     */
+    user?: string;
 }
 export declare namespace Images {
-  export import Image = API.Image;
-  export import ImagesResponse = API.ImagesResponse;
-  export import ImageCreateVariationParams = API.ImageCreateVariationParams;
-  export import ImageEditParams = API.ImageEditParams;
-  export import ImageGenerateParams = API.ImageGenerateParams;
+    export import Image = API.Image;
+    export import ImagesResponse = API.ImagesResponse;
+    export import ImageCreateVariationParams = API.ImageCreateVariationParams;
+    export import ImageEditParams = API.ImageEditParams;
+    export import ImageGenerateParams = API.ImageGenerateParams;
 }
-//# sourceMappingURL=images.d.ts.map
+//# sourceMappingURL=images.d.ts.map

package/resources/images.js

@@ -1,29 +1,30 @@
-'use strict';
+"use strict";
 // File generated from our OpenAPI spec by Stainless.
-Object.defineProperty(exports, '__esModule', { value: true });
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.Images = void 0;
-const resource_1 = require('openai/resource');
-const core_1 = require('openai/core');
+const resource_1 = require("openai/resource");
+const core_1 = require("openai/core");
 class Images extends resource_1.APIResource {
-  /**
-   * Creates a variation of a given image.
-   */
-  createVariation(body, options) {
-    return this.post('/images/variations', (0, core_1.multipartFormRequestOptions)({ body, ...options }));
-  }
-  /**
-   * Creates an edited or extended image given an original image and a prompt.
-   */
-  edit(body, options) {
-    return this.post('/images/edits', (0, core_1.multipartFormRequestOptions)({ body, ...options }));
-  }
-  /**
-   * Creates an image given a prompt.
-   */
-  generate(body, options) {
-    return this.post('/images/generations', { body, ...options });
-  }
+    /**
+     * Creates a variation of a given image.
+     */
+    createVariation(body, options) {
+        return this.post('/images/variations', (0, core_1.multipartFormRequestOptions)({ body, ...options }));
+    }
+    /**
+     * Creates an edited or extended image given an original image and a prompt.
+     */
+    edit(body, options) {
+        return this.post('/images/edits', (0, core_1.multipartFormRequestOptions)({ body, ...options }));
+    }
+    /**
+     * Creates an image given a prompt.
+     */
+    generate(body, options) {
+        return this.post('/images/generations', { body, ...options });
+    }
 }
 exports.Images = Images;
-(function (Images) {})((Images = exports.Images || (exports.Images = {})));
-//# sourceMappingURL=images.js.map
+(function (Images) {
+})(Images = exports.Images || (exports.Images = {}));
+//# sourceMappingURL=images.js.map

package/resources/images.mjs

@@ -2,24 +2,25 @@
 import { APIResource } from 'openai/resource';
 import { multipartFormRequestOptions } from 'openai/core';
 export class Images extends APIResource {
-  /**
-   * Creates a variation of a given image.
-   */
-  createVariation(body, options) {
-    return this.post('/images/variations', multipartFormRequestOptions({ body, ...options }));
-  }
-  /**
-   * Creates an edited or extended image given an original image and a prompt.
-   */
-  edit(body, options) {
-    return this.post('/images/edits', multipartFormRequestOptions({ body, ...options }));
-  }
-  /**
-   * Creates an image given a prompt.
-   */
-  generate(body, options) {
-    return this.post('/images/generations', { body, ...options });
-  }
+    /**
+     * Creates a variation of a given image.
+     */
+    createVariation(body, options) {
+        return this.post('/images/variations', multipartFormRequestOptions({ body, ...options }));
+    }
+    /**
+     * Creates an edited or extended image given an original image and a prompt.
+     */
+    edit(body, options) {
+        return this.post('/images/edits', multipartFormRequestOptions({ body, ...options }));
+    }
+    /**
+     * Creates an image given a prompt.
+     */
+    generate(body, options) {
+        return this.post('/images/generations', { body, ...options });
+    }
 }
-(function (Images) {})(Images || (Images = {}));
-//# sourceMappingURL=images.mjs.map
+(function (Images) {
+})(Images || (Images = {}));
+//# sourceMappingURL=images.mjs.map

package/resources/index.d.ts

@@ -1,37 +1,12 @@
-export { Audio } from './audio/audio.js';
-export { Chat } from './chat/chat.js';
-export {
-  Completion,
-  CompletionChoice,
-  CompletionUsage,
-  CompletionCreateParams,
-  CompletionCreateParamsNonStreaming,
-  CompletionCreateParamsStreaming,
-  Completions,
-} from './completions.js';
-export { CreateEmbeddingResponse, Embedding, EmbeddingCreateParams, Embeddings } from './embeddings.js';
-export { Edit, EditCreateParams, Edits } from './edits.js';
-export { FileContent, FileDeleted, FileObject, FileCreateParams, FileObjectsPage, Files } from './files.js';
-export {
-  FineTune,
-  FineTuneEvent,
-  FineTuneEventsListResponse,
-  FineTuneCreateParams,
-  FineTuneListEventsParams,
-  FineTuneListEventsParamsNonStreaming,
-  FineTuneListEventsParamsStreaming,
-  FineTunesPage,
-  FineTunes,
-} from './fine-tunes.js';
-export { FineTuning } from './fine-tuning/fine-tuning.js';
-export {
-  Image,
-  ImagesResponse,
-  ImageCreateVariationParams,
-  ImageEditParams,
-  ImageGenerateParams,
-  Images,
-} from './images.js';
-export { Model, ModelDeleted, ModelsPage, Models } from './models.js';
-export { Moderation, ModerationCreateResponse, ModerationCreateParams, Moderations } from './moderations.js';
-//# sourceMappingURL=index.d.ts.map
+export { Audio } from "./audio/audio.js";
+export { Chat } from "./chat/chat.js";
+export { Completion, CompletionChoice, CompletionUsage, CompletionCreateParams, CompletionCreateParamsNonStreaming, CompletionCreateParamsStreaming, Completions, } from "./completions.js";
+export { CreateEmbeddingResponse, Embedding, EmbeddingCreateParams, Embeddings } from "./embeddings.js";
+export { Edit, EditCreateParams, Edits } from "./edits.js";
+export { FileContent, FileDeleted, FileObject, FileCreateParams, FileObjectsPage, Files } from "./files.js";
+export { FineTune, FineTuneEvent, FineTuneEventsListResponse, FineTuneCreateParams, FineTuneListEventsParams, FineTuneListEventsParamsNonStreaming, FineTuneListEventsParamsStreaming, FineTunesPage, FineTunes, } from "./fine-tunes.js";
+export { FineTuning } from "./fine-tuning/fine-tuning.js";
+export { Image, ImagesResponse, ImageCreateVariationParams, ImageEditParams, ImageGenerateParams, Images, } from "./images.js";
+export { Model, ModelDeleted, ModelsPage, Models } from "./models.js";
+export { Moderation, ModerationCreateResponse, ModerationCreateParams, Moderations } from "./moderations.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/index.js

@@ -1,114 +1,30 @@
-'use strict';
+"use strict";
 // File generated from our OpenAPI spec by Stainless.
-Object.defineProperty(exports, '__esModule', { value: true });
-exports.Moderations =
-  exports.Models =
-  exports.ModelsPage =
-  exports.Images =
-  exports.FineTuning =
-  exports.FineTunes =
-  exports.FineTunesPage =
-  exports.Files =
-  exports.FileObjectsPage =
-  exports.Edits =
-  exports.Embeddings =
-  exports.Completions =
-  exports.Chat =
-  exports.Audio =
-    void 0;
-var audio_1 = require('./audio/audio.js');
-Object.defineProperty(exports, 'Audio', {
-  enumerable: true,
-  get: function () {
-    return audio_1.Audio;
-  },
-});
-var chat_1 = require('./chat/chat.js');
-Object.defineProperty(exports, 'Chat', {
-  enumerable: true,
-  get: function () {
-    return chat_1.Chat;
-  },
-});
-var completions_1 = require('./completions.js');
-Object.defineProperty(exports, 'Completions', {
-  enumerable: true,
-  get: function () {
-    return completions_1.Completions;
-  },
-});
-var embeddings_1 = require('./embeddings.js');
-Object.defineProperty(exports, 'Embeddings', {
-  enumerable: true,
-  get: function () {
-    return embeddings_1.Embeddings;
-  },
-});
-var edits_1 = require('./edits.js');
-Object.defineProperty(exports, 'Edits', {
-  enumerable: true,
-  get: function () {
-    return edits_1.Edits;
-  },
-});
-var files_1 = require('./files.js');
-Object.defineProperty(exports, 'FileObjectsPage', {
-  enumerable: true,
-  get: function () {
-    return files_1.FileObjectsPage;
-  },
-});
-Object.defineProperty(exports, 'Files', {
-  enumerable: true,
-  get: function () {
-    return files_1.Files;
-  },
-});
-var fine_tunes_1 = require('./fine-tunes.js');
-Object.defineProperty(exports, 'FineTunesPage', {
-  enumerable: true,
-  get: function () {
-    return fine_tunes_1.FineTunesPage;
-  },
-});
-Object.defineProperty(exports, 'FineTunes', {
-  enumerable: true,
-  get: function () {
-    return fine_tunes_1.FineTunes;
-  },
-});
-var fine_tuning_1 = require('./fine-tuning/fine-tuning.js');
-Object.defineProperty(exports, 'FineTuning', {
-  enumerable: true,
-  get: function () {
-    return fine_tuning_1.FineTuning;
-  },
-});
-var images_1 = require('./images.js');
-Object.defineProperty(exports, 'Images', {
-  enumerable: true,
-  get: function () {
-    return images_1.Images;
-  },
-});
-var models_1 = require('./models.js');
-Object.defineProperty(exports, 'ModelsPage', {
-  enumerable: true,
-  get: function () {
-    return models_1.ModelsPage;
-  },
-});
-Object.defineProperty(exports, 'Models', {
-  enumerable: true,
-  get: function () {
-    return models_1.Models;
-  },
-});
-var moderations_1 = require('./moderations.js');
-Object.defineProperty(exports, 'Moderations', {
-  enumerable: true,
-  get: function () {
-    return moderations_1.Moderations;
-  },
-});
-//# sourceMappingURL=index.js.map
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Moderations = exports.Models = exports.ModelsPage = exports.Images = exports.FineTuning = exports.FineTunes = exports.FineTunesPage = exports.Files = exports.FileObjectsPage = exports.Edits = exports.Embeddings = exports.Completions = exports.Chat = exports.Audio = void 0;
+var audio_1 = require("./audio/audio.js");
+Object.defineProperty(exports, "Audio", { enumerable: true, get: function () { return audio_1.Audio; } });
+var chat_1 = require("./chat/chat.js");
+Object.defineProperty(exports, "Chat", { enumerable: true, get: function () { return chat_1.Chat; } });
+var completions_1 = require("./completions.js");
+Object.defineProperty(exports, "Completions", { enumerable: true, get: function () { return completions_1.Completions; } });
+var embeddings_1 = require("./embeddings.js");
+Object.defineProperty(exports, "Embeddings", { enumerable: true, get: function () { return embeddings_1.Embeddings; } });
+var edits_1 = require("./edits.js");
+Object.defineProperty(exports, "Edits", { enumerable: true, get: function () { return edits_1.Edits; } });
+var files_1 = require("./files.js");
+Object.defineProperty(exports, "FileObjectsPage", { enumerable: true, get: function () { return files_1.FileObjectsPage; } });
+Object.defineProperty(exports, "Files", { enumerable: true, get: function () { return files_1.Files; } });
+var fine_tunes_1 = require("./fine-tunes.js");
+Object.defineProperty(exports, "FineTunesPage", { enumerable: true, get: function () { return fine_tunes_1.FineTunesPage; } });
+Object.defineProperty(exports, "FineTunes", { enumerable: true, get: function () { return fine_tunes_1.FineTunes; } });
+var fine_tuning_1 = require("./fine-tuning/fine-tuning.js");
+Object.defineProperty(exports, "FineTuning", { enumerable: true, get: function () { return fine_tuning_1.FineTuning; } });
+var images_1 = require("./images.js");
+Object.defineProperty(exports, "Images", { enumerable: true, get: function () { return images_1.Images; } });
+var models_1 = require("./models.js");
+Object.defineProperty(exports, "ModelsPage", { enumerable: true, get: function () { return models_1.ModelsPage; } });
+Object.defineProperty(exports, "Models", { enumerable: true, get: function () { return models_1.Models; } });
+var moderations_1 = require("./moderations.js");
+Object.defineProperty(exports, "Moderations", { enumerable: true, get: function () { return moderations_1.Moderations; } });
+//# sourceMappingURL=index.js.map

package/resources/index.mjs

@@ -1,13 +1,13 @@
 // File generated from our OpenAPI spec by Stainless.
-export { Audio } from './audio/audio.mjs';
-export { Chat } from './chat/chat.mjs';
-export { Completions } from './completions.mjs';
-export { Embeddings } from './embeddings.mjs';
-export { Edits } from './edits.mjs';
-export { FileObjectsPage, Files } from './files.mjs';
-export { FineTunesPage, FineTunes } from './fine-tunes.mjs';
-export { FineTuning } from './fine-tuning/fine-tuning.mjs';
-export { Images } from './images.mjs';
-export { ModelsPage, Models } from './models.mjs';
-export { Moderations } from './moderations.mjs';
-//# sourceMappingURL=index.mjs.map
+export { Audio } from "./audio/audio.mjs";
+export { Chat } from "./chat/chat.mjs";
+export { Completions, } from "./completions.mjs";
+export { Embeddings } from "./embeddings.mjs";
+export { Edits } from "./edits.mjs";
+export { FileObjectsPage, Files } from "./files.mjs";
+export { FineTunesPage, FineTunes, } from "./fine-tunes.mjs";
+export { FineTuning } from "./fine-tuning/fine-tuning.mjs";
+export { Images, } from "./images.mjs";
+export { ModelsPage, Models } from "./models.mjs";
+export { Moderations } from "./moderations.mjs";
+//# sourceMappingURL=index.mjs.map