@mixedbread/sdk 0.1.0-alpha.8

package/resources/vector-stores/files.mjs

@@ -0,0 +1,139 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../resource.mjs";
+import { isRequestOptions } from "../../core.mjs";
+import { LimitOffset } from "../../pagination.mjs";
+import * as polling from "../../lib/polling.mjs";
+export class Files extends APIResource {
+    /**
+     * Upload a new file to a vector store for indexing.
+     *
+     * Args: vector_store_id: The ID of the vector store to upload to file: The file to
+     * upload and index
+     *
+     * Returns: VectorStoreFile: Details of the uploaded and indexed file
+     */
+    create(vectorStoreId, body, options) {
+        return this._client.post(`/v1/vector_stores/${vectorStoreId}/files`, { body, ...options });
+    }
+    /**
+     * Get details of a specific file in a vector store.
+     *
+     * Args: vector_store_id: The ID of the vector store file_id: The ID of the file
+     *
+     * Returns: VectorStoreFile: Details of the vector store file
+     */
+    retrieve(vectorStoreId, fileId, options) {
+        return this._client.get(`/v1/vector_stores/${vectorStoreId}/files/${fileId}`, options);
+    }
+    list(vectorStoreId, query = {}, options) {
+        if (isRequestOptions(query)) {
+            return this.list(vectorStoreId, {}, query);
+        }
+        return this._client.getAPIList(`/v1/vector_stores/${vectorStoreId}/files`, VectorStoreFilesLimitOffset, {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Delete a file from a vector store.
+     *
+     * Args: vector_store_id: The ID of the vector store file_id: The ID of the file to
+     * delete
+     *
+     * Returns: VectorStoreFileDeleted: The deleted file
+     */
+    delete(vectorStoreId, fileId, options) {
+        return this._client.delete(`/v1/vector_stores/${vectorStoreId}/files/${fileId}`, options);
+    }
+    /**
+     * Perform semantic search across complete vector store files.
+     *
+     * This endpoint searches through vector store files using semantic similarity
+     * matching. Unlike chunk search, it returns complete matching files rather than
+     * individual chunks. Supports complex search queries with filters and returns
+     * relevance-scored results.
+     *
+     * Args: search_params: Search configuration including: - query text or
+     * embeddings - metadata filters - pagination parameters - sorting preferences
+     * \_state: API state dependency \_ctx: Service context dependency
+     *
+     * Returns: VectorStoreSearchFileResponse containing: - List of matched files with
+     * relevance scores - Pagination details including total result count
+     *
+     * Raises: HTTPException (400): If search parameters are invalid HTTPException
+     * (404): If no vector stores are found to search
+     */
+    search(body, options) {
+        return this._client.post('/v1/vector_stores/files/search', { body, ...options });
+    }
+    /**
+     * Poll for a file's processing status until it reaches a terminal state.
+     *
+     * @param vectorStoreId - The ID of the vector store
+     * @param fileId - The ID of the file to poll
+     * @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
+     * @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
+     * @param options - Additional request options
+     * @returns The file object once it reaches a terminal state
+     */
+    async poll(vectorStoreId, fileId, pollIntervalMs, pollTimeoutMs, options) {
+        const pollingIntervalMs = pollIntervalMs || 500;
+        const pollingTimeoutMs = pollTimeoutMs;
+        return polling.poll({
+            fn: () => this.retrieve(vectorStoreId, fileId, options),
+            condition: (result) => result.status === 'completed' || result.status === 'failed' || result.status === 'error',
+            intervalSeconds: pollingIntervalMs / 1000,
+            ...(pollingTimeoutMs && { timeoutSeconds: pollingTimeoutMs / 1000 }),
+        });
+    }
+    /**
+     * Create a file in a vector store and wait for it to be processed.
+     *
+     * @param vectorStoreId - The ID of the vector store to upload to
+     * @param body - The file creation parameters
+     * @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
+     * @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
+     * @param options - Additional request options
+     * @returns The file object once it reaches a terminal state
+     */
+    async createAndPoll(vectorStoreId, body, pollIntervalMs, pollTimeoutMs, options) {
+        const file = await this.create(vectorStoreId, body, options);
+        return this.poll(vectorStoreId, file.id, pollIntervalMs, pollTimeoutMs, options);
+    }
+    /**
+     * Upload a file to the files API and then create a file in a vector store.
+     * Note the file will be asynchronously processed.
+     *
+     * @param vectorStoreId - The ID of the vector store to add the file to
+     * @param file - The file to upload
+     * @param body - Additional parameters for the vector store file
+     * @param options - Additional request options
+     * @returns The created vector store file
+     */
+    async upload(vectorStoreId, file, body, options) {
+        const fileUploadResponse = await this._client.files.create({ file }, options);
+        return this.create(vectorStoreId, {
+            file_id: fileUploadResponse.id,
+            ...body,
+        }, options);
+    }
+    /**
+     * Upload a file to files API, create a file in a vector store, and poll until processing is complete.
+     *
+     * @param vectorStoreId - The ID of the vector store to add the file to
+     * @param file - The file to upload
+     * @param body - Additional parameters for the vector store file
+     * @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
+     * @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
+     * @param options - Additional request options
+     * @returns The vector store file object once it reaches a terminal state
+     */
+    async uploadAndPoll(vectorStoreId, file, body, pollIntervalMs, pollTimeoutMs, options) {
+        const vectorStoreFile = await this.upload(vectorStoreId, file, body, options);
+        return this.poll(vectorStoreId, vectorStoreFile.id, pollIntervalMs, pollTimeoutMs, options);
+    }
+}
+export class VectorStoreFilesLimitOffset extends LimitOffset {
+}
+Files.VectorStoreFilesLimitOffset = VectorStoreFilesLimitOffset;
+//# sourceMappingURL=files.mjs.map

package/resources/vector-stores/files.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.mjs","sourceRoot":"","sources":["../../src/resources/vector-stores/files.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAIpB,EAAE,WAAW,EAA0B;OACvC,KAAK,OAAO;AAGnB,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;OAOG;IACH,MAAM,CACJ,aAAqB,EACrB,IAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,aAAa,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CACN,aAAqB,EACrB,MAAc,EACd,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,aAAa,UAAU,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACzF,CAAC;IAmBD,IAAI,CACF,aAAqB,EACrB,QAA8C,EAAE,EAChD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SAC5C;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,qBAAqB,aAAa,QAAQ,EAAE,2BAA2B,EAAE;YACtG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CACJ,aAAqB,EACrB,MAAc,EACd,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,qBAAqB,aAAa,UAAU,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,IAAsB,EAAE,OAA6B;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,IAAI,CACR,aAAqB,EACrB,MAAc,EACd,cAAuB,EACvB,aAAsB,EACtB,OAA6B;QAE7B,MAAM,iBAAiB,GAAG,cAAc,IAAI,GAAG,CAAC;QAChD,MAAM,gBAAgB,GAAG,aAAa,CAAC;QAEvC,OAAO,OAAO,CAAC,IAAI,CAAC;YAClB,EAAE,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC;YACvD,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE,CACpB,MAAM,CAAC,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,KAAK,OAAO;YAC1F,eAAe,EAAE,iBAAiB,GAAG,IAAI;YACzC,GAAG,CAAC,gBAAgB,IAAI,EAAE,cAAc,EAAE,gBAAgB,GAAG,IAAI,EAAE,CAAC;SACrE,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,aAAa,CACjB,aAAqB,EACrB,IAAsB,EACtB,cAAuB,EACvB,aAAsB,EACtB,OAA6B;QAE7B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE,EAAE,cAAc,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,IAAgB,EAChB,IAAwC,EACxC,OAA6B;QAE7B,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;QAE9E,OAAO,IAAI,CAAC,MAAM,CAChB,aAAa,EACb;YACE,OAAO,EAAE,kBAAkB,CAAC,EAAE;YAC9B,GAAG,IAAI;SACR,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,aAAa,CACjB,aAAqB,EACrB,IAAgB,EAChB,IAAwC,EACxC,cAAuB,EACvB,aAAsB,EACtB,OAA6B;QAE7B,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC9E,OAAO,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,eAAe,CAAC,EAAE,EAAE,cAAc,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;IAC9F,CAAC;CACF;AAED,MAAM,OAAO,2BAA4B,SAAQ,WAA4B;CAAG;AA8MhF,KAAK,CAAC,2BAA2B,GAAG,2BAA2B,CAAC"}

package/resources/vector-stores/index.d.ts

@@ -0,0 +1,3 @@
+export { VectorStoreFilesLimitOffset, Files, type ScoredVectorStoreFile, type VectorStoreFile, type FileDeleteResponse, type FileSearchResponse, type FileCreateParams, type FileListParams, type FileSearchParams, } from "./files.js";
+export { VectorStoresLimitOffset, VectorStores, type ExpiresAfter, type FileCounts, type ScoredVectorStoreChunk, type VectorStore, type VectorStoreSearchOptions, type VectorStoreDeleteResponse, type VectorStoreQuestionAnsweringResponse, type VectorStoreSearchResponse, type VectorStoreCreateParams, type VectorStoreUpdateParams, type VectorStoreListParams, type VectorStoreQuestionAnsweringParams, type VectorStoreSearchParams, } from "./vector-stores.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/vector-stores/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/vector-stores/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,2BAA2B,EAC3B,KAAK,EACL,KAAK,qBAAqB,EAC1B,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,gBAAgB,GACtB,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,uBAAuB,EACvB,YAAY,EACZ,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,KAAK,sBAAsB,EAC3B,KAAK,WAAW,EAChB,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC9B,KAAK,oCAAoC,EACzC,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,kCAAkC,EACvC,KAAK,uBAAuB,GAC7B,MAAM,iBAAiB,CAAC"}

package/resources/vector-stores/index.js

@@ -0,0 +1,11 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VectorStores = exports.VectorStoresLimitOffset = exports.Files = exports.VectorStoreFilesLimitOffset = void 0;
+var files_1 = require("./files.js");
+Object.defineProperty(exports, "VectorStoreFilesLimitOffset", { enumerable: true, get: function () { return files_1.VectorStoreFilesLimitOffset; } });
+Object.defineProperty(exports, "Files", { enumerable: true, get: function () { return files_1.Files; } });
+var vector_stores_1 = require("./vector-stores.js");
+Object.defineProperty(exports, "VectorStoresLimitOffset", { enumerable: true, get: function () { return vector_stores_1.VectorStoresLimitOffset; } });
+Object.defineProperty(exports, "VectorStores", { enumerable: true, get: function () { return vector_stores_1.VectorStores; } });
+//# sourceMappingURL=index.js.map

package/resources/vector-stores/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/vector-stores/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,oCAUiB;AATf,oHAAA,2BAA2B,OAAA;AAC3B,8FAAA,KAAK,OAAA;AASP,oDAgByB;AAfvB,wHAAA,uBAAuB,OAAA;AACvB,6GAAA,YAAY,OAAA"}

package/resources/vector-stores/index.mjs

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { VectorStoreFilesLimitOffset, Files, } from "./files.mjs";
+export { VectorStoresLimitOffset, VectorStores, } from "./vector-stores.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/vector-stores/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/vector-stores/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,2BAA2B,EAC3B,KAAK,GAQN;OACM,EACL,uBAAuB,EACvB,YAAY,GAcb"}

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

@@ -0,0 +1,400 @@
+import { APIResource } from "../../resource.js";
+import * as Core from "../../core.js";
+import * as Shared from "../shared.js";
+import * as FilesAPI from "./files.js";
+import { FileCreateParams, FileDeleteResponse, FileListParams, FileSearchParams, FileSearchResponse, Files, ScoredVectorStoreFile, VectorStoreFile, VectorStoreFilesLimitOffset } from "./files.js";
+import { LimitOffset, type LimitOffsetParams } from "../../pagination.js";
+export declare class VectorStores extends APIResource {
+    files: FilesAPI.Files;
+    /**
+     * Create a new vector store.
+     *
+     * Args: vector_store_create: VectorStoreCreate object containing the name,
+     * description, and metadata.
+     *
+     * Returns: VectorStore: The response containing the created vector store details.
+     */
+    create(body: VectorStoreCreateParams, options?: Core.RequestOptions): Core.APIPromise<VectorStore>;
+    /**
+     * Get a vector store by ID.
+     *
+     * Args: vector_store_id: The ID of the vector store to retrieve.
+     *
+     * Returns: VectorStore: The response containing the vector store details.
+     */
+    retrieve(vectorStoreId: string, options?: Core.RequestOptions): Core.APIPromise<VectorStore>;
+    /**
+     * Update a vector store by ID.
+     *
+     * Args: vector_store_id: The ID of the vector store to update.
+     * vector_store_update: VectorStoreCreate object containing the name, description,
+     * and metadata.
+     *
+     * Returns: VectorStore: The response containing the updated vector store details.
+     */
+    update(vectorStoreId: string, body: VectorStoreUpdateParams, options?: Core.RequestOptions): Core.APIPromise<VectorStore>;
+    /**
+     * List all vector stores.
+     *
+     * Args: pagination: The pagination options.
+     *
+     * Returns: VectorStoreListResponse: The list of vector stores.
+     */
+    list(query?: VectorStoreListParams, options?: Core.RequestOptions): Core.PagePromise<VectorStoresLimitOffset, VectorStore>;
+    list(options?: Core.RequestOptions): Core.PagePromise<VectorStoresLimitOffset, VectorStore>;
+    /**
+     * Delete a vector store by ID.
+     *
+     * Args: vector_store_id: The ID of the vector store to delete.
+     *
+     * Returns: VectorStore: The response containing the deleted vector store details.
+     */
+    delete(vectorStoreId: string, options?: Core.RequestOptions): Core.APIPromise<VectorStoreDeleteResponse>;
+    /**
+     * Question answering
+     */
+    questionAnswering(body: VectorStoreQuestionAnsweringParams, options?: Core.RequestOptions): Core.APIPromise<unknown>;
+    /**
+     * Perform semantic search across vector store chunks.
+     *
+     * This endpoint searches through vector store chunks using semantic similarity
+     * matching. It supports complex search queries with filters and returns
+     * relevance-scored results.
+     *
+     * Args: search_params: Search configuration including: - query text or
+     * embeddings - metadata filters - pagination parameters - sorting preferences
+     * \_state: API state dependency \_ctx: Service context dependency
+     *
+     * Returns: VectorStoreSearchChunkResponse containing: - List of matched chunks
+     * with relevance scores - Pagination details including total result count
+     *
+     * Raises: HTTPException (400): If search parameters are invalid HTTPException
+     * (404): If no vector stores are found to search
+     */
+    search(body: VectorStoreSearchParams, options?: Core.RequestOptions): Core.APIPromise<VectorStoreSearchResponse>;
+}
+export declare class VectorStoresLimitOffset extends LimitOffset<VectorStore> {
+}
+/**
+ * Represents an expiration policy for a vector store.
+ */
+export interface ExpiresAfter {
+    /**
+     * Anchor date for the expiration policy
+     */
+    anchor?: 'last_active_at';
+    /**
+     * Number of days after which the vector store expires
+     */
+    days?: number;
+}
+/**
+ * Tracks counts of files in different states within a vector store.
+ */
+export interface FileCounts {
+    /**
+     * Number of files currently being processed
+     */
+    in_progress?: number;
+    /**
+     * Number of files whose processing was cancelled
+     */
+    cancelled?: number;
+    /**
+     * Number of successfully processed files
+     */
+    completed?: number;
+    /**
+     * Number of files that failed processing
+     */
+    failed?: number;
+    /**
+     * Total number of files
+     */
+    total?: number;
+}
+export interface ScoredVectorStoreChunk {
+    /**
+     * position of the chunk in a file
+     */
+    position: number;
+    /**
+     * value of the chunk
+     */
+    value?: string | ScoredVectorStoreChunk.ImageURLInput | ScoredVectorStoreChunk.TextInput | Record<string, unknown> | null;
+    /**
+     * content of the chunk
+     */
+    content?: string | null;
+    /**
+     * score of the chunk
+     */
+    score: number;
+    /**
+     * file id
+     */
+    file_id: string;
+    /**
+     * vector store id
+     */
+    vector_store_id: string;
+    /**
+     * file metadata
+     */
+    metadata?: unknown;
+}
+export declare namespace ScoredVectorStoreChunk {
+    /**
+     * Model for image input validation.
+     */
+    interface ImageURLInput {
+        /**
+         * Input type identifier
+         */
+        type?: 'image_url';
+        /**
+         * The image input specification.
+         */
+        image: ImageURLInput.Image;
+    }
+    namespace ImageURLInput {
+        /**
+         * The image input specification.
+         */
+        interface Image {
+            /**
+             * The image URL. Can be either a URL or a Data URI.
+             */
+            url: string;
+        }
+    }
+    /**
+     * Model for text input validation.
+     *
+     * Attributes: type: Input type identifier, always "text" text: The actual text
+     * content, with length and whitespace constraints
+     */
+    interface TextInput {
+        /**
+         * Input type identifier
+         */
+        type?: 'text';
+        /**
+         * Text content to process
+         */
+        text: string;
+    }
+}
+/**
+ * Model representing a vector store with its metadata and timestamps.
+ */
+export interface VectorStore {
+    /**
+     * Unique identifier for the vector store
+     */
+    id: string;
+    /**
+     * Name of the vector store
+     */
+    name: string;
+    /**
+     * Detailed description of the vector store's purpose and contents
+     */
+    description?: string | null;
+    /**
+     * Additional metadata associated with the vector store
+     */
+    metadata?: unknown;
+    /**
+     * Counts of files in different states
+     */
+    file_counts?: FileCounts;
+    /**
+     * Represents an expiration policy for a vector store.
+     */
+    expires_after?: ExpiresAfter | null;
+    /**
+     * Processing status of the vector store
+     */
+    status?: 'expired' | 'in_progress' | 'completed';
+    /**
+     * Timestamp when the vector store was created
+     */
+    created_at: string;
+    /**
+     * Timestamp when the vector store was last updated
+     */
+    updated_at: string;
+    /**
+     * Timestamp when the vector store was last used
+     */
+    last_active_at?: string | null;
+    /**
+     * Optional expiration timestamp for the vector store
+     */
+    expires_at?: string | null;
+    /**
+     * Type of the object
+     */
+    object?: 'vector_store';
+}
+/**
+ * Options for configuring vector store searches.
+ */
+export interface VectorStoreSearchOptions {
+    /**
+     * Whether to return file metadata
+     */
+    return_metadata?: boolean;
+    /**
+     * Whether to return matching text chunks
+     */
+    return_chunks?: boolean;
+    /**
+     * Minimum similarity score threshold
+     */
+    score_threshold?: number;
+    /**
+     * Whether to rewrite the query
+     */
+    rewrite_query?: boolean;
+}
+/**
+ * Response model for vector store deletion.
+ */
+export interface VectorStoreDeleteResponse {
+    /**
+     * ID of the deleted vector store
+     */
+    id: string;
+    /**
+     * Whether the deletion was successful
+     */
+    deleted: boolean;
+    /**
+     * Type of the deleted object
+     */
+    object?: 'vector_store';
+}
+export type VectorStoreQuestionAnsweringResponse = unknown;
+export interface VectorStoreSearchResponse {
+    /**
+     * The object type of the response
+     */
+    object?: 'list';
+    /**
+     * The list of scored vector store file chunks
+     */
+    data: Array<ScoredVectorStoreChunk>;
+}
+export interface VectorStoreCreateParams {
+    /**
+     * Name for the new vector store
+     */
+    name?: string | null;
+    /**
+     * Description of the vector store
+     */
+    description?: string | null;
+    /**
+     * Represents an expiration policy for a vector store.
+     */
+    expires_after?: ExpiresAfter | null;
+    /**
+     * Optional metadata key-value pairs
+     */
+    metadata?: unknown;
+    /**
+     * Optional list of file IDs
+     */
+    file_ids?: Array<string> | null;
+}
+export interface VectorStoreUpdateParams {
+    /**
+     * New name for the vector store
+     */
+    name?: string | null;
+    /**
+     * New description
+     */
+    description?: string | null;
+    /**
+     * Represents an expiration policy for a vector store.
+     */
+    expires_after?: ExpiresAfter | null;
+    /**
+     * Optional metadata key-value pairs
+     */
+    metadata?: unknown;
+}
+export interface VectorStoreListParams extends LimitOffsetParams {
+}
+export interface VectorStoreQuestionAnsweringParams {
+    /**
+     * Question to answer. If not provided, the question will be extracted from the
+     * passed messages.
+     */
+    query?: string;
+    /**
+     * IDs of vector stores to search
+     */
+    vector_store_ids: Array<string>;
+    /**
+     * Number of results to return
+     */
+    top_k?: number;
+    /**
+     * Optional filter conditions
+     */
+    filters?: Shared.SearchFilter | Shared.SearchFilterCondition | Array<Shared.SearchFilter | Shared.SearchFilterCondition> | null;
+    /**
+     * Search configuration options
+     */
+    search_options?: VectorStoreSearchOptions;
+    /**
+     * Whether to stream the answer
+     */
+    stream?: boolean;
+    /**
+     * Question answering configuration options
+     */
+    qa_options?: VectorStoreQuestionAnsweringParams.QaOptions;
+}
+export declare namespace VectorStoreQuestionAnsweringParams {
+    /**
+     * Question answering configuration options
+     */
+    interface QaOptions {
+        /**
+         * Whether to use citations
+         */
+        cite?: boolean;
+    }
+}
+export interface VectorStoreSearchParams {
+    /**
+     * Search query text
+     */
+    query: string;
+    /**
+     * IDs of vector stores to search
+     */
+    vector_store_ids: Array<string>;
+    /**
+     * Number of results to return
+     */
+    top_k?: number;
+    /**
+     * Optional filter conditions
+     */
+    filters?: Shared.SearchFilter | Shared.SearchFilterCondition | Array<Shared.SearchFilter | Shared.SearchFilterCondition> | null;
+    /**
+     * Search configuration options
+     */
+    search_options?: VectorStoreSearchOptions;
+}
+export declare namespace VectorStores {
+    export { type ExpiresAfter as ExpiresAfter, type FileCounts as FileCounts, type ScoredVectorStoreChunk as ScoredVectorStoreChunk, type VectorStore as VectorStore, type VectorStoreSearchOptions as VectorStoreSearchOptions, type VectorStoreDeleteResponse as VectorStoreDeleteResponse, type VectorStoreQuestionAnsweringResponse as VectorStoreQuestionAnsweringResponse, type VectorStoreSearchResponse as VectorStoreSearchResponse, VectorStoresLimitOffset as VectorStoresLimitOffset, type VectorStoreCreateParams as VectorStoreCreateParams, type VectorStoreUpdateParams as VectorStoreUpdateParams, type VectorStoreListParams as VectorStoreListParams, type VectorStoreQuestionAnsweringParams as VectorStoreQuestionAnsweringParams, type VectorStoreSearchParams as VectorStoreSearchParams, };
+    export { Files as Files, type ScoredVectorStoreFile as ScoredVectorStoreFile, type VectorStoreFile as VectorStoreFile, type FileDeleteResponse as FileDeleteResponse, type FileSearchResponse as FileSearchResponse, VectorStoreFilesLimitOffset as VectorStoreFilesLimitOffset, type FileCreateParams as FileCreateParams, type FileListParams as FileListParams, type FileSearchParams as FileSearchParams, };
+}
+//# sourceMappingURL=vector-stores.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"vector-stores.d.ts","sourceRoot":"","sources":["../../src/resources/vector-stores/vector-stores.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,QAAQ,MAAM,SAAS,CAAC;AACpC,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,KAAK,EACL,qBAAqB,EACrB,eAAe,EACf,2BAA2B,EAC5B,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,WAAW,EAAE,KAAK,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAEvE,qBAAa,YAAa,SAAQ,WAAW;IAC3C,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;IAIlG;;;;;;OAMG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;IAI5F;;;;;;;;OAQG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;IAI/B;;;;;;OAMG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,uBAAuB,EAAE,WAAW,CAAC;IACzD,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,uBAAuB,EAAE,WAAW,CAAC;IAW3F;;;;;;OAMG;IACH,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;IAIxG;;OAEG;IACH,iBAAiB,CACf,IAAI,EAAE,kCAAkC,EACxC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;IAI3B;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;CAG9C;AAED,qBAAa,uBAAwB,SAAQ,WAAW,CAAC,WAAW,CAAC;CAAG;AAExE;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EACF,MAAM,GACN,sBAAsB,CAAC,aAAa,GACpC,sBAAsB,CAAC,SAAS,GAChC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,IAAI,CAAC;IAET;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC;QAEnB;;WAEG;QACH,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC;KAC5B;IAED,UAAiB,aAAa,CAAC;QAC7B;;WAEG;QACH,UAAiB,KAAK;YACpB;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;IAED;;;;;OAKG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,UAAU,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,aAAa,GAAG,WAAW,CAAC;IAEjD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,MAAM,oCAAoC,GAAG,OAAO,CAAC;AAE3D,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;CACrC;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,aAAa,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,aAAa,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;CAAG;AAEnE,MAAM,WAAW,kCAAkC;IACjD;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,gBAAgB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EACJ,MAAM,CAAC,YAAY,GACnB,MAAM,CAAC,qBAAqB,GAC5B,KAAK,CAAC,MAAM,CAAC,YAAY,GAAG,MAAM,CAAC,qBAAqB,CAAC,GACzD,IAAI,CAAC;IAET;;OAEG;IACH,cAAc,CAAC,EAAE,wBAAwB,CAAC;IAE1C;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,kCAAkC,CAAC,SAAS,CAAC;CAC3D;AAED,yBAAiB,kCAAkC,CAAC;IAClD;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,gBAAgB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EACJ,MAAM,CAAC,YAAY,GACnB,MAAM,CAAC,qBAAqB,GAC5B,KAAK,CAAC,MAAM,CAAC,YAAY,GAAG,MAAM,CAAC,qBAAqB,CAAC,GACzD,IAAI,CAAC;IAET;;OAEG;IACH,cAAc,CAAC,EAAE,wBAAwB,CAAC;CAC3C;AAMD,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,uBAAuB,IAAI,uBAAuB,EAClD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,2BAA2B,IAAI,2BAA2B,EAC1D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}