@mixedbread/sdk 0.29.0 → 0.30.0

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

@@ -1,64 +1,38 @@
 import { APIResource } from "../../core/resource.mjs";
 import * as FilesAPI from "./files.mjs";
 import * as Shared from "../shared.mjs";
-import * as VectorStoresAPI from "./vector-stores.mjs";
 import { APIPromise } from "../../core/api-promise.mjs";
 import { RequestOptions } from "../../internal/request-options.mjs";
 import { Uploadable } from "../../uploads.mjs";
 export declare class Files extends APIResource {
     /**
-     * Add an already uploaded file to a vector store.
+     * DEPRECATED: Use POST /stores/{store_identifier}/files instead
      *
-     * Args: vector_store_identifier: The ID or name of the vector store to add the
-     * file to file: The file to add and index
-     *
-     * Returns: VectorStoreFile: Details of the added and indexed file
+     * @deprecated
      */
     create(vectorStoreIdentifier: string, body: FileCreateParams, options?: RequestOptions): APIPromise<VectorStoreFile>;
     /**
-     * Get details of a specific file in a vector store.
-     *
-     * Args: vector_store_identifier: The ID or name of the vector store file_id: The
-     * ID of the file
+     * DEPRECATED: Use GET /stores/{store_identifier}/files/{file_id} instead
      *
-     * Returns: VectorStoreFile: Details of the vector store file
+     * @deprecated
      */
     retrieve(fileID: string, params: FileRetrieveParams, options?: RequestOptions): APIPromise<VectorStoreFile>;
     /**
-     * List files indexed in a vector store with pagination and metadata filter.
+     * DEPRECATED: Use POST /stores/{store_identifier}/files/list instead
      *
-     * Args: vector_store_identifier: The ID or name of the vector store pagination:
-     * Pagination parameters and metadata filter
-     *
-     * Returns: VectorStoreFileListResponse: Paginated list of vector store files
+     * @deprecated
      */
     list(vectorStoreIdentifier: string, body: FileListParams, options?: RequestOptions): APIPromise<FileListResponse>;
     /**
-     * Delete a file from a vector store.
-     *
-     * Args: vector_store_identifier: The ID or name of the vector store file_id: The
-     * ID of the file to delete
+     * DEPRECATED: Use DELETE /stores/{store_identifier}/files/{file_id} instead
      *
-     * Returns: VectorStoreFileDeleted: The deleted file
+     * @deprecated
      */
     delete(fileID: string, params: FileDeleteParams, options?: RequestOptions): APIPromise<FileDeleteResponse>;
     /**
-     * Perform semantic search across complete vector store files.
+     * DEPRECATED: Use POST /stores/{store_identifier}/files/search instead
      *
-     * 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
+     * @deprecated
      */
     search(body: FileSearchParams, options?: RequestOptions): APIPromise<FileSearchResponse>;
     /**
@@ -126,7 +100,7 @@ export interface RerankConfig {
     top_k?: number | null;
 }
 /**
- * Represents a scored file stored in a vector store.
+ * Represents a scored store file.
  */
 export interface ScoredVectorStoreFile {
     /**
@@ -144,17 +118,17 @@ export interface ScoredVectorStoreFile {
     /**
      * Processing status of the file
      */
-    status?: VectorStoreFileStatus;
+    status?: 'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed';
     /**
      * Last error message if processing failed
      */
     last_error?: unknown;
     /**
-     * ID of the containing vector store
+     * ID of the containing store
      */
     vector_store_id: string;
     /**
-     * Timestamp of vector store file creation
+     * Timestamp of store file creation
      */
     created_at: string;
     /**
@@ -172,15 +146,290 @@ export interface ScoredVectorStoreFile {
     /**
      * Array of scored file chunks
      */
-    chunks: Array<VectorStoresAPI.ScoredTextInputChunk | VectorStoresAPI.ScoredImageURLInputChunk | VectorStoresAPI.ScoredAudioURLInputChunk | VectorStoresAPI.ScoredVideoURLInputChunk> | null;
+    chunks: Array<ScoredVectorStoreFile.MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredTextInputChunk | ScoredVectorStoreFile.MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredImageURLInputChunk | ScoredVectorStoreFile.MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredAudioURLInputChunk | ScoredVectorStoreFile.MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredVideoURLInputChunk> | null;
     /**
      * score of the file
      */
     score: number;
 }
+export declare namespace ScoredVectorStoreFile {
+    /**
+     * Scored text chunk for deprecated API.
+     */
+    interface MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredTextInputChunk {
+        /**
+         * position of the chunk in a file
+         */
+        chunk_index: number;
+        /**
+         * mime type of the chunk
+         */
+        mime_type?: string;
+        /**
+         * metadata of the chunk
+         */
+        generated_metadata?: {
+            [key: string]: unknown;
+        } | null;
+        /**
+         * model used for this chunk
+         */
+        model?: string | null;
+        /**
+         * score of the chunk
+         */
+        score: number;
+        /**
+         * file id
+         */
+        file_id: string;
+        /**
+         * filename
+         */
+        filename: string;
+        /**
+         * store id
+         */
+        vector_store_id: string;
+        /**
+         * file metadata
+         */
+        metadata?: unknown;
+        /**
+         * Input type identifier
+         */
+        type?: 'text';
+        /**
+         * The offset of the text in the file relative to the start of the file.
+         */
+        offset?: number;
+        /**
+         * Text content to process
+         */
+        text: string;
+    }
+    /**
+     * Scored image chunk for deprecated API.
+     */
+    interface MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredImageURLInputChunk {
+        /**
+         * position of the chunk in a file
+         */
+        chunk_index: number;
+        /**
+         * mime type of the chunk
+         */
+        mime_type?: string;
+        /**
+         * metadata of the chunk
+         */
+        generated_metadata?: {
+            [key: string]: unknown;
+        } | null;
+        /**
+         * model used for this chunk
+         */
+        model?: string | null;
+        /**
+         * score of the chunk
+         */
+        score: number;
+        /**
+         * file id
+         */
+        file_id: string;
+        /**
+         * filename
+         */
+        filename: string;
+        /**
+         * store id
+         */
+        vector_store_id: string;
+        /**
+         * file metadata
+         */
+        metadata?: unknown;
+        /**
+         * Input type identifier
+         */
+        type?: 'image_url';
+        /**
+         * ocr text of the image
+         */
+        ocr_text?: string | null;
+        /**
+         * summary of the image
+         */
+        summary?: string | null;
+        /**
+         * The image input specification.
+         */
+        image_url: MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredImageURLInputChunk.ImageURL;
+    }
+    namespace MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredImageURLInputChunk {
+        /**
+         * The image input specification.
+         */
+        interface ImageURL {
+            /**
+             * The image URL. Can be either a URL or a Data URI.
+             */
+            url: string;
+            /**
+             * The image format/mimetype
+             */
+            format?: string;
+        }
+    }
+    /**
+     * Scored audio chunk for deprecated API.
+     */
+    interface MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredAudioURLInputChunk {
+        /**
+         * position of the chunk in a file
+         */
+        chunk_index: number;
+        /**
+         * mime type of the chunk
+         */
+        mime_type?: string;
+        /**
+         * metadata of the chunk
+         */
+        generated_metadata?: {
+            [key: string]: unknown;
+        } | null;
+        /**
+         * model used for this chunk
+         */
+        model?: string | null;
+        /**
+         * score of the chunk
+         */
+        score: number;
+        /**
+         * file id
+         */
+        file_id: string;
+        /**
+         * filename
+         */
+        filename: string;
+        /**
+         * store id
+         */
+        vector_store_id: string;
+        /**
+         * file metadata
+         */
+        metadata?: unknown;
+        /**
+         * Input type identifier
+         */
+        type?: 'audio_url';
+        /**
+         * speech recognition (sr) text of the audio
+         */
+        transcription?: string | null;
+        /**
+         * summary of the audio
+         */
+        summary?: string | null;
+        /**
+         * The audio input specification.
+         */
+        audio_url: MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredAudioURLInputChunk.AudioURL;
+        /**
+         * The sampling rate of the audio.
+         */
+        sampling_rate: number;
+    }
+    namespace MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredAudioURLInputChunk {
+        /**
+         * The audio input specification.
+         */
+        interface AudioURL {
+            /**
+             * The audio URL. Can be either a URL or a Data URI.
+             */
+            url: string;
+        }
+    }
+    /**
+     * Scored video chunk for deprecated API.
+     */
+    interface MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredVideoURLInputChunk {
+        /**
+         * position of the chunk in a file
+         */
+        chunk_index: number;
+        /**
+         * mime type of the chunk
+         */
+        mime_type?: string;
+        /**
+         * metadata of the chunk
+         */
+        generated_metadata?: {
+            [key: string]: unknown;
+        } | null;
+        /**
+         * model used for this chunk
+         */
+        model?: string | null;
+        /**
+         * score of the chunk
+         */
+        score: number;
+        /**
+         * file id
+         */
+        file_id: string;
+        /**
+         * filename
+         */
+        filename: string;
+        /**
+         * store id
+         */
+        vector_store_id: string;
+        /**
+         * file metadata
+         */
+        metadata?: unknown;
+        /**
+         * Input type identifier
+         */
+        type?: 'video_url';
+        /**
+         * speech recognition (sr) text of the video
+         */
+        transcription?: string | null;
+        /**
+         * summary of the video
+         */
+        summary?: string | null;
+        /**
+         * The video input specification.
+         */
+        video_url: MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredVideoURLInputChunk.VideoURL;
+    }
+    namespace MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredVideoURLInputChunk {
+        /**
+         * The video input specification.
+         */
+        interface VideoURL {
+            /**
+             * The video URL. Can be either a URL or a Data URI.
+             */
+            url: string;
+        }
+    }
+}
 export type VectorStoreFileStatus = 'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed';
 /**
- * Represents a file stored in a vector store.
+ * Represents a file stored in a store.
  */
 export interface VectorStoreFile {
     /**
@@ -198,17 +447,17 @@ export interface VectorStoreFile {
     /**
      * Processing status of the file
      */
-    status?: VectorStoreFileStatus;
+    status?: 'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed';
     /**
      * Last error message if processing failed
      */
     last_error?: unknown;
     /**
-     * ID of the containing vector store
+     * ID of the containing store
      */
     vector_store_id: string;
     /**
-     * Timestamp of vector store file creation
+     * Timestamp of store file creation
      */
     created_at: string;
     /**
@@ -241,7 +490,9 @@ export declare namespace VectorStoreFile {
         /**
          * metadata of the chunk
          */
-        generated_metadata?: TextInputChunk.MarkdownChunkGeneratedMetadata | TextInputChunk.TextChunkGeneratedMetadata | TextInputChunk.PdfChunkGeneratedMetadata | TextInputChunk.CodeChunkGeneratedMetadata | TextInputChunk.AudioChunkGeneratedMetadata | null;
+        generated_metadata?: {
+            [key: string]: unknown;
+        } | null;
         /**
          * model used for this chunk
          */
@@ -259,61 +510,6 @@ export declare namespace VectorStoreFile {
          */
         text: string;
     }
-    namespace TextInputChunk {
-        interface MarkdownChunkGeneratedMetadata {
-            type?: 'markdown';
-            file_type?: 'text/markdown';
-            language: string;
-            word_count: number;
-            file_size: number;
-            chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
-            heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
-            [k: string]: unknown;
-        }
-        namespace MarkdownChunkGeneratedMetadata {
-            interface ChunkHeading {
-                level: number;
-                text: string;
-            }
-            interface HeadingContext {
-                level: number;
-                text: string;
-            }
-        }
-        interface TextChunkGeneratedMetadata {
-            type?: 'text';
-            file_type?: 'text/plain';
-            language: string;
-            word_count: number;
-            file_size: number;
-            [k: string]: unknown;
-        }
-        interface PdfChunkGeneratedMetadata {
-            type?: 'pdf';
-            file_type?: 'application/pdf';
-            total_pages: number;
-            total_size: number;
-            [k: string]: unknown;
-        }
-        interface CodeChunkGeneratedMetadata {
-            type?: 'code';
-            file_type: string;
-            language: string;
-            word_count: number;
-            file_size: number;
-            [k: string]: unknown;
-        }
-        interface AudioChunkGeneratedMetadata {
-            type?: 'audio';
-            file_type: string;
-            file_size: number;
-            total_duration_seconds: number;
-            sample_rate: number;
-            channels: number;
-            audio_format: number;
-            [k: string]: unknown;
-        }
-    }
     interface ImageURLInputChunk {
         /**
          * position of the chunk in a file
@@ -326,7 +522,9 @@ export declare namespace VectorStoreFile {
         /**
          * metadata of the chunk
          */
-        generated_metadata?: ImageURLInputChunk.MarkdownChunkGeneratedMetadata | ImageURLInputChunk.TextChunkGeneratedMetadata | ImageURLInputChunk.PdfChunkGeneratedMetadata | ImageURLInputChunk.CodeChunkGeneratedMetadata | ImageURLInputChunk.AudioChunkGeneratedMetadata | null;
+        generated_metadata?: {
+            [key: string]: unknown;
+        } | null;
         /**
          * model used for this chunk
          */
@@ -349,59 +547,6 @@ export declare namespace VectorStoreFile {
         image_url: ImageURLInputChunk.ImageURL;
     }
     namespace ImageURLInputChunk {
-        interface MarkdownChunkGeneratedMetadata {
-            type?: 'markdown';
-            file_type?: 'text/markdown';
-            language: string;
-            word_count: number;
-            file_size: number;
-            chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
-            heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
-            [k: string]: unknown;
-        }
-        namespace MarkdownChunkGeneratedMetadata {
-            interface ChunkHeading {
-                level: number;
-                text: string;
-            }
-            interface HeadingContext {
-                level: number;
-                text: string;
-            }
-        }
-        interface TextChunkGeneratedMetadata {
-            type?: 'text';
-            file_type?: 'text/plain';
-            language: string;
-            word_count: number;
-            file_size: number;
-            [k: string]: unknown;
-        }
-        interface PdfChunkGeneratedMetadata {
-            type?: 'pdf';
-            file_type?: 'application/pdf';
-            total_pages: number;
-            total_size: number;
-            [k: string]: unknown;
-        }
-        interface CodeChunkGeneratedMetadata {
-            type?: 'code';
-            file_type: string;
-            language: string;
-            word_count: number;
-            file_size: number;
-            [k: string]: unknown;
-        }
-        interface AudioChunkGeneratedMetadata {
-            type?: 'audio';
-            file_type: string;
-            file_size: number;
-            total_duration_seconds: number;
-            sample_rate: number;
-            channels: number;
-            audio_format: number;
-            [k: string]: unknown;
-        }
         /**
          * The image input specification.
          */
@@ -428,7 +573,9 @@ export declare namespace VectorStoreFile {
         /**
          * metadata of the chunk
          */
-        generated_metadata?: AudioURLInputChunk.MarkdownChunkGeneratedMetadata | AudioURLInputChunk.TextChunkGeneratedMetadata | AudioURLInputChunk.PdfChunkGeneratedMetadata | AudioURLInputChunk.CodeChunkGeneratedMetadata | AudioURLInputChunk.AudioChunkGeneratedMetadata | null;
+        generated_metadata?: {
+            [key: string]: unknown;
+        } | null;
         /**
          * model used for this chunk
          */
@@ -455,59 +602,6 @@ export declare namespace VectorStoreFile {
         sampling_rate: number;
     }
     namespace AudioURLInputChunk {
-        interface MarkdownChunkGeneratedMetadata {
-            type?: 'markdown';
-            file_type?: 'text/markdown';
-            language: string;
-            word_count: number;
-            file_size: number;
-            chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
-            heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
-            [k: string]: unknown;
-        }
-        namespace MarkdownChunkGeneratedMetadata {
-            interface ChunkHeading {
-                level: number;
-                text: string;
-            }
-            interface HeadingContext {
-                level: number;
-                text: string;
-            }
-        }
-        interface TextChunkGeneratedMetadata {
-            type?: 'text';
-            file_type?: 'text/plain';
-            language: string;
-            word_count: number;
-            file_size: number;
-            [k: string]: unknown;
-        }
-        interface PdfChunkGeneratedMetadata {
-            type?: 'pdf';
-            file_type?: 'application/pdf';
-            total_pages: number;
-            total_size: number;
-            [k: string]: unknown;
-        }
-        interface CodeChunkGeneratedMetadata {
-            type?: 'code';
-            file_type: string;
-            language: string;
-            word_count: number;
-            file_size: number;
-            [k: string]: unknown;
-        }
-        interface AudioChunkGeneratedMetadata {
-            type?: 'audio';
-            file_type: string;
-            file_size: number;
-            total_duration_seconds: number;
-            sample_rate: number;
-            channels: number;
-            audio_format: number;
-            [k: string]: unknown;
-        }
         /**
          * The audio input specification.
          */
@@ -530,7 +624,9 @@ export declare namespace VectorStoreFile {
         /**
          * metadata of the chunk
          */
-        generated_metadata?: VideoURLInputChunk.MarkdownChunkGeneratedMetadata | VideoURLInputChunk.TextChunkGeneratedMetadata | VideoURLInputChunk.PdfChunkGeneratedMetadata | VideoURLInputChunk.CodeChunkGeneratedMetadata | VideoURLInputChunk.AudioChunkGeneratedMetadata | null;
+        generated_metadata?: {
+            [key: string]: unknown;
+        } | null;
         /**
          * model used for this chunk
          */
@@ -553,59 +649,6 @@ export declare namespace VectorStoreFile {
         video_url: VideoURLInputChunk.VideoURL;
     }
     namespace VideoURLInputChunk {
-        interface MarkdownChunkGeneratedMetadata {
-            type?: 'markdown';
-            file_type?: 'text/markdown';
-            language: string;
-            word_count: number;
-            file_size: number;
-            chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
-            heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
-            [k: string]: unknown;
-        }
-        namespace MarkdownChunkGeneratedMetadata {
-            interface ChunkHeading {
-                level: number;
-                text: string;
-            }
-            interface HeadingContext {
-                level: number;
-                text: string;
-            }
-        }
-        interface TextChunkGeneratedMetadata {
-            type?: 'text';
-            file_type?: 'text/plain';
-            language: string;
-            word_count: number;
-            file_size: number;
-            [k: string]: unknown;
-        }
-        interface PdfChunkGeneratedMetadata {
-            type?: 'pdf';
-            file_type?: 'application/pdf';
-            total_pages: number;
-            total_size: number;
-            [k: string]: unknown;
-        }
-        interface CodeChunkGeneratedMetadata {
-            type?: 'code';
-            file_type: string;
-            language: string;
-            word_count: number;
-            file_size: number;
-            [k: string]: unknown;
-        }
-        interface AudioChunkGeneratedMetadata {
-            type?: 'audio';
-            file_type: string;
-            file_size: number;
-            total_duration_seconds: number;
-            sample_rate: number;
-            channels: number;
-            audio_format: number;
-            [k: string]: unknown;
-        }
         /**
          * The video input specification.
          */
@@ -617,6 +660,9 @@ export declare namespace VectorStoreFile {
         }
     }
 }
+/**
+ * List response wrapper for vector store files.
+ */
 export interface FileListResponse {
     /**
      * Response model for cursor-based pagination.
@@ -676,6 +722,9 @@ export interface FileDeleteResponse {
      */
     object?: 'vector_store.file';
 }
+/**
+ * Search response wrapper for vector store files.
+ */
 export interface FileSearchResponse {
     /**
      * The object type of the response
@@ -747,7 +796,7 @@ export interface FileListParams {
     /**
      * Status to filter by
      */
-    statuses?: Array<VectorStoreFileStatus> | null;
+    statuses?: Array<'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed'> | null;
     /**
      * Metadata filter to apply to the query
      */