| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139 |
- // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
- import { APIResource } from "../../resource.mjs";
- import { sleep, isRequestOptions } from "../../core.mjs";
- import { CursorPage, Page } from "../../pagination.mjs";
- export class Files extends APIResource {
- /**
- * Create a vector store file by attaching a
- * [File](https://platform.openai.com/docs/api-reference/files) to a
- * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object).
- */
- create(vectorStoreId, body, options) {
- return this._client.post(`/vector_stores/${vectorStoreId}/files`, {
- body,
- ...options,
- headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
- });
- }
- /**
- * Retrieves a vector store file.
- */
- retrieve(vectorStoreId, fileId, options) {
- return this._client.get(`/vector_stores/${vectorStoreId}/files/${fileId}`, {
- ...options,
- headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
- });
- }
- /**
- * Update attributes on a vector store file.
- */
- update(vectorStoreId, fileId, body, options) {
- return this._client.post(`/vector_stores/${vectorStoreId}/files/${fileId}`, {
- body,
- ...options,
- headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
- });
- }
- list(vectorStoreId, query = {}, options) {
- if (isRequestOptions(query)) {
- return this.list(vectorStoreId, {}, query);
- }
- return this._client.getAPIList(`/vector_stores/${vectorStoreId}/files`, VectorStoreFilesPage, {
- query,
- ...options,
- headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
- });
- }
- /**
- * Delete a vector store file. This will remove the file from the vector store but
- * the file itself will not be deleted. To delete the file, use the
- * [delete file](https://platform.openai.com/docs/api-reference/files/delete)
- * endpoint.
- */
- del(vectorStoreId, fileId, options) {
- return this._client.delete(`/vector_stores/${vectorStoreId}/files/${fileId}`, {
- ...options,
- headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
- });
- }
- /**
- * Attach a file to the given vector store and wait for it to be processed.
- */
- async createAndPoll(vectorStoreId, body, options) {
- const file = await this.create(vectorStoreId, body, options);
- return await this.poll(vectorStoreId, file.id, options);
- }
- /**
- * Wait for the vector store file to finish processing.
- *
- * Note: this will return even if the file failed to process, you need to check
- * file.last_error and file.status to handle these cases
- */
- async poll(vectorStoreId, fileId, options) {
- const headers = { ...options?.headers, 'X-Stainless-Poll-Helper': 'true' };
- if (options?.pollIntervalMs) {
- headers['X-Stainless-Custom-Poll-Interval'] = options.pollIntervalMs.toString();
- }
- while (true) {
- const fileResponse = await this.retrieve(vectorStoreId, fileId, {
- ...options,
- headers,
- }).withResponse();
- const file = fileResponse.data;
- switch (file.status) {
- case 'in_progress':
- let sleepInterval = 5000;
- if (options?.pollIntervalMs) {
- sleepInterval = options.pollIntervalMs;
- }
- else {
- const headerInterval = fileResponse.response.headers.get('openai-poll-after-ms');
- if (headerInterval) {
- const headerIntervalMs = parseInt(headerInterval);
- if (!isNaN(headerIntervalMs)) {
- sleepInterval = headerIntervalMs;
- }
- }
- }
- await sleep(sleepInterval);
- break;
- case 'failed':
- case 'completed':
- return file;
- }
- }
- }
- /**
- * Upload a file to the `files` API and then attach it to the given vector store.
- *
- * Note the file will be asynchronously processed (you can use the alternative
- * polling helper method to wait for processing to complete).
- */
- async upload(vectorStoreId, file, options) {
- const fileInfo = await this._client.files.create({ file: file, purpose: 'assistants' }, options);
- return this.create(vectorStoreId, { file_id: fileInfo.id }, options);
- }
- /**
- * Add a file to a vector store and poll until processing is complete.
- */
- async uploadAndPoll(vectorStoreId, file, options) {
- const fileInfo = await this.upload(vectorStoreId, file, options);
- return await this.poll(vectorStoreId, fileInfo.id, options);
- }
- /**
- * Retrieve the parsed contents of a vector store file.
- */
- content(vectorStoreId, fileId, options) {
- return this._client.getAPIList(`/vector_stores/${vectorStoreId}/files/${fileId}/content`, FileContentResponsesPage, { ...options, headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers } });
- }
- }
- export class VectorStoreFilesPage extends CursorPage {
- }
- /**
- * Note: no pagination actually occurs yet, this is for forwards-compatibility.
- */
- export class FileContentResponsesPage extends Page {
- }
- Files.VectorStoreFilesPage = VectorStoreFilesPage;
- Files.FileContentResponsesPage = FileContentResponsesPage;
- //# sourceMappingURL=files.mjs.map
|