@mixedbread/sdk 0.50.1 → 0.51.0

package/resources/stores/stores.d.ts

@@ -1,9 +1,8 @@
 import { APIResource } from "../../core/resource.js";
 import * as Shared from "../shared.js";
+import * as ContentAPI from "../extractions/content.js";
 import * as FilesAPI from "./files.js";
 import { FileCreateParams, FileDeleteParams, FileDeleteResponse, FileListParams, FileListResponse, FileRetrieveParams, FileSearchParams, FileSearchResponse, FileUpdateParams, Files, ScoredStoreFile, StoreFile, StoreFileStatus } from "./files.js";
-import * as VectorStoresFilesAPI from "../vector-stores/files.js";
-import * as VectorStoresAPI from "../vector-stores/vector-stores.js";
 import { APIPromise } from "../../core/api-promise.js";
 import { Cursor, type CursorParams, PagePromise } from "../../core/pagination.js";
 import { RequestOptions } from "../../internal/request-options.js";
@@ -86,6 +85,566 @@ export declare class Stores extends APIResource {
     search(body: StoreSearchParams, options?: RequestOptions): APIPromise<StoreSearchResponse>;
 }
 export type StoresCursor = Cursor<Store>;
+/**
+ * Represents an expiration policy for a store.
+ */
+export interface ExpiresAfter {
+    /**
+     * Anchor date for the expiration policy
+     */
+    anchor?: 'last_active_at';
+    /**
+     * Number of days after which the store expires
+     */
+    days?: number;
+}
+export interface ScoredAudioURLInputChunk {
+    /**
+     * position of the chunk in a file
+     */
+    chunk_index: number;
+    /**
+     * mime type of the chunk
+     */
+    mime_type?: string;
+    /**
+     * metadata of the chunk
+     */
+    generated_metadata?: ScoredAudioURLInputChunk.MarkdownChunkGeneratedMetadata | ScoredAudioURLInputChunk.TextChunkGeneratedMetadata | ScoredAudioURLInputChunk.PdfChunkGeneratedMetadata | ScoredAudioURLInputChunk.CodeChunkGeneratedMetadata | ScoredAudioURLInputChunk.AudioChunkGeneratedMetadata | ScoredAudioURLInputChunk.VideoChunkGeneratedMetadata | 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
+     */
+    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;
+    /**
+     * Model for audio URL validation.
+     */
+    audio_url?: ScoredAudioURLInputChunk.AudioURL | null;
+    /**
+     * The sampling rate of the audio.
+     */
+    sampling_rate: number;
+}
+export declare namespace ScoredAudioURLInputChunk {
+    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>;
+        start_line?: number;
+        num_lines?: number;
+        frontmatter?: {
+            [key: string]: unknown;
+        };
+        [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;
+        start_line?: number;
+        num_lines?: 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;
+        start_line?: number;
+        num_lines?: 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 VideoChunkGeneratedMetadata {
+        type?: 'video';
+        file_type: string;
+        file_size: number;
+        total_duration_seconds: number;
+        fps: number;
+        width: number;
+        height: number;
+        frame_count: number;
+        [k: string]: unknown;
+    }
+    /**
+     * Model for audio URL validation.
+     */
+    interface AudioURL {
+        /**
+         * The audio URL. Can be either a URL or a Data URI.
+         */
+        url: string;
+    }
+}
+export interface ScoredImageURLInputChunk {
+    /**
+     * position of the chunk in a file
+     */
+    chunk_index: number;
+    /**
+     * mime type of the chunk
+     */
+    mime_type?: string;
+    /**
+     * metadata of the chunk
+     */
+    generated_metadata?: ScoredImageURLInputChunk.MarkdownChunkGeneratedMetadata | ScoredImageURLInputChunk.TextChunkGeneratedMetadata | ScoredImageURLInputChunk.PdfChunkGeneratedMetadata | ScoredImageURLInputChunk.CodeChunkGeneratedMetadata | ScoredImageURLInputChunk.AudioChunkGeneratedMetadata | ScoredImageURLInputChunk.VideoChunkGeneratedMetadata | 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
+     */
+    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;
+    /**
+     * Model for image URL validation.
+     */
+    image_url?: ScoredImageURLInputChunk.ImageURL | null;
+}
+export declare namespace ScoredImageURLInputChunk {
+    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>;
+        start_line?: number;
+        num_lines?: number;
+        frontmatter?: {
+            [key: string]: unknown;
+        };
+        [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;
+        start_line?: number;
+        num_lines?: 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;
+        start_line?: number;
+        num_lines?: 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 VideoChunkGeneratedMetadata {
+        type?: 'video';
+        file_type: string;
+        file_size: number;
+        total_duration_seconds: number;
+        fps: number;
+        width: number;
+        height: number;
+        frame_count: number;
+        [k: string]: unknown;
+    }
+    /**
+     * Model for image URL validation.
+     */
+    interface ImageURL {
+        /**
+         * The image URL. Can be either a URL or a Data URI.
+         */
+        url: string;
+        /**
+         * The image format/mimetype
+         */
+        format?: string;
+    }
+}
+export interface ScoredTextInputChunk {
+    /**
+     * position of the chunk in a file
+     */
+    chunk_index: number;
+    /**
+     * mime type of the chunk
+     */
+    mime_type?: string;
+    /**
+     * metadata of the chunk
+     */
+    generated_metadata?: ScoredTextInputChunk.MarkdownChunkGeneratedMetadata | ScoredTextInputChunk.TextChunkGeneratedMetadata | ScoredTextInputChunk.PdfChunkGeneratedMetadata | ScoredTextInputChunk.CodeChunkGeneratedMetadata | ScoredTextInputChunk.AudioChunkGeneratedMetadata | ScoredTextInputChunk.VideoChunkGeneratedMetadata | 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
+     */
+    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
+     */
+    text?: string | null;
+}
+export declare namespace ScoredTextInputChunk {
+    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>;
+        start_line?: number;
+        num_lines?: number;
+        frontmatter?: {
+            [key: string]: unknown;
+        };
+        [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;
+        start_line?: number;
+        num_lines?: 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;
+        start_line?: number;
+        num_lines?: 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 VideoChunkGeneratedMetadata {
+        type?: 'video';
+        file_type: string;
+        file_size: number;
+        total_duration_seconds: number;
+        fps: number;
+        width: number;
+        height: number;
+        frame_count: number;
+        [k: string]: unknown;
+    }
+}
+export interface ScoredVideoURLInputChunk {
+    /**
+     * position of the chunk in a file
+     */
+    chunk_index: number;
+    /**
+     * mime type of the chunk
+     */
+    mime_type?: string;
+    /**
+     * metadata of the chunk
+     */
+    generated_metadata?: ScoredVideoURLInputChunk.MarkdownChunkGeneratedMetadata | ScoredVideoURLInputChunk.TextChunkGeneratedMetadata | ScoredVideoURLInputChunk.PdfChunkGeneratedMetadata | ScoredVideoURLInputChunk.CodeChunkGeneratedMetadata | ScoredVideoURLInputChunk.AudioChunkGeneratedMetadata | ScoredVideoURLInputChunk.VideoChunkGeneratedMetadata | 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
+     */
+    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;
+    /**
+     * Model for video URL validation.
+     */
+    video_url?: ScoredVideoURLInputChunk.VideoURL | null;
+}
+export declare namespace ScoredVideoURLInputChunk {
+    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>;
+        start_line?: number;
+        num_lines?: number;
+        frontmatter?: {
+            [key: string]: unknown;
+        };
+        [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;
+        start_line?: number;
+        num_lines?: 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;
+        start_line?: number;
+        num_lines?: 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 VideoChunkGeneratedMetadata {
+        type?: 'video';
+        file_type: string;
+        file_size: number;
+        total_duration_seconds: number;
+        fps: number;
+        width: number;
+        height: number;
+        frame_count: number;
+        [k: string]: unknown;
+    }
+    /**
+     * Model for video URL validation.
+     */
+    interface VideoURL {
+        /**
+         * The video URL. Can be either a URL or a Data URI.
+         */
+        url: string;
+    }
+}
 /**
  * Model representing a store with its metadata and timestamps.
  */
@@ -121,7 +680,7 @@ export interface Store {
     /**
      * Represents an expiration policy for a store.
      */
-    expires_after?: VectorStoresAPI.ExpiresAfter | null;
+    expires_after?: ExpiresAfter | null;
     /**
      * Processing status of the store
      */
@@ -164,6 +723,12 @@ export declare namespace Store {
          * Contextualize files with metadata
          */
         contextualization?: boolean | Config.ContextualizationConfig;
+        /**
+         * Whether to save original content in the store. When False, only vectors are
+         * indexed without the original content (index-only mode). This is useful for data
+         * privacy. Note: Reranking is not supported when content is not saved.
+         */
+        save_content?: boolean;
     }
     namespace Config {
         interface ContextualizationConfig {
@@ -222,7 +787,7 @@ export interface StoreChunkSearchOptions {
      * Whether to rerank results and optional reranking configuration. Ignored when
      * agentic is enabled (the agent handles ranking).
      */
-    rerank?: boolean | VectorStoresFilesAPI.RerankConfig | null;
+    rerank?: boolean | StoreChunkSearchOptions.RerankConfig | null;
     /**
      * Whether to use agentic multi-query search with automatic query decomposition and
      * ranking. When enabled, rewrite_query and rerank options are ignored.
@@ -238,6 +803,24 @@ export interface StoreChunkSearchOptions {
     apply_search_rules?: boolean;
 }
 export declare namespace StoreChunkSearchOptions {
+    /**
+     * Represents a reranking configuration.
+     */
+    interface RerankConfig {
+        /**
+         * The name of the reranking model
+         */
+        model?: string;
+        /**
+         * Whether to include metadata in the reranked results
+         */
+        with_metadata?: boolean | Array<string>;
+        /**
+         * Maximum number of results to return after reranking. If None, returns all
+         * reranked results.
+         */
+        top_k?: number | null;
+    }
     /**
      * Configuration for agentic multi-query search.
      */
@@ -297,7 +880,7 @@ export interface StoreQuestionAnsweringResponse {
     /**
      * Source documents used to generate the answer
      */
-    sources?: Array<VectorStoresAPI.ScoredTextInputChunk | VectorStoresAPI.ScoredImageURLInputChunk | VectorStoresAPI.ScoredAudioURLInputChunk | VectorStoresAPI.ScoredVideoURLInputChunk>;
+    sources?: Array<ScoredTextInputChunk | ScoredImageURLInputChunk | ScoredAudioURLInputChunk | ScoredVideoURLInputChunk>;
 }
 export interface StoreSearchResponse {
     /**
@@ -307,7 +890,7 @@ export interface StoreSearchResponse {
     /**
      * The list of scored store file chunks
      */
-    data: Array<VectorStoresAPI.ScoredTextInputChunk | VectorStoresAPI.ScoredImageURLInputChunk | VectorStoresAPI.ScoredAudioURLInputChunk | VectorStoresAPI.ScoredVideoURLInputChunk>;
+    data: Array<ScoredTextInputChunk | ScoredImageURLInputChunk | ScoredAudioURLInputChunk | ScoredVideoURLInputChunk>;
 }
 export interface StoreCreateParams {
     /**
@@ -326,7 +909,7 @@ export interface StoreCreateParams {
     /**
      * Represents an expiration policy for a store.
      */
-    expires_after?: VectorStoresAPI.ExpiresAfter | null;
+    expires_after?: ExpiresAfter | null;
     /**
      * Optional metadata key-value pairs
      */
@@ -349,6 +932,12 @@ export declare namespace StoreCreateParams {
          * Contextualize files with metadata
          */
         contextualization?: boolean | Config.ContextualizationConfig;
+        /**
+         * Whether to save original content in the store. When False, only vectors are
+         * indexed without the original content (index-only mode). This is useful for data
+         * privacy. Note: Reranking is not supported when content is not saved.
+         */
+        save_content?: boolean;
     }
     namespace Config {
         interface ContextualizationConfig {
@@ -378,7 +967,7 @@ export interface StoreUpdateParams {
     /**
      * Represents an expiration policy for a store.
      */
-    expires_after?: VectorStoresAPI.ExpiresAfter | null;
+    expires_after?: ExpiresAfter | null;
     /**
      * Optional metadata key-value pairs
      */
@@ -474,7 +1063,7 @@ export interface StoreSearchParams {
     /**
      * Search query text
      */
-    query: string;
+    query: string | ContentAPI.ImageURLInput | ContentAPI.TextInput;
     /**
      * IDs or names of stores to search
      */
@@ -497,7 +1086,7 @@ export interface StoreSearchParams {
     search_options?: StoreChunkSearchOptions;
 }
 export declare namespace Stores {
-    export { type Store as Store, type StoreChunkSearchOptions as StoreChunkSearchOptions, type StoreDeleteResponse as StoreDeleteResponse, type StoreMetadataFacetsResponse as StoreMetadataFacetsResponse, type StoreQuestionAnsweringResponse as StoreQuestionAnsweringResponse, type StoreSearchResponse as StoreSearchResponse, type StoresCursor as StoresCursor, type StoreCreateParams as StoreCreateParams, type StoreUpdateParams as StoreUpdateParams, type StoreListParams as StoreListParams, type StoreMetadataFacetsParams as StoreMetadataFacetsParams, type StoreQuestionAnsweringParams as StoreQuestionAnsweringParams, type StoreSearchParams as StoreSearchParams, };
+    export { type ExpiresAfter as ExpiresAfter, type ScoredAudioURLInputChunk as ScoredAudioURLInputChunk, type ScoredImageURLInputChunk as ScoredImageURLInputChunk, type ScoredTextInputChunk as ScoredTextInputChunk, type ScoredVideoURLInputChunk as ScoredVideoURLInputChunk, type Store as Store, type StoreChunkSearchOptions as StoreChunkSearchOptions, type StoreDeleteResponse as StoreDeleteResponse, type StoreMetadataFacetsResponse as StoreMetadataFacetsResponse, type StoreQuestionAnsweringResponse as StoreQuestionAnsweringResponse, type StoreSearchResponse as StoreSearchResponse, type StoresCursor as StoresCursor, type StoreCreateParams as StoreCreateParams, type StoreUpdateParams as StoreUpdateParams, type StoreListParams as StoreListParams, type StoreMetadataFacetsParams as StoreMetadataFacetsParams, type StoreQuestionAnsweringParams as StoreQuestionAnsweringParams, type StoreSearchParams as StoreSearchParams, };
     export { Files as Files, type ScoredStoreFile as ScoredStoreFile, type StoreFileStatus as StoreFileStatus, type StoreFile as StoreFile, type FileListResponse as FileListResponse, type FileDeleteResponse as FileDeleteResponse, type FileSearchResponse as FileSearchResponse, type FileCreateParams as FileCreateParams, type FileRetrieveParams as FileRetrieveParams, type FileUpdateParams as FileUpdateParams, type FileListParams as FileListParams, type FileDeleteParams as FileDeleteParams, type FileSearchParams as FileSearchParams, };
 }
 //# sourceMappingURL=stores.d.ts.map