openai 4.8.0 → 4.9.0

package/resources/completions.mjs

@@ -1,14 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 import { APIResource } from 'openai/resource';
 export class Completions extends APIResource {
-  create(body, options) {
-    var _a;
-    return this.post('/completions', {
-      body,
-      ...options,
-      stream: (_a = body.stream) !== null && _a !== void 0 ? _a : false,
-    });
-  }
+    create(body, options) {
+        var _a;
+        return this.post('/completions', { body, ...options, stream: (_a = body.stream) !== null && _a !== void 0 ? _a : false });
+    }
 }
-(function (Completions) {})(Completions || (Completions = {}));
-//# sourceMappingURL=completions.mjs.map
+(function (Completions) {
+})(Completions || (Completions = {}));
+//# sourceMappingURL=completions.mjs.map

package/resources/edits.d.ts

@@ -1,90 +1,90 @@
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
 import * as Completions from 'openai/resources/completions';
-import * as API from './index.js';
+import * as API from "./index.js";
 export declare class Edits extends APIResource {
-  /**
-   * Creates a new edit for the provided input, instruction, and parameters.
-   *
-   * @deprecated The Edits API is deprecated; please use Chat Completions instead.
-   *
-   * https://openai.com/blog/gpt-4-api-general-availability#deprecation-of-the-edits-api
-   */
-  create(body: EditCreateParams, options?: Core.RequestOptions): Core.APIPromise<Edit>;
+    /**
+     * Creates a new edit for the provided input, instruction, and parameters.
+     *
+     * @deprecated The Edits API is deprecated; please use Chat Completions instead.
+     *
+     * https://openai.com/blog/gpt-4-api-general-availability#deprecation-of-the-edits-api
+     */
+    create(body: EditCreateParams, options?: Core.RequestOptions): Core.APIPromise<Edit>;
 }
 export interface Edit {
-  /**
-   * A list of edit choices. Can be more than one if `n` is greater than 1.
-   */
-  choices: Array<Edit.Choice>;
-  /**
-   * The Unix timestamp (in seconds) of when the edit was created.
-   */
-  created: number;
-  /**
-   * The object type, which is always `edit`.
-   */
-  object: string;
-  /**
-   * Usage statistics for the completion request.
-   */
-  usage: Completions.CompletionUsage;
-}
-export declare namespace Edit {
-  interface Choice {
     /**
-     * The reason the model stopped generating tokens. This will be `stop` if the model
-     * hit a natural stop point or a provided stop sequence, or `length` if the maximum
-     * number of tokens specified in the request was reached.
+     * A list of edit choices. Can be more than one if `n` is greater than 1.
+     */
+    choices: Array<Edit.Choice>;
+    /**
+     * The Unix timestamp (in seconds) of when the edit was created.
      */
-    finish_reason: 'stop' | 'length';
+    created: number;
     /**
-     * The index of the choice in the list of choices.
+     * The object type, which is always `edit`.
      */
-    index: number;
+    object: string;
     /**
-     * The edited result.
+     * Usage statistics for the completion request.
      */
-    text: string;
-  }
+    usage: Completions.CompletionUsage;
+}
+export declare namespace Edit {
+    interface Choice {
+        /**
+         * The reason the model stopped generating tokens. This will be `stop` if the model
+         * hit a natural stop point or a provided stop sequence, or `length` if the maximum
+         * number of tokens specified in the request was reached.
+         */
+        finish_reason: 'stop' | 'length';
+        /**
+         * The index of the choice in the list of choices.
+         */
+        index: number;
+        /**
+         * The edited result.
+         */
+        text: string;
+    }
 }
 export interface EditCreateParams {
-  /**
-   * The instruction that tells the model how to edit the prompt.
-   */
-  instruction: string;
-  /**
-   * ID of the model to use. You can use the `text-davinci-edit-001` or
-   * `code-davinci-edit-001` model with this endpoint.
-   */
-  model: (string & {}) | 'text-davinci-edit-001' | 'code-davinci-edit-001';
-  /**
-   * The input text to use as a starting point for the edit.
-   */
-  input?: string | null;
-  /**
-   * How many edits to generate for the input and instruction.
-   */
-  n?: number | null;
-  /**
-   * What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
-   * make the output more random, while lower values like 0.2 will make it more
-   * focused and deterministic.
-   *
-   * We generally recommend altering this or `top_p` but not both.
-   */
-  temperature?: number | null;
-  /**
-   * An alternative to sampling with temperature, called nucleus sampling, where the
-   * model considers the results of the tokens with top_p probability mass. So 0.1
-   * means only the tokens comprising the top 10% probability mass are considered.
-   *
-   * We generally recommend altering this or `temperature` but not both.
-   */
-  top_p?: number | null;
+    /**
+     * The instruction that tells the model how to edit the prompt.
+     */
+    instruction: string;
+    /**
+     * ID of the model to use. You can use the `text-davinci-edit-001` or
+     * `code-davinci-edit-001` model with this endpoint.
+     */
+    model: (string & {}) | 'text-davinci-edit-001' | 'code-davinci-edit-001';
+    /**
+     * The input text to use as a starting point for the edit.
+     */
+    input?: string | null;
+    /**
+     * How many edits to generate for the input and instruction.
+     */
+    n?: number | null;
+    /**
+     * What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
+     * make the output more random, while lower values like 0.2 will make it more
+     * focused and deterministic.
+     *
+     * We generally recommend altering this or `top_p` but not both.
+     */
+    temperature?: number | null;
+    /**
+     * An alternative to sampling with temperature, called nucleus sampling, where the
+     * model considers the results of the tokens with top_p probability mass. So 0.1
+     * means only the tokens comprising the top 10% probability mass are considered.
+     *
+     * We generally recommend altering this or `temperature` but not both.
+     */
+    top_p?: number | null;
 }
 export declare namespace Edits {
-  export import Edit = API.Edit;
-  export import EditCreateParams = API.EditCreateParams;
+    export import Edit = API.Edit;
+    export import EditCreateParams = API.EditCreateParams;
 }
