openai-mcp-test 0.0.1

package/resources/vector-stores/file-batches.d.ts

@@ -0,0 +1,179 @@
+import { APIResource } from "../../core/resource.js";
+import * as FilesAPI from "./files.js";
+import { VectorStoreFilesPage } from "./files.js";
+import * as VectorStoresAPI from "./vector-stores.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { type CursorPageParams, PagePromise } from "../../core/pagination.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class FileBatches extends APIResource {
+    /**
+     * Create a vector store file batch.
+     */
+    create(vectorStoreID: string, body: FileBatchCreateParams, options?: RequestOptions): APIPromise<VectorStoreFileBatch>;
+    /**
+     * Retrieves a vector store file batch.
+     */
+    retrieve(batchID: string, params: FileBatchRetrieveParams, options?: RequestOptions): APIPromise<VectorStoreFileBatch>;
+    /**
+     * Cancel a vector store file batch. This attempts to cancel the processing of
+     * files in this batch as soon as possible.
+     */
+    cancel(batchID: string, params: FileBatchCancelParams, options?: RequestOptions): APIPromise<VectorStoreFileBatch>;
+    /**
+     * Returns a list of vector store files in a batch.
+     */
+    listFiles(batchID: string, params: FileBatchListFilesParams, options?: RequestOptions): PagePromise<VectorStoreFilesPage, FilesAPI.VectorStoreFile>;
+}
+/**
+ * A batch of files attached to a vector store.
+ */
+export interface VectorStoreFileBatch {
+    /**
+     * The identifier, which can be referenced in API endpoints.
+     */
+    id: string;
+    /**
+     * The Unix timestamp (in seconds) for when the vector store files batch was
+     * created.
+     */
+    created_at: number;
+    file_counts: VectorStoreFileBatch.FileCounts;
+    /**
+     * The object type, which is always `vector_store.file_batch`.
+     */
+    object: 'vector_store.files_batch';
+    /**
+     * The status of the vector store files batch, which can be either `in_progress`,
+     * `completed`, `cancelled` or `failed`.
+     */
+    status: 'in_progress' | 'completed' | 'cancelled' | 'failed';
+    /**
+     * The ID of the
+     * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+     * that the [File](https://platform.openai.com/docs/api-reference/files) is
+     * attached to.
+     */
+    vector_store_id: string;
+}
+export declare namespace VectorStoreFileBatch {
+    interface FileCounts {
+        /**
+         * The number of files that where cancelled.
+         */
+        cancelled: number;
+        /**
+         * The number of files that have been processed.
+         */
+        completed: number;
+        /**
+         * The number of files that have failed to process.
+         */
+        failed: number;
+        /**
+         * The number of files that are currently being processed.
+         */
+        in_progress: number;
+        /**
+         * The total number of files.
+         */
+        total: number;
+    }
+}
+export interface FileBatchCreateParams {
+    /**
+     * Set of 16 key-value pairs that can be attached to an object. This can be useful
+     * for storing additional information about the object in a structured format, and
+     * querying for objects via API or the dashboard. Keys are strings with a maximum
+     * length of 64 characters. Values are strings with a maximum length of 512
+     * characters, booleans, or numbers.
+     */
+    attributes?: {
+        [key: string]: string | number | boolean;
+    } | null;
+    /**
+     * The chunking strategy used to chunk the file(s). If not set, will use the `auto`
+     * strategy. Only applicable if `file_ids` is non-empty.
+     */
+    chunking_strategy?: VectorStoresAPI.FileChunkingStrategyParam;
+    /**
+     * A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that
+     * the vector store should use. Useful for tools like `file_search` that can access
+     * files. If `attributes` or `chunking_strategy` are provided, they will be applied
+     * to all files in the batch. The maximum batch size is 2000 files. Mutually
+     * exclusive with `files`.
+     */
+    file_ids?: Array<string>;
+    /**
+     * A list of objects that each include a `file_id` plus optional `attributes` or
+     * `chunking_strategy`. Use this when you need to override metadata for specific
+     * files. The global `attributes` or `chunking_strategy` will be ignored and must
+     * be specified for each file. The maximum batch size is 2000 files. Mutually
+     * exclusive with `file_ids`.
+     */
+    files?: Array<FileBatchCreateParams.File>;
+}
+export declare namespace FileBatchCreateParams {
+    interface File {
+        /**
+         * A [File](https://platform.openai.com/docs/api-reference/files) ID that the
+         * vector store should use. Useful for tools like `file_search` that can access
+         * files.
+         */
+        file_id: string;
+        /**
+         * Set of 16 key-value pairs that can be attached to an object. This can be useful
+         * for storing additional information about the object in a structured format, and
+         * querying for objects via API or the dashboard. Keys are strings with a maximum
+         * length of 64 characters. Values are strings with a maximum length of 512
+         * characters, booleans, or numbers.
+         */
+        attributes?: {
+            [key: string]: string | number | boolean;
+        } | null;
+        /**
+         * The chunking strategy used to chunk the file(s). If not set, will use the `auto`
+         * strategy. Only applicable if `file_ids` is non-empty.
+         */
+        chunking_strategy?: VectorStoresAPI.FileChunkingStrategyParam;
+    }
+}
+export interface FileBatchRetrieveParams {
+    /**
+     * The ID of the vector store that the file batch belongs to.
+     */
+    vector_store_id: string;
+}
+export interface FileBatchCancelParams {
+    /**
+     * The ID of the vector store that the file batch belongs to.
+     */
+    vector_store_id: string;
+}
+export interface FileBatchListFilesParams extends CursorPageParams {
+    /**
+     * Path param: The ID of the vector store that the files belong to.
+     */
+    vector_store_id: string;
+    /**
+     * Query param: A cursor for use in pagination. `before` is an object ID that
+     * defines your place in the list. For instance, if you make a list request and
+     * receive 100 objects, starting with obj_foo, your subsequent call can include
+     * before=obj_foo in order to fetch the previous page of the list.
+     */
+    before?: string;
+    /**
+     * Query param: Filter by file status. One of `in_progress`, `completed`, `failed`,
+     * `cancelled`.
+     */
+    filter?: 'in_progress' | 'completed' | 'failed' | 'cancelled';
+    /**
+     * Query param: Sort order by the `created_at` timestamp of the objects. `asc` for
+     * ascending order and `desc` for descending order.
+     */
+    order?: 'asc' | 'desc';
+}
+export declare namespace FileBatches {
+    export { type VectorStoreFileBatch as VectorStoreFileBatch, type FileBatchCreateParams as FileBatchCreateParams, type FileBatchRetrieveParams as FileBatchRetrieveParams, type FileBatchCancelParams as FileBatchCancelParams, type FileBatchListFilesParams as FileBatchListFilesParams, };
+}
+export { type VectorStoreFilesPage };
+//# sourceMappingURL=file-batches.d.ts.map

