@mixedbread/sdk 0.5.0 → 0.7.2

package/src/resources/embeddings.ts

@@ -13,15 +13,6 @@ export class Embeddings extends APIResource {
    * Args: params: The parameters for creating embeddings.
    *
    * Returns: EmbeddingCreateResponse: The response containing the embeddings.
-   *
-   * @example
-   * ```ts
-   * const embeddingCreateResponse =
-   *   await client.embeddings.create({
-   *     model: 'mixedbread-ai/mxbai-embed-large-v1',
-   *     input: 'x',
-   *   });
-   * ```
    */
   create(
     body: EmbeddingCreateParams,
@@ -31,6 +22,25 @@ export class Embeddings extends APIResource {
   }
 }
 
+/**
+ * Enumeration of encoding formats.
+ */
+export type EncodingFormat = 'float' | 'float16' | 'base64' | 'binary' | 'ubinary' | 'int8' | 'uint8';
+
+export type ObjectType =
+  | 'list'
+  | 'parsing_job'
+  | 'extraction_job'
+  | 'embedding'
+  | 'embedding_dict'
+  | 'rank_result'
+  | 'file'
+  | 'vector_store'
+  | 'vector_store.file'
+  | 'api_key'
+  | 'data_source'
+  | 'data_source.connector';
+
 export interface EmbeddingCreateParams {
   /**
    * The model to use for creating embeddings.
@@ -61,17 +71,13 @@ export interface EmbeddingCreateParams {
    * 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?: EncodingFormat | Array<EncodingFormat>;
 }
 
 export declare namespace Embeddings {
-  export { type EmbeddingCreateParams as EmbeddingCreateParams };
+  export {
+    type EncodingFormat as EncodingFormat,
+    type ObjectType as ObjectType,
+    type EmbeddingCreateParams as EmbeddingCreateParams,
+  };
 }

package/src/resources/extractions/content.ts

@@ -26,70 +26,78 @@ export interface ExtractionResult {
   warnings: Array<string>;
 }
 
-export interface ContentCreateParams {
-  /**
-   * The content to extract from
-   */
-  content: string | Array<string> | Array<ContentCreateParams.TextInput | ContentCreateParams.ImageURLInput>;
-
+/**
+ * Model for image input validation.
+ */
+export interface ImageURLInput {
   /**
-   * The JSON schema to use for extraction
+   * Input type identifier
    */
-  json_schema: Record<string, unknown>;
+  type?: 'image_url';
 
   /**
-   * Additional instructions for the extraction
+   * The image input specification.
    */
-  instructions?: string | null;
+  image_url: ImageURLInput.ImageURL;
 }
 
-export namespace ContentCreateParams {
+export namespace ImageURLInput {
   /**
-   * Model for text input validation.
-   *
-   * Attributes: type: Input type identifier, always "text" text: The actual text
-   * content, with length and whitespace constraints
+   * The image input specification.
    */
-  export interface TextInput {
+  export interface ImageURL {
     /**
-     * Input type identifier
+     * The image URL. Can be either a URL or a Data URI.
      */
-    type?: 'text';
+    url: string;
 
     /**
-     * Text content to process
+     * The image format/mimetype
      */
-    text: string;
+    format?: string;
   }
+}
 
+/**
+ * Model for text input validation.
+ *
+ * Attributes: type: Input type identifier, always "text" text: The actual text
+ * content, with length and whitespace constraints
+ */
+export interface TextInput {
   /**
-   * Model for image input validation.
+   * Input type identifier
    */
-  export interface ImageURLInput {
-    /**
-     * Input type identifier
-     */
-    type?: 'image_url';
+  type?: 'text';
 
-    /**
-     * The image input specification.
-     */
-    image_url: ImageURLInput.ImageURL;
-  }
+  /**
+   * Text content to process
+   */
+  text: string;
+}
 
-  export namespace ImageURLInput {
-    /**
-     * The image input specification.
-     */
-    export interface ImageURL {
-      /**
-       * The image URL. Can be either a URL or a Data URI.
-       */
-      url: string;
-    }
-  }
+export interface ContentCreateParams {
+  /**
+   * The content to extract from
+   */
+  content: string | Array<string> | Array<TextInput | ImageURLInput>;
+
+  /**
+   * The JSON schema to use for extraction
+   */
+  json_schema: Record<string, unknown>;
+
+  /**
+   * Additional instructions for the extraction
+   */
+  instructions?: string | null;
 }
 
 export declare namespace Content {
-  export { type ExtractionResult as ExtractionResult, type ContentCreateParams as ContentCreateParams };
+  export {
+    type ExtractionResult as ExtractionResult,
+    type ImageURLInput as ImageURLInput,
+    type TextInput as TextInput,
+    type ContentCreateParams as ContentCreateParams,
+  };
 }

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,32 @@
 // 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 {
+  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 +37,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
@@ -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,29 +411,17 @@ 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
@@ -439,7 +433,11 @@ 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,19 +39,7 @@ export interface EmbeddingCreateResponse {
   /**
    * The object type of the response
    */
-  object?:
-    | 'list'
-    | 'parsing_job'
-    | 'extraction_job'
-    | 'embedding'
-    | 'embedding_dict'
-    | 'rank_result'
-    | 'file'
-    | 'vector_store'
-    | 'vector_store.file'
-    | 'api_key'
-    | 'data_source'
-    | 'data_source.connector';
+  object?: EmbeddingsAPI.ObjectType;
 
   /**
    * Whether the embeddings are normalized.
@@ -60,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.
@@ -142,19 +123,7 @@ export interface RerankResponse {
   /**
    * The object type of the response
    */
-  object?:
-    | 'list'
-    | 'parsing_job'
-    | 'extraction_job'
-    | 'embedding'
-    | 'embedding_dict'
-    | 'rank_result'
-    | 'file'
-    | 'vector_store'
-    | 'vector_store.file'
-    | 'api_key'
-    | 'data_source'
-    | 'data_source.connector';
+  object?: 'list';
 
   /**
    * The number of documents to return.
@@ -221,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 {