-//# sourceMappingURL=edits.d.ts.map
+//# sourceMappingURL=edits.d.ts.map

package/resources/edits.js

@@ -1,20 +1,21 @@
-'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.Edits = void 0;
-const resource_1 = require('openai/resource');
+const resource_1 = require("openai/resource");
 class Edits extends resource_1.APIResource {
-  /**
-   * Creates a new edit for the provided input, instruction, and parameters.
-   *
-   * @deprecated The Edits API is deprecated; please use Chat Completions instead.
-   *
-   * https://openai.com/blog/gpt-4-api-general-availability#deprecation-of-the-edits-api
-   */
-  create(body, options) {
-    return this.post('/edits', { body, ...options });
-  }
+    /**
+     * Creates a new edit for the provided input, instruction, and parameters.
+     *
+     * @deprecated The Edits API is deprecated; please use Chat Completions instead.
+     *
+     * https://openai.com/blog/gpt-4-api-general-availability#deprecation-of-the-edits-api
+     */
+    create(body, options) {
+        return this.post('/edits', { body, ...options });
+    }
 }
 exports.Edits = Edits;
-(function (Edits) {})((Edits = exports.Edits || (exports.Edits = {})));
-//# sourceMappingURL=edits.js.map
+(function (Edits) {
+})(Edits = exports.Edits || (exports.Edits = {}));
+//# sourceMappingURL=edits.js.map

package/resources/edits.mjs