package/resources/vector-stores/file-batches.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-batches.d.ts","sourceRoot":"","sources":["../../src/resources/vector-stores/file-batches.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,EAAE,oBAAoB,EAAE;OACxB,KAAK,eAAe;OACpB,EAAE,UAAU,EAAE;OACd,EAAc,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAElD,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;OAEG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAQnC;;OAEG;IACH,QAAQ,CACN,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAQnC;;;OAGG;IACH,MAAM,CACJ,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAQnC;;OAEG;IACH,SAAS,CACP,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,QAAQ,CAAC,eAAe,CAAC;CAQ/D;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,oBAAoB,CAAC,UAAU,CAAC;IAE7C;;OAEG;IACH,MAAM,EAAE,0BAA0B,CAAC;IAEnC;;;OAGG;IACH,MAAM,EAAE,aAAa,GAAG,WAAW,GAAG,WAAW,GAAG,QAAQ,CAAC;IAE7D;;;;;OAKG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,UAAU;QACzB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;;;OAMG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEjE;;;OAGG;IACH,iBAAiB,CAAC,EAAE,eAAe,CAAC,yBAAyB,CAAC;IAE9D;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;CAC3C;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB;;;;WAIG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;;;;;WAMG;QACH,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAEjE;;;WAGG;QACH,iBAAiB,CAAC,EAAE,eAAe,CAAC,yBAAyB,CAAC;KAC/D;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,wBAAyB,SAAQ,gBAAgB;IAChE;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,MAAM,CAAC,EAAE,aAAa,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,CAAC;IAE9D;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH;AAED,OAAO,EAAE,KAAK,oBAAoB,EAAE,CAAC"}

package/resources/vector-stores/file-batches.js

