openai 4.8.0 → 4.9.0

package/resources/files.d.ts

@@ -1,119 +1,114 @@
 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';
 import { Page } from 'openai/pagination';
 export declare class Files extends APIResource {
-  /**
-   * Upload a file that contains document(s) to be used across various
-   * endpoints/features. Currently, the size of all the files uploaded by one
-   * organization can be up to 1 GB. Please contact us if you need to increase the
-   * storage limit.
-   */
-  create(body: FileCreateParams, options?: Core.RequestOptions): Core.APIPromise<FileObject>;
-  /**
-   * Returns information about a specific file.
-   */
-  retrieve(fileId: string, options?: Core.RequestOptions): Core.APIPromise<FileObject>;
-  /**
-   * Returns a list of files that belong to the user's organization.
-   */
-  list(options?: Core.RequestOptions): Core.PagePromise<FileObjectsPage, FileObject>;
-  /**
-   * Delete a file.
-   */
-  del(fileId: string, options?: Core.RequestOptions): Core.APIPromise<FileDeleted>;
-  /**
-   * Returns the contents of the specified file
-   */
-  retrieveContent(fileId: string, options?: Core.RequestOptions): Core.APIPromise<string>;
-  /**
-   * Waits for the given file to be processed, default timeout is 30 mins.
-   */
-  waitForProcessing(
-    id: string,
-    {
-      pollInterval,
-      maxWait,
-    }?: {
-      pollInterval?: number;
-      maxWait?: number;
-    },
-  ): Promise<FileObject>;
+    /**
+     * Upload a file that contains document(s) to be used across various
+     * endpoints/features. Currently, the size of all the files uploaded by one
+     * organization can be up to 1 GB. Please contact us if you need to increase the
+     * storage limit.
+     */
+    create(body: FileCreateParams, options?: Core.RequestOptions): Core.APIPromise<FileObject>;
+    /**
+     * Returns information about a specific file.
+     */
+    retrieve(fileId: string, options?: Core.RequestOptions): Core.APIPromise<FileObject>;
+    /**
+     * Returns a list of files that belong to the user's organization.
+     */
+    list(options?: Core.RequestOptions): Core.PagePromise<FileObjectsPage, FileObject>;
+    /**
+     * Delete a file.
+     */
+    del(fileId: string, options?: Core.RequestOptions): Core.APIPromise<FileDeleted>;
+    /**
+     * Returns the contents of the specified file
+     */
+    retrieveContent(fileId: string, options?: Core.RequestOptions): Core.APIPromise<string>;
+    /**
+     * Waits for the given file to be processed, default timeout is 30 mins.
+     */
+    waitForProcessing(id: string, { pollInterval, maxWait }?: {
+        pollInterval?: number;
+        maxWait?: number;
+    }): Promise<FileObject>;
 }
 /**
  * Note: no pagination actually occurs yet, this is for forwards-compatibility.
  */
