@mixedbread/sdk 0.4.0 → 0.6.0

package/src/resources/extractions/extractions.ts

@@ -2,7 +2,7 @@
 
 import { APIResource } from '../../core/resource';
 import * as ContentAPI from './content';
-import { Content, ContentCreateParams, ExtractionResult } from './content';
+import { Content, ContentCreateParams, ExtractionResult, ImageURLInput, TextInput } from './content';
 import * as JobsAPI from './jobs';
 import { ExtractionJob, JobCreateParams, Jobs } from './jobs';
 import * as SchemaAPI from './schema';
@@ -42,6 +42,8 @@ export declare namespace Extractions {
   export {
     Content as Content,
     type ExtractionResult as ExtractionResult,
+    type ImageURLInput as ImageURLInput,
+    type TextInput as TextInput,
     type ContentCreateParams as ContentCreateParams,
   };
 }

package/src/resources/extractions/index.ts

@@ -1,6 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Content, type ExtractionResult, type ContentCreateParams } from './content';
+export {
+  Content,
+  type ExtractionResult,
+  type ImageURLInput,
+  type TextInput,
+  type ContentCreateParams,
+} from './content';
 export { Extractions } from './extractions';
 export { Jobs, type ExtractionJob, type JobCreateParams } from './jobs';
 export {

package/src/resources/extractions/jobs.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../core/resource';
 import * as ContentAPI from './content';
+import * as ParsingJobsAPI from '../parsing/jobs';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -72,7 +73,7 @@ export interface ExtractionJob {
   /**
    * Current status of the job
    */
-  status: 'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed';
+  status: ParsingJobsAPI.ParsingJobStatus;
 
   /**
    * The result of an extraction job.

package/src/resources/files.ts

@@ -132,6 +132,26 @@ export interface FileObject {
   updated_at: string;
 }
 
+/**
+ * Pagination model that includes total count of items.
+ */
+export interface PaginationWithTotal {
+  /**
+   * Maximum number of items to return per page
+   */
+  limit?: number;
+
+  /**
+   * Offset of the first item to return
+   */
+  offset?: number;
+
+  /**
+   * Total number of items available
+   */
+  total?: number;
+}
+
 export interface FileDeleteResponse {
   /**
    * The ID of the deleted file
@@ -168,6 +188,7 @@ export interface FileListParams extends LimitOffsetParams {}
 export declare namespace Files {
   export {
     type FileObject as FileObject,
+    type PaginationWithTotal as PaginationWithTotal,
     type FileDeleteResponse as FileDeleteResponse,
     type FileObjectsLimitOffset as FileObjectsLimitOffset,
     type FileCreateParams as FileCreateParams,

package/src/resources/index.ts

@@ -1,11 +1,33 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export * from './shared';
-export { Embeddings, type EmbeddingCreateParams } from './embeddings';
+export {
+  APIKeys,
+  type APIKey,
+  type APIKeyCreated,
+  type APIKeyDeleteResponse,
+  type APIKeyCreateParams,
+  type APIKeyListParams,
+  type APIKeysLimitOffset,
+} from './api-keys';
+export { Chat, type ChatCreateCompletionResponse } from './chat';
+export {
+  DataSources,
+  type DataSource,
+  type DataSourceOauth2Params,
+  type DataSourceType,
+  type DataSourceDeleteResponse,
+  type DataSourceCreateParams,
+  type DataSourceUpdateParams,
+  type DataSourceListParams,
+  type DataSourcesLimitOffset,
+} from './data-sources/data-sources';
+export { Embeddings, type EncodingFormat, type ObjectType, type EmbeddingCreateParams } from './embeddings';
 export { Extractions } from './extractions/extractions';
 export {
   Files,
   type FileObject,
+  type PaginationWithTotal,
   type FileDeleteResponse,
   type FileCreateParams,
   type FileUpdateParams,
@@ -16,11 +38,12 @@ export { Parsing } from './parsing/parsing';
 export {
   VectorStores,
   type ExpiresAfter,
-  type FileCounts,
-  type ScoredVectorStoreChunk,
+  type ScoredAudioURLInputChunk,
+  type ScoredImageURLInputChunk,
+  type ScoredTextInputChunk,
+  type ScoredVideoURLInputChunk,
   type VectorStore,
   type VectorStoreChunkSearchOptions,
-  type VectorStoreFileSearchOptions,
   type VectorStoreDeleteResponse,
   type VectorStoreQuestionAnsweringResponse,
   type VectorStoreSearchResponse,

package/src/resources/parsing/index.ts

@@ -2,7 +2,11 @@
 
 export {
   Jobs,
+  type ChunkingStrategy,
+  type ElementType,
+  type ParsingJobStatus,
   type ParsingJob,
+  type ReturnFormat,
   type JobListResponse,
   type JobDeleteResponse,
   type JobCreateParams,

package/src/resources/parsing/jobs.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as JobsAPI from './jobs';
 import { APIPromise } from '../../core/api-promise';
 import { LimitOffset, type LimitOffsetParams, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
@@ -162,6 +163,29 @@ export class Jobs extends APIResource {
 
 export type JobListResponsesLimitOffset = LimitOffset<JobListResponse>;
 
+/**
+ * Strategy used for chunking document content.
+ */
+export type ChunkingStrategy = 'page';
+
+/**
+ * Types of elements that can be extracted from a document.
+ */
+export type ElementType =
+  | 'caption'
+  | 'footnote'
+  | 'formula'
+  | 'list-item'
+  | 'page-footer'
+  | 'page-header'
+  | 'picture'
+  | 'section-header'
+  | 'table'
+  | 'text'
+  | 'title';
+
+export type ParsingJobStatus = 'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed';
+
 /**
  * A job for parsing documents with its current state and result.
  */
@@ -179,7 +203,7 @@ export interface ParsingJob {
   /**
    * The status of the job
    */
-  status: 'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed';
+  status: ParsingJobStatus;
 
   /**
    * The error of the job
@@ -225,29 +249,17 @@ export namespace ParsingJob {
     /**
      * The strategy used for chunking the document
      */
-    chunking_strategy: 'page';
+    chunking_strategy: JobsAPI.ChunkingStrategy;
 
     /**
      * The format of the returned content
      */
-    return_format: 'html' | 'markdown' | 'plain';
+    return_format: JobsAPI.ReturnFormat;
 
     /**
      * The types of elements extracted
      */
-    element_types: Array<
-      | 'caption'
-      | 'footnote'
-      | 'formula'
-      | 'list-item'
-      | 'page-footer'
-      | 'page-header'
-      | 'picture'
-      | 'section-header'
-      | 'table'
-      | 'text'
-      | 'title'
-    >;
+    element_types: Array<JobsAPI.ElementType>;
 
     /**
      * List of extracted chunks from the document
@@ -271,7 +283,7 @@ export namespace ParsingJob {
       content: string;
 
       /**
-       * The content to be used for embedding
+       * The content of the chunk to embed
        */
       content_to_embed: string;
 
@@ -289,18 +301,7 @@ export namespace ParsingJob {
         /**
          * The type of the extracted element
          */
-        type:
-          | 'caption'
-          | 'footnote'
-          | 'formula'
-          | 'list-item'
-          | 'page-footer'
-          | 'page-header'
-          | 'picture'
-          | 'section-header'
-          | 'table'
-          | 'text'
-          | 'title';
+        type: JobsAPI.ElementType;
 
         /**
          * The confidence score of the extraction
@@ -331,6 +332,11 @@ export namespace ParsingJob {
   }
 }
 
+/**
+ * Format options for the returned document content.
+ */
+export type ReturnFormat = 'html' | 'markdown' | 'plain';
+
 /**
  * A parsing job item for list responses, omitting result and error fields.
  */
@@ -348,7 +354,7 @@ export interface JobListResponse {
   /**
    * The status of the job
    */
-  status: 'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed';
+  status: ParsingJobStatus;
 
   /**
    * The started time of the job
@@ -405,36 +411,33 @@ export interface JobCreateParams {
   /**
    * The elements to extract from the document
    */
-  element_types?: Array<
-    | 'caption'
-    | 'footnote'
-    | 'formula'
-    | 'list-item'
-    | 'page-footer'
-    | 'page-header'
-    | 'picture'
-    | 'section-header'
-    | 'table'
-    | 'text'
-    | 'title'
-  > | null;
+  element_types?: Array<ElementType> | null;
 
   /**
    * The strategy to use for chunking the content
    */
-  chunking_strategy?: 'page';
+  chunking_strategy?: ChunkingStrategy;
 
   /**
    * The format of the returned content
    */
-  return_format?: 'html' | 'markdown' | 'plain';
+  return_format?: ReturnFormat;
+
+  /**
+   * The strategy to use for OCR
+   */
+  mode?: 'fast' | 'high_quality';
 }
 
 export interface JobListParams extends LimitOffsetParams {}
 
 export declare namespace Jobs {
   export {
+    type ChunkingStrategy as ChunkingStrategy,
+    type ElementType as ElementType,
+    type ParsingJobStatus as ParsingJobStatus,
     type ParsingJob as ParsingJob,
+    type ReturnFormat as ReturnFormat,
     type JobListResponse as JobListResponse,
     type JobDeleteResponse as JobDeleteResponse,
     type JobListResponsesLimitOffset as JobListResponsesLimitOffset,

package/src/resources/parsing/parsing.ts

@@ -3,6 +3,8 @@
 import { APIResource } from '../../core/resource';
 import * as JobsAPI from './jobs';
 import {
+  ChunkingStrategy,
+  ElementType,
   JobCreateParams,
   JobDeleteResponse,
   JobListParams,
@@ -10,6 +12,8 @@ import {
   JobListResponsesLimitOffset,
   Jobs,
   ParsingJob,
+  ParsingJobStatus,
+  ReturnFormat,
 } from './jobs';
 
 export class Parsing extends APIResource {
@@ -21,7 +25,11 @@ Parsing.Jobs = Jobs;
 export declare namespace Parsing {
   export {
     Jobs as Jobs,
+    type ChunkingStrategy as ChunkingStrategy,
+    type ElementType as ElementType,
+    type ParsingJobStatus as ParsingJobStatus,
     type ParsingJob as ParsingJob,
+    type ReturnFormat as ReturnFormat,
     type JobListResponse as JobListResponse,
     type JobDeleteResponse as JobDeleteResponse,
     type JobListResponsesLimitOffset as JobListResponsesLimitOffset,

package/src/resources/top-level.ts

@@ -1,5 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+import * as EmbeddingsAPI from './embeddings';
 import * as Shared from './shared';
 
 export interface Embedding {
@@ -38,17 +39,7 @@ export interface EmbeddingCreateResponse {
   /**
    * The object type of the response
    */
-  object?:
-    | 'list'
-    | 'parsing_job'
-    | 'job'
-    | 'embedding'
-    | 'embedding_dict'
-    | 'rank_result'
-    | 'file'
-    | 'vector_store'
-    | 'vector_store.file'
-    | 'api_key';
+  object?: EmbeddingsAPI.ObjectType;
 
   /**
    * Whether the embeddings are normalized.
@@ -58,15 +49,7 @@ export interface EmbeddingCreateResponse {
   /**
    * The encoding formats of the embeddings.
    */
-  encoding_format:
-    | 'float'
-    | 'float16'
-    | 'base64'
-    | 'binary'
-    | 'ubinary'
-    | 'int8'
-    | 'uint8'
-    | Array<'float' | 'float16' | 'base64' | 'binary' | 'ubinary' | 'int8' | 'uint8'>;
+  encoding_format: EmbeddingsAPI.EncodingFormat | Array<EmbeddingsAPI.EncodingFormat>;
 
   /**
    * The number of dimensions used for the embeddings.
@@ -140,17 +123,7 @@ export interface RerankResponse {
   /**
    * The object type of the response
    */
-  object?:
-    | 'list'
-    | 'parsing_job'
-    | 'job'
-    | 'embedding'
-    | 'embedding_dict'
-    | 'rank_result'
-    | 'file'
-    | 'vector_store'
-    | 'vector_store.file'
-    | 'api_key';
+  object?: 'list';
 
   /**
    * The number of documents to return.
@@ -217,15 +190,7 @@ export interface EmbedParams {
    * The encoding format(s) of the embeddings. Can be a single format or a list of
    * formats.
    */
-  encoding_format?:
-    | 'float'
-    | 'float16'
-    | 'base64'
-    | 'binary'
-    | 'ubinary'
-    | 'int8'
-    | 'uint8'
-    | Array<'float' | 'float16' | 'base64' | 'binary' | 'ubinary' | 'int8' | 'uint8'>;
+  encoding_format?: EmbeddingsAPI.EncodingFormat | Array<EmbeddingsAPI.EncodingFormat>;
 }
 
 export interface RerankParams {
@@ -258,6 +223,11 @@ export interface RerankParams {
    * Whether to return the documents.
    */
   return_input?: boolean;
+
+  /**
+   * Wether or not to rewrite the query before passing it to the reranking model
+   */
+  rewrite_query?: boolean;
 }
 
 export declare namespace TopLevel {

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

@@ -264,7 +264,12 @@ export interface ScoredVectorStoreFile {
   /**
    * chunks
    */
-  chunks: Array<VectorStoresAPI.ScoredVectorStoreChunk> | null;
+  chunks: Array<
+    | VectorStoresAPI.ScoredTextInputChunk
+    | VectorStoresAPI.ScoredImageURLInputChunk
+    | VectorStoresAPI.ScoredAudioURLInputChunk
+    | VectorStoresAPI.ScoredVideoURLInputChunk
+  > | null;
 }
 
 /**
@@ -432,7 +437,39 @@ export interface FileSearchParams {
   /**
    * Search configuration options
    */
-  search_options?: VectorStoresAPI.VectorStoreFileSearchOptions;
+  search_options?: FileSearchParams.SearchOptions;
+}
+
+export namespace FileSearchParams {
+  /**
+   * Search configuration options
+   */
+  export interface SearchOptions {
+    /**
+     * Minimum similarity score threshold
+     */
+    score_threshold?: number;
+
+    /**
+     * Whether to rewrite the query
+     */
+    rewrite_query?: boolean;
+
+    /**
+     * Whether to return file metadata
+     */
+    return_metadata?: boolean;
+
+    /**
+     * Whether to return matching text chunks
+     */
+    return_chunks?: boolean;
+
+    /**
+     * Number of chunks to return for each file
+     */
+    chunks_per_file?: number;
+  }
 }
 
 export declare namespace Files {

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

@@ -16,11 +16,12 @@ export {
 export {
   VectorStores,
   type ExpiresAfter,
-  type FileCounts,
-  type ScoredVectorStoreChunk,
+  type ScoredAudioURLInputChunk,
+  type ScoredImageURLInputChunk,
+  type ScoredTextInputChunk,
+  type ScoredVideoURLInputChunk,
   type VectorStore,
   type VectorStoreChunkSearchOptions,
-  type VectorStoreFileSearchOptions,
   type VectorStoreDeleteResponse,
   type VectorStoreQuestionAnsweringResponse,
   type VectorStoreSearchResponse,