@mixedbread/sdk 0.28.1 → 0.29.0

package/src/resources/vector-stores/files.ts

@@ -376,7 +376,13 @@ export namespace VectorStoreFile {
     /**
      * metadata of the chunk
      */
-    generated_metadata?: { [key: string]: unknown } | null;
+    generated_metadata?:
+      | TextInputChunk.MarkdownChunkGeneratedMetadata
+      | TextInputChunk.TextChunkGeneratedMetadata
+      | TextInputChunk.PdfChunkGeneratedMetadata
+      | TextInputChunk.CodeChunkGeneratedMetadata
+      | TextInputChunk.AudioChunkGeneratedMetadata
+      | null;
 
     /**
      * model used for this chunk
@@ -399,6 +405,98 @@ export namespace VectorStoreFile {
     text: string;
   }
 
+  export namespace TextInputChunk {
+    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>;
+
+      [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;
+
+      [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;
+
+      [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 ImageURLInputChunk {
     /**
      * position of the chunk in a file
@@ -413,7 +511,13 @@ export namespace VectorStoreFile {
     /**
      * metadata of the chunk
      */
-    generated_metadata?: { [key: string]: unknown } | null;
+    generated_metadata?:
+      | ImageURLInputChunk.MarkdownChunkGeneratedMetadata
+      | ImageURLInputChunk.TextChunkGeneratedMetadata
+      | ImageURLInputChunk.PdfChunkGeneratedMetadata
+      | ImageURLInputChunk.CodeChunkGeneratedMetadata
+      | ImageURLInputChunk.AudioChunkGeneratedMetadata
+      | null;
 
     /**
      * model used for this chunk
@@ -442,6 +546,96 @@ export namespace VectorStoreFile {
   }
 
   export namespace ImageURLInputChunk {
+    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>;
+
+      [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;
+
+      [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;
+
+      [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;
+    }
+
     /**
      * The image input specification.
      */
@@ -472,7 +666,13 @@ export namespace VectorStoreFile {
     /**
      * metadata of the chunk
      */
-    generated_metadata?: { [key: string]: unknown } | null;
+    generated_metadata?:
+      | AudioURLInputChunk.MarkdownChunkGeneratedMetadata
+      | AudioURLInputChunk.TextChunkGeneratedMetadata
+      | AudioURLInputChunk.PdfChunkGeneratedMetadata
+      | AudioURLInputChunk.CodeChunkGeneratedMetadata
+      | AudioURLInputChunk.AudioChunkGeneratedMetadata
+      | null;
 
     /**
      * model used for this chunk
@@ -506,6 +706,96 @@ export namespace VectorStoreFile {
   }
 
   export namespace AudioURLInputChunk {
+    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>;
+
+      [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;
+
+      [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;
+
+      [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;
+    }
+
     /**
      * The audio input specification.
      */
@@ -531,7 +821,13 @@ export namespace VectorStoreFile {
     /**
      * metadata of the chunk
      */
-    generated_metadata?: { [key: string]: unknown } | null;
+    generated_metadata?:
+      | VideoURLInputChunk.MarkdownChunkGeneratedMetadata
+      | VideoURLInputChunk.TextChunkGeneratedMetadata
+      | VideoURLInputChunk.PdfChunkGeneratedMetadata
+      | VideoURLInputChunk.CodeChunkGeneratedMetadata
+      | VideoURLInputChunk.AudioChunkGeneratedMetadata
+      | null;
 
     /**
      * model used for this chunk
@@ -560,6 +856,96 @@ export namespace VectorStoreFile {
   }
 
   export namespace VideoURLInputChunk {
+    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>;
+
+      [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;
+
+      [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;
+
+      [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;
+    }
+
     /**
      * The video input specification.
      */