-export declare class FileObjectsPage extends Page<FileObject> {}
+export declare class FileObjectsPage extends Page<FileObject> {
+}
 type _FileObjectsPage = FileObjectsPage;
 export type FileContent = string;
 export interface FileDeleted {
-  id: string;
-  deleted: boolean;
-  object: string;
+    id: string;
+    deleted: boolean;
+    object: string;
 }
 /**
  * The `File` object represents a document that has been uploaded to OpenAI.
  */
 export interface FileObject {
-  /**
-   * The file identifier, which can be referenced in the API endpoints.
-   */
-  id: string;
-  /**
-   * The size of the file in bytes.
-   */
-  bytes: number;
-  /**
-   * The Unix timestamp (in seconds) for when the file was created.
-   */
-  created_at: number;
-  /**
-   * The name of the file.
-   */
-  filename: string;
-  /**
-   * The object type, which is always "file".
-   */
-  object: string;
-  /**
-   * The intended purpose of the file. Currently, only "fine-tune" is supported.
-   */
-  purpose: string;
-  /**
-   * The current status of the file, which can be either `uploaded`, `processed`,
-   * `pending`, `error`, `deleting` or `deleted`.
-   */
-  status?: string;
-  /**
-   * Additional details about the status of the file. If the file is in the `error`
-   * state, this will include a message describing the error.
-   */
-  status_details?: string | null;
+    /**
+     * The file identifier, which can be referenced in the API endpoints.
+     */
+    id: string;
+    /**
+     * The size of the file in bytes.
+     */
+    bytes: number;
+    /**
+     * The Unix timestamp (in seconds) for when the file was created.
+     */
+    created_at: number;
+    /**
+     * The name of the file.
+     */
+    filename: string;
+    /**
+     * The object type, which is always "file".
+     */
+    object: string;
+    /**
+     * The intended purpose of the file. Currently, only "fine-tune" is supported.
+     */
+    purpose: string;
+    /**
+     * The current status of the file, which can be either `uploaded`, `processed`,
+     * `pending`, `error`, `deleting` or `deleted`.
+     */
+    status?: string;
+    /**
+     * Additional details about the status of the file. If the file is in the `error`
+     * state, this will include a message describing the error.
+     */
+    status_details?: string | null;
 }
 export interface FileCreateParams {
-  /**
-   * Name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be
-   * uploaded.
-   *
-   * If the `purpose` is set to "fine-tune", the file will be used for fine-tuning.
-   */
-  file: Uploadable;
-  /**
-   * The intended purpose of the uploaded documents.
-   *
-   * Use "fine-tune" for
-   * [fine-tuning](https://platform.openai.com/docs/api-reference/fine-tuning). This
-   * allows us to validate the format of the uploaded file.
-   */
-  purpose: string;
+    /**
+     * Name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be
+     * uploaded.
+     *
+     * If the `purpose` is set to "fine-tune", the file will be used for fine-tuning.
+     */
+    file: Uploadable;
+    /**
+     * The intended purpose of the uploaded documents.
+     *
+     * Use "fine-tune" for
+     * [fine-tuning](https://platform.openai.com/docs/api-reference/fine-tuning). This
+     * allows us to validate the format of the uploaded file.
+     */
+    purpose: string;
 }
 export declare namespace Files {
-  export import FileContent = API.FileContent;
-  export import FileDeleted = API.FileDeleted;
-  export import FileObject = API.FileObject;
-  type FileObjectsPage = _FileObjectsPage;
-  export import FileCreateParams = API.FileCreateParams;
+    export import FileContent = API.FileContent;
+    export import FileDeleted = API.FileDeleted;
+    export import FileObject = API.FileObject;
+    type FileObjectsPage = _FileObjectsPage;
+    export import FileCreateParams = API.FileCreateParams;
 }
 export {};
-//# sourceMappingURL=files.d.ts.map
+//# sourceMappingURL=files.d.ts.map

package/resources/files.js

