138 lines
4.8 KiB
TypeScript
138 lines
4.8 KiB
TypeScript
|
import { APIResource } from "../../resource.js";
|
||
|
import * as Core from "../../core.js";
|
||
|
import * as UploadsAPI from "./uploads.js";
|
||
|
import * as FilesAPI from "../files.js";
|
||
|
import * as PartsAPI from "./parts.js";
|
||
|
export declare class Uploads extends APIResource {
|
||
|
parts: PartsAPI.Parts;
|
||
|
/**
|
||
|
* Creates an intermediate
|
||
|
* [Upload](https://platform.openai.com/docs/api-reference/uploads/object) object
|
||
|
* that you can add
|
||
|
* [Parts](https://platform.openai.com/docs/api-reference/uploads/part-object) to.
|
||
|
* Currently, an Upload can accept at most 8 GB in total and expires after an hour
|
||
|
* after you create it.
|
||
|
*
|
||
|
* Once you complete the Upload, we will create a
|
||
|
* [File](https://platform.openai.com/docs/api-reference/files/object) object that
|
||
|
* contains all the parts you uploaded. This File is usable in the rest of our
|
||
|
* platform as a regular File object.
|
||
|
*
|
||
|
* For certain `purpose`s, the correct `mime_type` must be specified. Please refer
|
||
|
* to documentation for the supported MIME types for your use case:
|
||
|
*
|
||
|
* - [Assistants](https://platform.openai.com/docs/assistants/tools/file-search/supported-files)
|
||
|
*
|
||
|
* For guidance on the proper filename extensions for each purpose, please follow
|
||
|
* the documentation on
|
||
|
* [creating a File](https://platform.openai.com/docs/api-reference/files/create).
|
||
|
*/
|
||
|
create(body: UploadCreateParams, options?: Core.RequestOptions): Core.APIPromise<Upload>;
|
||
|
/**
|
||
|
* Cancels the Upload. No Parts may be added after an Upload is cancelled.
|
||
|
*/
|
||
|
cancel(uploadId: string, options?: Core.RequestOptions): Core.APIPromise<Upload>;
|
||
|
/**
|
||
|
* Completes the
|
||
|
* [Upload](https://platform.openai.com/docs/api-reference/uploads/object).
|
||
|
*
|
||
|
* Within the returned Upload object, there is a nested
|
||
|
* [File](https://platform.openai.com/docs/api-reference/files/object) object that
|
||
|
* is ready to use in the rest of the platform.
|
||
|
*
|
||
|
* You can specify the order of the Parts by passing in an ordered list of the Part
|
||
|
* IDs.
|
||
|
*
|
||
|
* The number of bytes uploaded upon completion must match the number of bytes
|
||
|
* initially specified when creating the Upload object. No Parts may be added after
|
||
|
* an Upload is completed.
|
||
|
*/
|
||
|
complete(uploadId: string, body: UploadCompleteParams, options?: Core.RequestOptions): Core.APIPromise<Upload>;
|
||
|
}
|
||
|
/**
|
||
|
* The Upload object can accept byte chunks in the form of Parts.
|
||
|
*/
|
||
|
export interface Upload {
|
||
|
/**
|
||
|
* The Upload unique identifier, which can be referenced in API endpoints.
|
||
|
*/
|
||
|
id: string;
|
||
|
/**
|
||
|
* The intended number of bytes to be uploaded.
|
||
|
*/
|
||
|
bytes: number;
|
||
|
/**
|
||
|
* The Unix timestamp (in seconds) for when the Upload was created.
|
||
|
*/
|
||
|
created_at: number;
|
||
|
/**
|
||
|
* The Unix timestamp (in seconds) for when the Upload was created.
|
||
|
*/
|
||
|
expires_at: number;
|
||
|
/**
|
||
|
* The name of the file to be uploaded.
|
||
|
*/
|
||
|
filename: string;
|
||
|
/**
|
||
|
* The object type, which is always "upload".
|
||
|
*/
|
||
|
object: 'upload';
|
||
|
/**
|
||
|
* The intended purpose of the file.
|
||
|
* [Please refer here](https://platform.openai.com/docs/api-reference/files/object#files/object-purpose)
|
||
|
* for acceptable values.
|
||
|
*/
|
||
|
purpose: string;
|
||
|
/**
|
||
|
* The status of the Upload.
|
||
|
*/
|
||
|
status: 'pending' | 'completed' | 'cancelled' | 'expired';
|
||
|
/**
|
||
|
* The ready File object after the Upload is completed.
|
||
|
*/
|
||
|
file?: FilesAPI.FileObject | null;
|
||
|
}
|
||
|
export interface UploadCreateParams {
|
||
|
/**
|
||
|
* The number of bytes in the file you are uploading.
|
||
|
*/
|
||
|
bytes: number;
|
||
|
/**
|
||
|
* The name of the file to upload.
|
||
|
*/
|
||
|
filename: string;
|
||
|
/**
|
||
|
* The MIME type of the file.
|
||
|
*
|
||
|
* This must fall within the supported MIME types for your file purpose. See the
|
||
|
* supported MIME types for assistants and vision.
|
||
|
*/
|
||
|
mime_type: string;
|
||
|
/**
|
||
|
* The intended purpose of the uploaded file.
|
||
|
*
|
||
|
* See the
|
||
|
* [documentation on File purposes](https://platform.openai.com/docs/api-reference/files/create#files-create-purpose).
|
||
|
*/
|
||
|
purpose: FilesAPI.FilePurpose;
|
||
|
}
|
||
|
export interface UploadCompleteParams {
|
||
|
/**
|
||
|
* The ordered list of Part IDs.
|
||
|
*/
|
||
|
part_ids: Array<string>;
|
||
|
/**
|
||
|
* The optional md5 checksum for the file contents to verify if the bytes uploaded
|
||
|
* matches what you expect.
|
||
|
*/
|
||
|
md5?: string;
|
||
|
}
|
||
|
export declare namespace Uploads {
|
||
|
export import Upload = UploadsAPI.Upload;
|
||
|
export import UploadCreateParams = UploadsAPI.UploadCreateParams;
|
||
|
export import UploadCompleteParams = UploadsAPI.UploadCompleteParams;
|
||
|
export import Parts = PartsAPI.Parts;
|
||
|
export import UploadPart = PartsAPI.UploadPart;
|
||
|
export import PartCreateParams = PartsAPI.PartCreateParams;
|
||
|
}
|
||
|
//# sourceMappingURL=uploads.d.ts.map
|