98 lines
3.7 KiB
JavaScript
98 lines
3.7 KiB
JavaScript
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
||
|
|
import { APIResource } from "../resource.mjs";
|
||
|
|
import { isRequestOptions } from "../core.mjs";
|
||
|
|
import { sleep } from "../core.mjs";
|
||
|
|
import { APIConnectionTimeoutError } from "../error.mjs";
|
||
|
|
import * as Core from "../core.mjs";
|
||
|
|
import * as FilesAPI from "./files.mjs";
|
||
|
|
import { Page } from "../pagination.mjs";
|
||
|
|
export 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 input also has certain
|
||
|
|
* required formats for fine-tuning
|
||
|
|
* [chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input) or
|
||
|
|
* [completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input)
|
||
|
|
* models.
|
||
|
|
*
|
||
|
|
* The Batch API only supports `.jsonl` files up to 100 MB in size. The input also
|
||
|
|
* has a specific required
|
||
|
|
* [format](https://platform.openai.com/docs/api-reference/batch/request-input).
|
||
|
|
*
|
||
|
|
* Please [contact us](https://help.openai.com/) if you need to increase these
|
||
|
|
* storage limits.
|
||
|
|
*/
|
||
|
|
create(body, options) {
|
||
|
|
return this._client.post('/files', Core.multipartFormRequestOptions({ body, ...options }));
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Returns information about a specific file.
|
||
|
|
*/
|
||
|
|
retrieve(fileId, options) {
|
||
|
|
return this._client.get(`/files/${fileId}`, options);
|
||
|
|
}
|
||
|
|
list(query = {}, options) {
|
||
|
|
if (isRequestOptions(query)) {
|
||
|
|
return this.list({}, query);
|
||
|
|
}
|
||
|
|
return this._client.getAPIList('/files', FileObjectsPage, { query, ...options });
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Delete a file.
|
||
|
|
*/
|
||
|
|
del(fileId, options) {
|
||
|
|
return this._client.delete(`/files/${fileId}`, options);
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Returns the contents of the specified file.
|
||
|
|
*/
|
||
|
|
content(fileId, options) {
|
||
|
|
return this._client.get(`/files/${fileId}/content`, { ...options, __binaryResponse: true });
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Returns the contents of the specified file.
|
||
|
|
*
|
||
|
|
* @deprecated The `.content()` method should be used instead
|
||
|
|
*/
|
||
|
|
retrieveContent(fileId, options) {
|
||
|
|
return this._client.get(`/files/${fileId}/content`, {
|
||
|
|
...options,
|
||
|
|
headers: { Accept: 'application/json', ...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.`,
|
||
|
|
});
|
||
|
|
}
|
||
|
|
}
|
||
|
|
return file;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Note: no pagination actually occurs yet, this is for forwards-compatibility.
|
||
|
|
*/
|
||
|
|
export class FileObjectsPage extends Page {
|
||
|
|
}
|
||
|
|
(function (Files) {
|
||
|
|
Files.FileObjectsPage = FilesAPI.FileObjectsPage;
|
||
|
|
})(Files || (Files = {}));
|
||
|
|
//# sourceMappingURL=files.mjs.map
|