@@ -1,76 +1,75 @@
-'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.FileObjectsPage = exports.Files = void 0;
-const resource_1 = require('openai/resource');
-const core_1 = require('openai/core');
-const error_1 = require('openai/error');
-const core_2 = require('openai/core');
-const pagination_1 = require('openai/pagination');
+const resource_1 = require("openai/resource");
+const core_1 = require("openai/core");
+const error_1 = require("openai/error");
+const core_2 = require("openai/core");
+const pagination_1 = require("openai/pagination");
 class Files extends resource_1.APIResource {
-  /**
-   * Upload a file that contains document(s) to be used across various
-   * endpoints/features. Currently, the size of all the files uploaded by one
-   * organization can be up to 1 GB. Please contact us if you need to increase the
-   * storage limit.
-   */
-  create(body, options) {
-    return this.post('/files', (0, core_2.multipartFormRequestOptions)({ body, ...options }));
-  }
-  /**
-   * Returns information about a specific file.
-   */
-  retrieve(fileId, options) {
-    return this.get(`/files/${fileId}`, options);
-  }
-  /**
-   * Returns a list of files that belong to the user's organization.
-   */
-  list(options) {
-    return this.getAPIList('/files', FileObjectsPage, options);
-  }
-  /**
-   * Delete a file.
-   */
-  del(fileId, options) {
-    return this.delete(`/files/${fileId}`, options);
-  }
-  /**
-   * Returns the contents of the specified file
-   */
-  retrieveContent(fileId, options) {
-    return this.get(`/files/${fileId}/content`, {
-      ...options,
-      headers: {
-        Accept: 'application/json',
-        ...(options === null || options === void 0 ? void 0 : options.headers),
-      },
-    });
-  }
-  /**
-   * Waits for the given file to be processed, default timeout is 30 mins.
-   */
-  async waitForProcessing(id, { pollInterval = 5000, maxWait = 30 * 60 * 1000 } = {}) {
-    const TERMINAL_STATES = new Set(['processed', 'error', 'deleted']);
-    const start = Date.now();
-    let file = await this.retrieve(id);
-    while (!file.status || !TERMINAL_STATES.has(file.status)) {
-      await (0, core_1.sleep)(pollInterval);
-      file = await this.retrieve(id);
-      if (Date.now() - start > maxWait) {
-        throw new error_1.APIConnectionTimeoutError({
-          message: `Giving up on waiting for file ${id} to finish processing after ${maxWait} milliseconds.`,
+    /**
+     * Upload a file that contains document(s) to be used across various
+     * endpoints/features. Currently, the size of all the files uploaded by one
+     * organization can be up to 1 GB. Please contact us if you need to increase the
+     * storage limit.
+     */
+    create(body, options) {
+        return this.post('/files', (0, core_2.multipartFormRequestOptions)({ body, ...options }));
+    }
+    /**
+     * Returns information about a specific file.
+     */
+    retrieve(fileId, options) {
+        return this.get(`/files/${fileId}`, options);
+    }
+    /**
+     * Returns a list of files that belong to the user's organization.
+     */
+    list(options) {
+        return this.getAPIList('/files', FileObjectsPage, options);
+    }
+    /**
+     * Delete a file.
+     */
+    del(fileId, options) {
+        return this.delete(`/files/${fileId}`, options);
+    }
+    /**
+     * Returns the contents of the specified file
+     */
+    retrieveContent(fileId, options) {
+        return this.get(`/files/${fileId}/content`, {
+            ...options,
+            headers: { Accept: 'application/json', ...options === null || options === void 0 ? void 0 : options.headers },
         });
-      }
     }
-    return file;
-  }
+    /**
+     * Waits for the given file to be processed, default timeout is 30 mins.
+     */
+    async waitForProcessing(id, { pollInterval = 5000, maxWait = 30 * 60 * 1000 } = {}) {
+        const TERMINAL_STATES = new Set(['processed', 'error', 'deleted']);
+        const start = Date.now();
+        let file = await this.retrieve(id);
+        while (!file.status || !TERMINAL_STATES.has(file.status)) {
+            await (0, core_1.sleep)(pollInterval);
+            file = await this.retrieve(id);
+            if (Date.now() - start > maxWait) {
+                throw new error_1.APIConnectionTimeoutError({
+                    message: `Giving up on waiting for file ${id} to finish processing after ${maxWait} milliseconds.`,
+                });
+            }
+        }
+        return file;
+    }
 }
 exports.Files = Files;
 /**
  * Note: no pagination actually occurs yet, this is for forwards-compatibility.
  */
-class FileObjectsPage extends pagination_1.Page {}
+class FileObjectsPage extends pagination_1.Page {
+}
 exports.FileObjectsPage = FileObjectsPage;
-(function (Files) {})((Files = exports.Files || (exports.Files = {})));
-//# sourceMappingURL=files.js.map
+(function (Files) {
+})(Files = exports.Files || (exports.Files = {}));
+//# sourceMappingURL=files.js.map

package/resources/files.mjs

@@ -5,67 +5,66 @@ import { APIConnectionTimeoutError } from 'openai/error';
 import { multipartFormRequestOptions } from 'openai/core';
 import { Page } from 'openai/pagination';
 export class Files extends APIResource {
-  /**
-   * Upload a file that contains document(s) to be used across various
-   * endpoints/features. Currently, the size of all the files uploaded by one
-   * organization can be up to 1 GB. Please contact us if you need to increase the
-   * storage limit.
-   */
-  create(body, options) {
-    return this.post('/files', multipartFormRequestOptions({ body, ...options }));
-  }
-  /**
-   * Returns information about a specific file.
-   */
-  retrieve(fileId, options) {
-    return this.get(`/files/${fileId}`, options);
-  }
-  /**
-   * Returns a list of files that belong to the user's organization.
-   */
-  list(options) {
-    return this.getAPIList('/files', FileObjectsPage, options);
-  }
-  /**
-   * Delete a file.
-   */
-  del(fileId, options) {
-    return this.delete(`/files/${fileId}`, options);
-  }
-  /**
-   * Returns the contents of the specified file
-   */
-  retrieveContent(fileId, options) {
-    return this.get(`/files/${fileId}/content`, {
-      ...options,
-      headers: {
-        Accept: 'application/json',
-        ...(options === null || options === void 0 ? void 0 : options.headers),
-      },
-    });
-  }
-  /**
-   * Waits for the given file to be processed, default timeout is 30 mins.
-   */
-  async waitForProcessing(id, { pollInterval = 5000, maxWait = 30 * 60 * 1000 } = {}) {
-    const TERMINAL_STATES = new Set(['processed', 'error', 'deleted']);
-    const start = Date.now();
-    let file = await this.retrieve(id);
-    while (!file.status || !TERMINAL_STATES.has(file.status)) {
-      await sleep(pollInterval);
-      file = await this.retrieve(id);
-      if (Date.now() - start > maxWait) {
-        throw new APIConnectionTimeoutError({
-          message: `Giving up on waiting for file ${id} to finish processing after ${maxWait} milliseconds.`,
+    /**
+     * Upload a file that contains document(s) to be used across various
+     * endpoints/features. Currently, the size of all the files uploaded by one
+     * organization can be up to 1 GB. Please contact us if you need to increase the
+     * storage limit.
+     */
+    create(body, options) {
+        return this.post('/files', multipartFormRequestOptions({ body, ...options }));
+    }
+    /**
+     * Returns information about a specific file.
+     */
+    retrieve(fileId, options) {
+        return this.get(`/files/${fileId}`, options);
+    }
+    /**
+     * Returns a list of files that belong to the user's organization.
+     */
+    list(options) {
+        return this.getAPIList('/files', FileObjectsPage, options);
+    }
+    /**
+     * Delete a file.
+     */
+    del(fileId, options) {
+        return this.delete(`/files/${fileId}`, options);
+    }
+    /**
+     * Returns the contents of the specified file
+     */
+    retrieveContent(fileId, options) {
+        return this.get(`/files/${fileId}/content`, {
+            ...options,
+            headers: { Accept: 'application/json', ...options === null || options === void 0 ? void 0 : options.headers },
         });
-      }
     }
-    return file;
-  }
+    /**
+     * Waits for the given file to be processed, default timeout is 30 mins.
+     */
+    async waitForProcessing(id, { pollInterval = 5000, maxWait = 30 * 60 * 1000 } = {}) {
+        const TERMINAL_STATES = new Set(['processed', 'error', 'deleted']);
+        const start = Date.now();
+        let file = await this.retrieve(id);
+        while (!file.status || !TERMINAL_STATES.has(file.status)) {
+            await sleep(pollInterval);
+            file = await this.retrieve(id);
+            if (Date.now() - start > maxWait) {
+                throw new APIConnectionTimeoutError({
+                    message: `Giving up on waiting for file ${id} to finish processing after ${maxWait} milliseconds.`,
+                });
+            }
+        }
+        return file;
+    }
 }
 /**
  * Note: no pagination actually occurs yet, this is for forwards-compatibility.
  */
-export class FileObjectsPage extends Page {}
-(function (Files) {})(Files || (Files = {}));
-//# sourceMappingURL=files.mjs.map
+export class FileObjectsPage extends Page {
+}
+(function (Files) {
+})(Files || (Files = {}));
+//# sourceMappingURL=files.mjs.map