140 lines
4.9 KiB
TypeScript
140 lines
4.9 KiB
TypeScript
import * as Core from "../core.js";
|
|
import { APIResource } from "../resource.js";
|
|
import { type Response } from "../_shims/index.js";
|
|
import * as FilesAPI from "./files.js";
|
|
import { type Uploadable } from "../core.js";
|
|
import { Page } from "../pagination.js";
|
|
export declare class Files extends APIResource {
|
|
/**
|
|
* Upload a file that can be used across various endpoints. Individual files can be
|
|
* up to 512 MB, and the size of all files uploaded by one organization can be up
|
|
* to 100 GB.
|
|
*
|
|
* The Assistants API supports files up to 2 million tokens and of specific file
|
|
* types. See the
|
|
* [Assistants Tools guide](https://platform.openai.com/docs/assistants/tools) for
|
|
* details.
|
|
*
|
|
* The Fine-tuning API only supports `.jsonl` files.
|
|
*
|
|
* The Batch API only supports `.jsonl` files up to 100 MB in size.
|
|
*
|
|
* Please [contact us](https://help.openai.com/) if you need to increase these
|
|
* storage limits.
|
|
*/
|
|
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(query?: FileListParams, options?: Core.RequestOptions): Core.PagePromise<FileObjectsPage, FileObject>;
|
|
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.
|
|
*/
|
|
content(fileId: string, options?: Core.RequestOptions): Core.APIPromise<Response>;
|
|
/**
|
|
* Returns the contents of the specified file.
|
|
*
|
|
* @deprecated The `.content()` method should be used instead
|
|
*/
|
|
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 type FileContent = string;
|
|
export interface FileDeleted {
|
|
id: string;
|
|
deleted: boolean;
|
|
object: 'file';
|
|
}
|
|
/**
|
|
* 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: 'file';
|
|
/**
|
|
* The intended purpose of the file. Supported values are `assistants`,
|
|
* `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`
|
|
* and `vision`.
|
|
*/
|
|
purpose: 'assistants' | 'assistants_output' | 'batch' | 'batch_output' | 'fine-tune' | 'fine-tune-results' | 'vision';
|
|
/**
|
|
* @deprecated: Deprecated. The current status of the file, which can be either
|
|
* `uploaded`, `processed`, or `error`.
|
|
*/
|
|
status: 'uploaded' | 'processed' | 'error';
|
|
/**
|
|
* @deprecated: Deprecated. For details on why a fine-tuning training file failed
|
|
* validation, see the `error` field on `fine_tuning.job`.
|
|
*/
|
|
status_details?: string;
|
|
}
|
|
export interface FileCreateParams {
|
|
/**
|
|
* The File object (not file name) to be uploaded.
|
|
*/
|
|
file: Uploadable;
|
|
/**
|
|
* The intended purpose of the uploaded file.
|
|
*
|
|
* Use "assistants" for
|
|
* [Assistants](https://platform.openai.com/docs/api-reference/assistants) and
|
|
* [Message](https://platform.openai.com/docs/api-reference/messages) files,
|
|
* "vision" for Assistants image file inputs, "batch" for
|
|
* [Batch API](https://platform.openai.com/docs/guides/batch), and "fine-tune" for
|
|
* [Fine-tuning](https://platform.openai.com/docs/api-reference/fine-tuning).
|
|
*/
|
|
purpose: 'assistants' | 'batch' | 'fine-tune';
|
|
}
|
|
export interface FileListParams {
|
|
/**
|
|
* Only return files with the given purpose.
|
|
*/
|
|
purpose?: string;
|
|
}
|
|
export declare namespace Files {
|
|
export import FileContent = FilesAPI.FileContent;
|
|
export import FileDeleted = FilesAPI.FileDeleted;
|
|
export import FileObject = FilesAPI.FileObject;
|
|
export import FileObjectsPage = FilesAPI.FileObjectsPage;
|
|
export import FileCreateParams = FilesAPI.FileCreateParams;
|
|
export import FileListParams = FilesAPI.FileListParams;
|
|
}
|
|
//# sourceMappingURL=files.d.ts.map
|