@@ -1,16 +1,17 @@
 // File generated from our OpenAPI spec by Stainless.
 import { APIResource } from 'openai/resource';
 export class Edits extends APIResource {
-  /**
-   * Creates a new edit for the provided input, instruction, and parameters.
-   *
-   * @deprecated The Edits API is deprecated; please use Chat Completions instead.
-   *
-   * https://openai.com/blog/gpt-4-api-general-availability#deprecation-of-the-edits-api
-   */
-  create(body, options) {
-    return this.post('/edits', { body, ...options });
-  }
+    /**
+     * Creates a new edit for the provided input, instruction, and parameters.
+     *
+     * @deprecated The Edits API is deprecated; please use Chat Completions instead.
+     *
+     * https://openai.com/blog/gpt-4-api-general-availability#deprecation-of-the-edits-api
+     */
+    create(body, options) {
+        return this.post('/edits', { body, ...options });
+    }
 }
-(function (Edits) {})(Edits || (Edits = {}));
-//# sourceMappingURL=edits.mjs.map
+(function (Edits) {
+})(Edits || (Edits = {}));
+//# sourceMappingURL=edits.mjs.map

package/resources/embeddings.d.ts

@@ -1,95 +1,92 @@
 import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
-import * as API from './index.js';
+import * as API from "./index.js";
 export declare class Embeddings extends APIResource {
-  /**
-   * Creates an embedding vector representing the input text.
-   */
-  create(
-    body: EmbeddingCreateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<CreateEmbeddingResponse>;
+    /**
+     * Creates an embedding vector representing the input text.
+     */
+    create(body: EmbeddingCreateParams, options?: Core.RequestOptions): Core.APIPromise<CreateEmbeddingResponse>;
 }
 export interface CreateEmbeddingResponse {
-  /**
-   * The list of embeddings generated by the model.
-   */
-  data: Array<Embedding>;
-  /**
-   * The name of the model used to generate the embedding.
-   */
-  model: string;
-  /**
-   * The object type, which is always "embedding".
-   */
-  object: string;
-  /**
-   * The usage information for the request.
-   */
-  usage: CreateEmbeddingResponse.Usage;
-}
-export declare namespace CreateEmbeddingResponse {
-  /**
-   * The usage information for the request.
-   */
-  interface Usage {
     /**
-     * The number of tokens used by the prompt.
+     * The list of embeddings generated by the model.
+     */
+    data: Array<Embedding>;
+    /**
+     * The name of the model used to generate the embedding.
      */
-    prompt_tokens: number;
+    model: string;
+    /**
+     * The object type, which is always "embedding".
+     */
+    object: string;
+    /**
+     * The usage information for the request.
+     */
+    usage: CreateEmbeddingResponse.Usage;
+}
+export declare namespace CreateEmbeddingResponse {
     /**
-     * The total number of tokens used by the request.
+     * The usage information for the request.
      */
-    total_tokens: number;
-  }
+    interface Usage {
+        /**
+         * The number of tokens used by the prompt.
+         */
+        prompt_tokens: number;
+        /**
+         * The total number of tokens used by the request.
+         */
+        total_tokens: number;
+    }
 }
 /**
  * Represents an embedding vector returned by embedding endpoint.
  */
 export interface Embedding {
-  /**
-   * The embedding vector, which is a list of floats. The length of vector depends on
-   * the model as listed in the
-   * [embedding guide](https://platform.openai.com/docs/guides/embeddings).
-   */
-  embedding: Array<number>;
-  /**
-   * The index of the embedding in the list of embeddings.
-   */
-  index: number;
-  /**
-   * The object type, which is always "embedding".
-   */
-  object: string;
+    /**
+     * The embedding vector, which is a list of floats. The length of vector depends on
+     * the model as listed in the
+     * [embedding guide](https://platform.openai.com/docs/guides/embeddings).
+     */
+    embedding: Array<number>;
+    /**
+     * The index of the embedding in the list of embeddings.
+     */
+    index: number;
+    /**
+     * The object type, which is always "embedding".
+     */
+    object: string;
 }
 export interface EmbeddingCreateParams {
-  /**
-   * Input text to embed, encoded as a string or array of tokens. To embed multiple
-   * inputs in a single request, pass an array of strings or array of token arrays.
-   * Each input must not exceed the max input tokens for the model (8191 tokens for
-   * `text-embedding-ada-002`).
-   * [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_count_tokens_with_tiktoken.ipynb)
-   * for counting tokens.
-   */
-  input: string | Array<string> | Array<number> | Array<Array<number>>;
-  /**
-   * ID of the model to use. You can use the
-   * [List models](https://platform.openai.com/docs/api-reference/models/list) API to
-   * see all of your available models, or see our
-   * [Model overview](https://platform.openai.com/docs/models/overview) for
-   * descriptions of them.
-   */
-  model: (string & {}) | 'text-embedding-ada-002';
-  /**
-   * 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;
+    /**
+     * Input text to embed, encoded as a string or array of tokens. To embed multiple
+     * inputs in a single request, pass an array of strings or array of token arrays.
+     * Each input must not exceed the max input tokens for the model (8191 tokens for
+     * `text-embedding-ada-002`).
+     * [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_count_tokens_with_tiktoken.ipynb)
+     * for counting tokens.
+     */
+    input: string | Array<string> | Array<number> | Array<Array<number>>;
+    /**
+     * ID of the model to use. You can use the
+     * [List models](https://platform.openai.com/docs/api-reference/models/list) API to
+     * see all of your available models, or see our
+     * [Model overview](https://platform.openai.com/docs/models/overview) for
+     * descriptions of them.
+     */
+    model: (string & {}) | 'text-embedding-ada-002';
+    /**
+     * 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 Embeddings {
-  export import CreateEmbeddingResponse = API.CreateEmbeddingResponse;
-  export import Embedding = API.Embedding;
-  export import EmbeddingCreateParams = API.EmbeddingCreateParams;
+    export import CreateEmbeddingResponse = API.CreateEmbeddingResponse;
+    export import Embedding = API.Embedding;
+    export import EmbeddingCreateParams = API.EmbeddingCreateParams;
 }
-//# sourceMappingURL=embeddings.d.ts.map
+//# sourceMappingURL=embeddings.d.ts.map

package/resources/embeddings.js

@@ -1,16 +1,17 @@
-'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.Embeddings = void 0;
-const resource_1 = require('openai/resource');
+const resource_1 = require("openai/resource");
 class Embeddings extends resource_1.APIResource {
-  /**
-   * Creates an embedding vector representing the input text.
-   */
-  create(body, options) {
-    return this.post('/embeddings', { body, ...options });
-  }
+    /**
+     * Creates an embedding vector representing the input text.
+     */
+    create(body, options) {
+        return this.post('/embeddings', { body, ...options });
+    }
 }
 exports.Embeddings = Embeddings;
-(function (Embeddings) {})((Embeddings = exports.Embeddings || (exports.Embeddings = {})));
-//# sourceMappingURL=embeddings.js.map
+(function (Embeddings) {
+})(Embeddings = exports.Embeddings || (exports.Embeddings = {}));
+//# sourceMappingURL=embeddings.js.map

package/resources/embeddings.mjs

@@ -1,12 +1,13 @@
 // File generated from our OpenAPI spec by Stainless.
 import { APIResource } from 'openai/resource';
 export class Embeddings extends APIResource {
-  /**
-   * Creates an embedding vector representing the input text.
-   */
-  create(body, options) {
-    return this.post('/embeddings', { body, ...options });
-  }
+    /**
+     * Creates an embedding vector representing the input text.
+     */
+    create(body, options) {
+        return this.post('/embeddings', { body, ...options });
+    }
 }
-(function (Embeddings) {})(Embeddings || (Embeddings = {}));
-//# sourceMappingURL=embeddings.mjs.map
+(function (Embeddings) {
+})(Embeddings || (Embeddings = {}));
+//# sourceMappingURL=embeddings.mjs.map