62 lines
2.6 KiB
JavaScript
62 lines
2.6 KiB
JavaScript
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
||
|
|
import { APIResource } from "../../resource.mjs";
|
||
|
|
import * as PartsAPI from "./parts.mjs";
|
||
|
|
export class Uploads extends APIResource {
|
||
|
|
constructor() {
|
||
|
|
super(...arguments);
|
||
|
|
this.parts = new PartsAPI.Parts(this._client);
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* 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, options) {
|
||
|
|
return this._client.post('/uploads', { body, ...options });
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Cancels the Upload. No Parts may be added after an Upload is cancelled.
|
||
|
|
*/
|
||
|
|
cancel(uploadId, options) {
|
||
|
|
return this._client.post(`/uploads/${uploadId}/cancel`, options);
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* 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, body, options) {
|
||
|
|
return this._client.post(`/uploads/${uploadId}/complete`, { body, ...options });
|
||
|
|
}
|
||
|
|
}
|
||
|
|
(function (Uploads) {
|
||
|
|
Uploads.Parts = PartsAPI.Parts;
|
||
|
|
})(Uploads || (Uploads = {}));
|
||
|
|
//# sourceMappingURL=uploads.mjs.map
|