@@ -0,0 +1,50 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileBatches = void 0;
+const resource_1 = require("../../core/resource.js");
+const pagination_1 = require("../../core/pagination.js");
+const headers_1 = require("../../internal/headers.js");
+const path_1 = require("../../internal/utils/path.js");
+class FileBatches extends resource_1.APIResource {
+    /**
+     * Create a vector store file batch.
+     */
+    create(vectorStoreID, body, options) {
+        return this._client.post((0, path_1.path) `/vector_stores/${vectorStoreID}/file_batches`, {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+        });
+    }
+    /**
+     * Retrieves a vector store file batch.
+     */
+    retrieve(batchID, params, options) {
+        const { vector_store_id } = params;
+        return this._client.get((0, path_1.path) `/vector_stores/${vector_store_id}/file_batches/${batchID}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+        });
+    }
+    /**
+     * Cancel a vector store file batch. This attempts to cancel the processing of
+     * files in this batch as soon as possible.
+     */
+    cancel(batchID, params, options) {
+        const { vector_store_id } = params;
+        return this._client.post((0, path_1.path) `/vector_stores/${vector_store_id}/file_batches/${batchID}/cancel`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+        });
+    }
+    /**
+     * Returns a list of vector store files in a batch.
+     */
+    listFiles(batchID, params, options) {
+        const { vector_store_id, ...query } = params;
+        return this._client.getAPIList((0, path_1.path) `/vector_stores/${vector_store_id}/file_batches/${batchID}/files`, (pagination_1.CursorPage), { query, ...options, headers: (0, headers_1.buildHeaders)([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]) });
+    }
+}
+exports.FileBatches = FileBatches;
+//# sourceMappingURL=file-batches.js.map

package/resources/vector-stores/file-batches.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-batches.js","sourceRoot":"","sources":["../../src/resources/vector-stores/file-batches.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAKlD,yDAAuF;AACvF,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;OAEG;IACH,MAAM,CACJ,aAAqB,EACrB,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,kBAAkB,aAAa,eAAe,EAAE;YAC3E,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,aAAa,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,OAAe,EACf,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,kBAAkB,eAAe,iBAAiB,OAAO,EAAE,EAAE;YACvF,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,aAAa,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,MAAM,CACJ,OAAe,EACf,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,kBAAkB,eAAe,iBAAiB,OAAO,SAAS,EAAE;YAC/F,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,aAAa,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,SAAS,CACP,OAAe,EACf,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,kBAAkB,eAAe,iBAAiB,OAAO,QAAQ,EACrE,CAAA,uBAAoC,CAAA,EACpC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,aAAa,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,CACrG,CAAC;IACJ,CAAC;CACF;AA9DD,kCA8DC"}

package/resources/vector-stores/file-batches.mjs

@@ -0,0 +1,46 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { CursorPage } from "../../core/pagination.mjs";
+import { buildHeaders } from "../../internal/headers.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export class FileBatches extends APIResource {
+    /**
+     * Create a vector store file batch.
+     */
+    create(vectorStoreID, body, options) {
+        return this._client.post(path `/vector_stores/${vectorStoreID}/file_batches`, {
+            body,
+            ...options,
+            headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+        });
+    }
+    /**
+     * Retrieves a vector store file batch.
+     */
+    retrieve(batchID, params, options) {
+        const { vector_store_id } = params;
+        return this._client.get(path `/vector_stores/${vector_store_id}/file_batches/${batchID}`, {
+            ...options,
+            headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+        });
+    }
+    /**
+     * Cancel a vector store file batch. This attempts to cancel the processing of
+     * files in this batch as soon as possible.
+     */
+    cancel(batchID, params, options) {
+        const { vector_store_id } = params;
+        return this._client.post(path `/vector_stores/${vector_store_id}/file_batches/${batchID}/cancel`, {
+            ...options,
+            headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+        });
+    }
+    /**
+     * Returns a list of vector store files in a batch.
+     */
+    listFiles(batchID, params, options) {
+        const { vector_store_id, ...query } = params;
+        return this._client.getAPIList(path `/vector_stores/${vector_store_id}/file_batches/${batchID}/files`, (CursorPage), { query, ...options, headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]) });
+    }
+}
+//# sourceMappingURL=file-batches.mjs.map

package/resources/vector-stores/file-batches.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-batches.mjs","sourceRoot":"","sources":["../../src/resources/vector-stores/file-batches.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAKf,EAAE,UAAU,EAAsC;OAClD,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;OAEG;IACH,MAAM,CACJ,aAAqB,EACrB,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,aAAa,eAAe,EAAE;YAC3E,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,aAAa,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,OAAe,EACf,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kBAAkB,eAAe,iBAAiB,OAAO,EAAE,EAAE;YACvF,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,aAAa,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,MAAM,CACJ,OAAe,EACf,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,kBAAkB,eAAe,iBAAiB,OAAO,SAAS,EAAE;YAC/F,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,aAAa,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,SAAS,CACP,OAAe,EACf,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,kBAAkB,eAAe,iBAAiB,OAAO,QAAQ,EACrE,CAAA,UAAoC,CAAA,EACpC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,aAAa,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,CACrG,CAAC;IACJ,CAAC;CACF"}

package/resources/vector-stores/files.d.mts

@@ -0,0 +1,202 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as VectorStoresAPI from "./vector-stores.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { CursorPage, type CursorPageParams, Page, PagePromise } from "../../core/pagination.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare 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: string, body: FileCreateParams, options?: RequestOptions): APIPromise<VectorStoreFile>;
+    /**
+     * Retrieves a vector store file.
+     */
+    retrieve(fileID: string, params: FileRetrieveParams, options?: RequestOptions): APIPromise<VectorStoreFile>;
+    /**
+     * Update attributes on a vector store file.
+     */
+    update(fileID: string, params: FileUpdateParams, options?: RequestOptions): APIPromise<VectorStoreFile>;
+    /**
+     * Returns a list of vector store files.
+     */
+    list(vectorStoreID: string, query?: FileListParams | null | undefined, options?: RequestOptions): PagePromise<VectorStoreFilesPage, VectorStoreFile>;
+    /**
+     * 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.
+     */
+    delete(fileID: string, params: FileDeleteParams, options?: RequestOptions): APIPromise<VectorStoreFileDeleted>;
+    /**
+     * Retrieve the parsed contents of a vector store file.
+     */
+    content(fileID: string, params: FileContentParams, options?: RequestOptions): PagePromise<FileContentResponsesPage, FileContentResponse>;
+}
+export type VectorStoreFilesPage = CursorPage<VectorStoreFile>;
+export type FileContentResponsesPage = Page<FileContentResponse>;
+/**
+ * A list of files attached to a vector store.
+ */
+export interface VectorStoreFile {
+    /**
+     * The identifier, which can be referenced in API endpoints.
+     */
+    id: string;
+    /**
+     * The Unix timestamp (in seconds) for when the vector store file was created.
+     */
+    created_at: number;
+    /**
+     * The last error associated with this vector store file. Will be `null` if there
+     * are no errors.
+     */
+    last_error: VectorStoreFile.LastError | null;
+    /**
+     * The object type, which is always `vector_store.file`.
+     */
+    object: 'vector_store.file';
+    /**
+     * The status of the vector store file, which can be either `in_progress`,
+     * `completed`, `cancelled`, or `failed`. The status `completed` indicates that the
+     * vector store file is ready for use.
+     */
+    status: 'in_progress' | 'completed' | 'cancelled' | 'failed';
+    /**
+     * The total vector store usage in bytes. Note that this may be different from the
+     * original file size.
+     */
+    usage_bytes: number;
+    /**
+     * The ID of the
+     * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+     * that the [File](https://platform.openai.com/docs/api-reference/files) is
+     * attached to.
+     */
+    vector_store_id: string;
+    /**
+     * Set of 16 key-value pairs that can be attached to an object. This can be useful
+     * for storing additional information about the object in a structured format, and
+     * querying for objects via API or the dashboard. Keys are strings with a maximum
+     * length of 64 characters. Values are strings with a maximum length of 512
+     * characters, booleans, or numbers.
+     */
+    attributes?: {
+        [key: string]: string | number | boolean;
+    } | null;
+    /**
+     * The strategy used to chunk the file.
+     */
+    chunking_strategy?: VectorStoresAPI.FileChunkingStrategy;
+}
+export declare namespace VectorStoreFile {
+    /**
+     * The last error associated with this vector store file. Will be `null` if there
+     * are no errors.
+     */
+    interface LastError {
+        /**
+         * One of `server_error`, `unsupported_file`, or `invalid_file`.
+         */
+        code: 'server_error' | 'unsupported_file' | 'invalid_file';
+        /**
+         * A human-readable description of the error.
+         */
+        message: string;
+    }
+}
+export interface VectorStoreFileDeleted {
+    id: string;
+    deleted: boolean;
+    object: 'vector_store.file.deleted';
+}
+export interface FileContentResponse {
+    /**
+     * The text content
+     */
+    text?: string;
+    /**
+     * The content type (currently only `"text"`)
+     */
+    type?: string;
+}
+export interface FileCreateParams {
+    /**
+     * A [File](https://platform.openai.com/docs/api-reference/files) ID that the
+     * vector store should use. Useful for tools like `file_search` that can access
+     * files.
+     */
+    file_id: string;
+    /**
+     * Set of 16 key-value pairs that can be attached to an object. This can be useful
+     * for storing additional information about the object in a structured format, and
+     * querying for objects via API or the dashboard. Keys are strings with a maximum
+     * length of 64 characters. Values are strings with a maximum length of 512
+     * characters, booleans, or numbers.
+     */
+    attributes?: {
+        [key: string]: string | number | boolean;
+    } | null;
+    /**
+     * The chunking strategy used to chunk the file(s). If not set, will use the `auto`
+     * strategy. Only applicable if `file_ids` is non-empty.
+     */
+    chunking_strategy?: VectorStoresAPI.FileChunkingStrategyParam;
+}
+export interface FileRetrieveParams {
+    /**
+     * The ID of the vector store that the file belongs to.
+     */
+    vector_store_id: string;
+}
+export interface FileUpdateParams {
+    /**
+     * Path param: The ID of the vector store the file belongs to.
+     */
+    vector_store_id: string;
+    /**
+     * Body param: Set of 16 key-value pairs that can be attached to an object. This
+     * can be useful for storing additional information about the object in a
+     * structured format, and querying for objects via API or the dashboard. Keys are
+     * strings with a maximum length of 64 characters. Values are strings with a
+     * maximum length of 512 characters, booleans, or numbers.
+     */
+    attributes: {
+        [key: string]: string | number | boolean;
+    } | null;
+}
+export interface FileListParams extends CursorPageParams {
+    /**
+     * A cursor for use in pagination. `before` is an object ID that defines your place
+     * in the list. For instance, if you make a list request and receive 100 objects,
+     * starting with obj_foo, your subsequent call can include before=obj_foo in order
+     * to fetch the previous page of the list.
+     */
+    before?: string;
+    /**
+     * Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.
+     */
+    filter?: 'in_progress' | 'completed' | 'failed' | 'cancelled';
+    /**
+     * Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+     * order and `desc` for descending order.
+     */
+    order?: 'asc' | 'desc';
+}
+export interface FileDeleteParams {
+    /**
+     * The ID of the vector store that the file belongs to.
+     */
+    vector_store_id: string;
+}
+export interface FileContentParams {
+    /**
+     * The ID of the vector store.
+     */
+    vector_store_id: string;
+}
+export declare namespace Files {
+    export { type VectorStoreFile as VectorStoreFile, type VectorStoreFileDeleted as VectorStoreFileDeleted, type FileContentResponse as FileContentResponse, type VectorStoreFilesPage as VectorStoreFilesPage, type FileContentResponsesPage as FileContentResponsesPage, type FileCreateParams as FileCreateParams, type FileRetrieveParams as FileRetrieveParams, type FileUpdateParams as FileUpdateParams, type FileListParams as FileListParams, type FileDeleteParams as FileDeleteParams, type FileContentParams as FileContentParams, };
+}
+//# sourceMappingURL=files.d.mts.map

package/resources/vector-stores/files.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.d.mts","sourceRoot":"","sources":["../../src/resources/vector-stores/files.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,eAAe;OACpB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,IAAI,EAAE,WAAW,EAAE;OAExD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;OAIG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,gBAAgB,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAQ9B;;OAEG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;IAQ9B;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IASvG;;OAEG;IACH,IAAI,CACF,aAAa,EAAE,MAAM,EACrB,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,eAAe,CAAC;IAQrD;;;;;OAKG;IACH,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,gBAAgB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAQrC;;OAEG;IACH,OAAO,CACL,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,wBAAwB,EAAE,mBAAmB,CAAC;CAQ9D;AAED,MAAM,MAAM,oBAAoB,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC;AAG/D,MAAM,MAAM,wBAAwB,GAAG,IAAI,CAAC,mBAAmB,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,EAAE,eAAe,CAAC,SAAS,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,MAAM,EAAE,mBAAmB,CAAC;IAE5B;;;;OAIG;IACH,MAAM,EAAE,aAAa,GAAG,WAAW,GAAG,WAAW,GAAG,QAAQ,CAAC;IAE7D;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEjE;;OAEG;IACH,iBAAiB,CAAC,EAAE,eAAe,CAAC,oBAAoB,CAAC;CAC1D;AAED,yBAAiB,eAAe,CAAC;IAC/B;;;OAGG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,IAAI,EAAE,cAAc,GAAG,kBAAkB,GAAG,cAAc,CAAC;QAE3D;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,OAAO,CAAC;IAEjB,MAAM,EAAE,2BAA2B,CAAC;CACrC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEjE;;;OAGG;IACH,iBAAiB,CAAC,EAAE,eAAe,CAAC,yBAAyB,CAAC;CAC/D;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;;;OAMG;IACH,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CACjE;AAED,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,CAAC;IAE9D;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}