@mixedbread/sdk 0.50.1 → 0.51.0

package/src/resources/stores/stores.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../core/resource';
 import * as Shared from '../shared';
+import * as ContentAPI from '../extractions/content';
 import * as FilesAPI from './files';
 import {
   FileCreateParams,
@@ -18,8 +19,6 @@ import {
   StoreFile,
   StoreFileStatus,
 } from './files';
-import * as VectorStoresFilesAPI from '../vector-stores/files';
-import * as VectorStoresAPI from '../vector-stores/vector-stores';
 import { APIPromise } from '../../core/api-promise';
 import { Cursor, type CursorParams, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
@@ -139,6 +138,856 @@ export class Stores extends APIResource {
 
 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 namespace ScoredAudioURLInputChunk {
+  export 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;
+  }
+
+  export namespace MarkdownChunkGeneratedMetadata {
+    export interface ChunkHeading {
+      level: number;
+
+      text: string;
+    }
+
+    export interface HeadingContext {
+      level: number;
+
+      text: string;
+    }
+  }
+
+  export 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;
+  }
+
+  export interface PdfChunkGeneratedMetadata {
+    type?: 'pdf';
+
+    file_type?: 'application/pdf';
+
+    total_pages: number;
+
+    total_size: number;
+
+    [k: string]: unknown;
+  }
+
+  export interface CodeChunkGeneratedMetadata {
+    type?: 'code';
+
+    file_type: string;
+
+    language: string;
+
+    word_count: number;
+
+    file_size: number;
+
+    start_line?: number;
+
+    num_lines?: number;
+
+    [k: string]: unknown;
+  }
+
+  export 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;
+  }
+
+  export 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.
+   */
+  export 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 namespace ScoredImageURLInputChunk {
+  export 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;
+  }
+
+  export namespace MarkdownChunkGeneratedMetadata {
+    export interface ChunkHeading {
+      level: number;
+
+      text: string;
+    }
+
+    export interface HeadingContext {
+      level: number;
+
+      text: string;
+    }
+  }
+
+  export 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;
+  }
+
+  export interface PdfChunkGeneratedMetadata {
+    type?: 'pdf';
+
+    file_type?: 'application/pdf';
+
+    total_pages: number;
+
+    total_size: number;
+
+    [k: string]: unknown;
+  }
+
+  export interface CodeChunkGeneratedMetadata {
+    type?: 'code';
+
+    file_type: string;
+
+    language: string;
+
+    word_count: number;
+
+    file_size: number;
+
+    start_line?: number;
+
+    num_lines?: number;
+
+    [k: string]: unknown;
+  }
+
+  export 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;
+  }
+
+  export 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.
+   */
+  export 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 namespace ScoredTextInputChunk {
+  export 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;
+  }
+
+  export namespace MarkdownChunkGeneratedMetadata {
+    export interface ChunkHeading {
+      level: number;
+
+      text: string;
+    }
+
+    export interface HeadingContext {
+      level: number;
+
+      text: string;
+    }
+  }
+
+  export 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;
+  }
+
+  export interface PdfChunkGeneratedMetadata {
+    type?: 'pdf';
+
+    file_type?: 'application/pdf';
+
+    total_pages: number;
+
+    total_size: number;
+
+    [k: string]: unknown;
+  }
+
+  export interface CodeChunkGeneratedMetadata {
+    type?: 'code';
+
+    file_type: string;
+
+    language: string;
+
+    word_count: number;
+
+    file_size: number;
+
+    start_line?: number;
+
+    num_lines?: number;
+
+    [k: string]: unknown;
+  }
+
+  export 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;
+  }
+
+  export 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 namespace ScoredVideoURLInputChunk {
+  export 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;
+  }
+
+  export namespace MarkdownChunkGeneratedMetadata {
+    export interface ChunkHeading {
+      level: number;
+
+      text: string;
+    }
+
+    export interface HeadingContext {
+      level: number;
+
+      text: string;
+    }
+  }
+
+  export 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;
+  }
+
+  export interface PdfChunkGeneratedMetadata {
+    type?: 'pdf';
+
+    file_type?: 'application/pdf';
+
+    total_pages: number;
+
+    total_size: number;
+
+    [k: string]: unknown;
+  }
+
+  export interface CodeChunkGeneratedMetadata {
+    type?: 'code';
+
+    file_type: string;
+
+    language: string;
+
+    word_count: number;
+
+    file_size: number;
+
+    start_line?: number;
+
+    num_lines?: number;
+
+    [k: string]: unknown;
+  }
+
+  export 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;
+  }
+
+  export 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.
+   */
+  export 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.
  */
@@ -181,7 +1030,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
@@ -233,6 +1082,13 @@ export 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;
   }
 
   export namespace Config {
@@ -301,7 +1157,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
@@ -321,6 +1177,27 @@ export interface StoreChunkSearchOptions {
 }
 
 export namespace StoreChunkSearchOptions {
+  /**
+   * Represents a reranking configuration.
+   */
+  export 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.
    */
@@ -385,10 +1262,7 @@ export interface StoreQuestionAnsweringResponse {
    * Source documents used to generate the answer
    */
   sources?: Array<
-    | VectorStoresAPI.ScoredTextInputChunk
-    | VectorStoresAPI.ScoredImageURLInputChunk
-    | VectorStoresAPI.ScoredAudioURLInputChunk
-    | VectorStoresAPI.ScoredVideoURLInputChunk
+    ScoredTextInputChunk | ScoredImageURLInputChunk | ScoredAudioURLInputChunk | ScoredVideoURLInputChunk
   >;
 }
 
@@ -402,10 +1276,7 @@ export interface StoreSearchResponse {
    * The list of scored store file chunks
    */
   data: Array<
-    | VectorStoresAPI.ScoredTextInputChunk
-    | VectorStoresAPI.ScoredImageURLInputChunk
-    | VectorStoresAPI.ScoredAudioURLInputChunk
-    | VectorStoresAPI.ScoredVideoURLInputChunk
+    ScoredTextInputChunk | ScoredImageURLInputChunk | ScoredAudioURLInputChunk | ScoredVideoURLInputChunk
   >;
 }
 
@@ -429,7 +1300,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
@@ -456,6 +1327,13 @@ export 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;
   }
 
   export namespace Config {
@@ -490,7 +1368,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
@@ -614,7 +1492,7 @@ export interface StoreSearchParams {
   /**
    * Search query text
    */
-  query: string;
+  query: string | ContentAPI.ImageURLInput | ContentAPI.TextInput;
 
   /**
    * IDs or names of stores to search
@@ -650,6 +1528,11 @@ Stores.Files = Files;
 
 export declare namespace Stores {
   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,