@mixedbread/sdk 0.3.0 → 0.5.0

package/src/pagination.ts

@@ -1,82 +1,2 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { AbstractPage, Response, APIClient, FinalRequestOptions, PageInfo } from './core';
-
-export interface LimitOffsetResponse<Item> {
-  data: Array<Item>;
-
-  pagination: LimitOffsetResponse.Pagination;
-}
-
-export namespace LimitOffsetResponse {
-  export interface Pagination {
-    total?: number;
-
-    offset?: number;
-  }
-}
-
-export interface LimitOffsetParams {
-  /**
-   * The number of elements to skip.
-   */
-  offset?: number;
-
-  /**
-   * The maximum number of elements to fetch.
-   */
-  limit?: number;
-}
-
-export class LimitOffset<Item> extends AbstractPage<Item> implements LimitOffsetResponse<Item> {
-  data: Array<Item>;
-
-  pagination: LimitOffsetResponse.Pagination;
-
-  constructor(
-    client: APIClient,
-    response: Response,
-    body: LimitOffsetResponse<Item>,
-    options: FinalRequestOptions,
-  ) {
-    super(client, response, body, options);
-
-    this.data = body.data || [];
-    this.pagination = body.pagination || {};
-  }
-
-  getPaginatedItems(): Item[] {
-    return this.data ?? [];
-  }
-
-  // @deprecated Please use `nextPageInfo()` instead
-  nextPageParams(): Partial<LimitOffsetParams> | null {
-    const info = this.nextPageInfo();
-    if (!info) return null;
-    if ('params' in info) return info.params;
-    const params = Object.fromEntries(info.url.searchParams);
-    if (!Object.keys(params).length) return null;
-    return params;
-  }
-
-  nextPageInfo(): PageInfo | null {
-    const offset = this.pagination?.offset;
-    if (!offset) {
-      return null;
-    }
-
-    const length = this.getPaginatedItems().length;
-    const currentCount = offset + length;
-
-    const totalCount = this.pagination?.total;
-    if (!totalCount) {
-      return null;
-    }
-
-    if (currentCount < totalCount) {
-      return { params: { offset: currentCount } };
-    }
-
-    return null;
-  }
-}
+/** @deprecated Import from ./core/pagination instead */
+export * from './core/pagination';

package/src/resource.ts

@@ -1,11 +1,2 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import type { Mixedbread } from './index';
-
-export class APIResource {
-  protected _client: Mixedbread;
-
-  constructor(client: Mixedbread) {
-    this._client = client;
-  }
-}
+/** @deprecated Import from ./core/resource instead */
+export * from './core/resource';

package/src/resources/embeddings.ts

@@ -1,8 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../resource';
-import * as Core from '../core';
+import { APIResource } from '../core/resource';
 import * as TopLevelAPI from './top-level';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
 
 export class Embeddings extends APIResource {
   /**
@@ -12,11 +13,20 @@ 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,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<TopLevelAPI.EmbeddingCreateResponse> {
+    options?: RequestOptions,
+  ): APIPromise<TopLevelAPI.EmbeddingCreateResponse> {
     return this._client.post('/v1/embeddings', { body, ...options });
   }
 }

package/src/resources/extractions/content.ts

@@ -1,7 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
 
 export class Content extends APIResource {
   /**
@@ -11,7 +12,7 @@ export class Content extends APIResource {
    *
    * Returns: The extracted content.
    */
-  create(body: ContentCreateParams, options?: Core.RequestOptions): Core.APIPromise<ExtractionResult> {
+  create(body: ContentCreateParams, options?: RequestOptions): APIPromise<ExtractionResult> {
     return this._client.post('/v1/extractions/content', { body, ...options });
   }
 }
@@ -29,12 +30,64 @@ export interface ContentCreateParams {
   /**
    * The content to extract from
    */
-  content: string;
+  content: string | Array<string> | Array<ContentCreateParams.TextInput | ContentCreateParams.ImageURLInput>;
 
   /**
    * The JSON schema to use for extraction
    */
   json_schema: Record<string, unknown>;
+
+  /**
+   * Additional instructions for the extraction
+   */
+  instructions?: string | null;
+}
+
+export namespace ContentCreateParams {
+  /**
+   * 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 {
+    /**
+     * Input type identifier
+     */
+    type?: 'text';
+
+    /**
+     * Text content to process
+     */
+    text: string;
+  }
+
+  /**
+   * Model for image input validation.
+   */
+  export interface ImageURLInput {
+    /**
+     * Input type identifier
+     */
+    type?: 'image_url';
+
+    /**
+     * The image input specification.
+     */
+    image_url: ImageURLInput.ImageURL;
+  }
+
+  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 declare namespace Content {

package/src/resources/extractions/extractions.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
+import { APIResource } from '../../core/resource';
 import * as ContentAPI from './content';
 import { Content, ContentCreateParams, ExtractionResult } from './content';
 import * as JobsAPI from './jobs';

package/src/resources/extractions/jobs.ts

@@ -1,8 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
+import { APIResource } from '../../core/resource';
 import * as ContentAPI from './content';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 export class Jobs extends APIResource {
   /**
@@ -12,7 +14,7 @@ export class Jobs extends APIResource {
    *
    * Returns: The created extraction job.
    */
-  create(body: JobCreateParams, options?: Core.RequestOptions): Core.APIPromise<ExtractionJob> {
+  create(body: JobCreateParams, options?: RequestOptions): APIPromise<ExtractionJob> {
     return this._client.post('/v1/extractions/jobs', { body, ...options });
   }
 
@@ -23,8 +25,8 @@ export class Jobs extends APIResource {
    *
    * Returns: Detailed information about the extraction job.
    */
-  retrieve(jobId: string, options?: Core.RequestOptions): Core.APIPromise<ExtractionJob> {
-    return this._client.get(`/v1/extractions/jobs/${jobId}`, options);
+  retrieve(jobID: string, options?: RequestOptions): APIPromise<ExtractionJob> {
+    return this._client.get(path`/v1/extractions/jobs/${jobID}`, options);
   }
 }
 

package/src/resources/extractions/schema.ts

@@ -1,7 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
 
 export class Schema extends APIResource {
   /**
@@ -11,7 +12,7 @@ export class Schema extends APIResource {
    *
    * Returns: The created schema.
    */
-  create(body: SchemaCreateParams, options?: Core.RequestOptions): Core.APIPromise<CreatedJsonSchema> {
+  create(body: SchemaCreateParams, options?: RequestOptions): APIPromise<CreatedJsonSchema> {
     return this._client.post('/v1/extractions/schema', { body, ...options });
   }
 
@@ -22,7 +23,7 @@ export class Schema extends APIResource {
    *
    * Returns: The enhanced schema.
    */
-  enhance(body: SchemaEnhanceParams, options?: Core.RequestOptions): Core.APIPromise<EnhancedJsonSchema> {
+  enhance(body: SchemaEnhanceParams, options?: RequestOptions): APIPromise<EnhancedJsonSchema> {
     return this._client.post('/v1/extractions/schema/enhance', { body, ...options });
   }
 
@@ -33,7 +34,7 @@ export class Schema extends APIResource {
    *
    * Returns: The validation result.
    */
-  validate(body: SchemaValidateParams, options?: Core.RequestOptions): Core.APIPromise<ValidatedJsonSchema> {
+  validate(body: SchemaValidateParams, options?: RequestOptions): APIPromise<ValidatedJsonSchema> {
     return this._client.post('/v1/extractions/schema/validate', { body, ...options });
   }
 }

package/src/resources/files.ts

@@ -1,10 +1,13 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../resource';
-import { isRequestOptions } from '../core';
-import * as Core from '../core';
-import { LimitOffset, type LimitOffsetParams } from '../pagination';
-import { type Response } from '../_shims/index';
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { LimitOffset, type LimitOffsetParams, PagePromise } from '../core/pagination';
+import { type Uploadable } from '../core/uploads';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { multipartFormRequestOptions } from '../internal/uploads';
+import { path } from '../internal/utils/path';
 
 export class Files extends APIResource {
   /**
@@ -14,8 +17,8 @@ export class Files extends APIResource {
    *
    * Returns: FileResponse: The response containing the details of the uploaded file.
    */
-  create(body: FileCreateParams, options?: Core.RequestOptions): Core.APIPromise<FileObject> {
-    return this._client.post('/v1/files', Core.multipartFormRequestOptions({ body, ...options }));
+  create(body: FileCreateParams, options?: RequestOptions): APIPromise<FileObject> {
+    return this._client.post('/v1/files', multipartFormRequestOptions({ body, ...options }, this._client));
   }
 
   /**
@@ -25,8 +28,8 @@ export class Files extends APIResource {
    *
    * Returns: FileResponse: The response containing the file details.
    */
-  retrieve(fileId: string, options?: Core.RequestOptions): Core.APIPromise<FileObject> {
-    return this._client.get(`/v1/files/${fileId}`, options);
+  retrieve(fileID: string, options?: RequestOptions): APIPromise<FileObject> {
+    return this._client.get(path`/v1/files/${fileID}`, options);
   }
 
   /**
@@ -36,8 +39,11 @@ export class Files extends APIResource {
    *
    * Returns: FileObject: The updated file details.
    */
-  update(fileId: string, body: FileUpdateParams, options?: Core.RequestOptions): Core.APIPromise<FileObject> {
-    return this._client.post(`/v1/files/${fileId}`, Core.multipartFormRequestOptions({ body, ...options }));
+  update(fileID: string, body: FileUpdateParams, options?: RequestOptions): APIPromise<FileObject> {
+    return this._client.post(
+      path`/v1/files/${fileID}`,
+      multipartFormRequestOptions({ body, ...options }, this._client),
+    );
   }
 
   /**
@@ -48,18 +54,10 @@ export class Files extends APIResource {
    * Returns: A list of files belonging to the user.
    */
   list(
-    query?: FileListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<FileObjectsLimitOffset, FileObject>;
-  list(options?: Core.RequestOptions): Core.PagePromise<FileObjectsLimitOffset, FileObject>;
-  list(
-    query: FileListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<FileObjectsLimitOffset, FileObject> {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
-    }
-    return this._client.getAPIList('/v1/files', FileObjectsLimitOffset, { query, ...options });
+    query: FileListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<FileObjectsLimitOffset, FileObject> {
+    return this._client.getAPIList('/v1/files', LimitOffset<FileObject>, { query, ...options });
   }
 
   /**
@@ -69,8 +67,8 @@ export class Files extends APIResource {
    *
    * Returns: FileDeleted: The response containing the details of the deleted file.
    */
-  delete(fileId: string, options?: Core.RequestOptions): Core.APIPromise<FileDeleteResponse> {
-    return this._client.delete(`/v1/files/${fileId}`, options);
+  delete(fileID: string, options?: RequestOptions): APIPromise<FileDeleteResponse> {
+    return this._client.delete(path`/v1/files/${fileID}`, options);
   }
 
   /**
@@ -80,16 +78,16 @@ export class Files extends APIResource {
    *
    * Returns: FileStreamResponse: The response containing the file to be downloaded.
    */
-  content(fileId: string, options?: Core.RequestOptions): Core.APIPromise<Response> {
-    return this._client.get(`/v1/files/${fileId}/content`, {
+  content(fileID: string, options?: RequestOptions): APIPromise<Response> {
+    return this._client.get(path`/v1/files/${fileID}/content`, {
       ...options,
-      headers: { Accept: 'application/octet-stream', ...options?.headers },
+      headers: buildHeaders([{ Accept: 'application/octet-stream' }, options?.headers]),
       __binaryResponse: true,
     });
   }
 }
 
-export class FileObjectsLimitOffset extends LimitOffset<FileObject> {}
+export type FileObjectsLimitOffset = LimitOffset<FileObject>;
 
 /**
  * A model representing a file object in the system.
@@ -155,25 +153,23 @@ export interface FileCreateParams {
   /**
    * The file to upload
    */
-  file: Core.Uploadable;
+  file: Uploadable;
 }
 
 export interface FileUpdateParams {
   /**
    * The file to update
    */
-  file: Core.Uploadable;
+  file: Uploadable;
 }
 
 export interface FileListParams extends LimitOffsetParams {}
 
-Files.FileObjectsLimitOffset = FileObjectsLimitOffset;
-
 export declare namespace Files {
   export {
     type FileObject as FileObject,
     type FileDeleteResponse as FileDeleteResponse,
-    FileObjectsLimitOffset as FileObjectsLimitOffset,
+    type FileObjectsLimitOffset as FileObjectsLimitOffset,
     type FileCreateParams as FileCreateParams,
     type FileUpdateParams as FileUpdateParams,
     type FileListParams as FileListParams,

package/src/resources/index.ts

@@ -4,17 +4,16 @@ export * from './shared';
 export { Embeddings, type EmbeddingCreateParams } from './embeddings';
 export { Extractions } from './extractions/extractions';
 export {
-  FileObjectsLimitOffset,
   Files,
   type FileObject,
   type FileDeleteResponse,
   type FileCreateParams,
   type FileUpdateParams,
   type FileListParams,
+  type FileObjectsLimitOffset,
 } from './files';
 export { Parsing } from './parsing/parsing';
 export {
-  VectorStoresLimitOffset,
   VectorStores,
   type ExpiresAfter,
   type FileCounts,
@@ -30,6 +29,7 @@ export {
   type VectorStoreListParams,
   type VectorStoreQuestionAnsweringParams,
   type VectorStoreSearchParams,
+  type VectorStoresLimitOffset,
 } from './vector-stores/vector-stores';
 export {
   type Embedding,

package/src/resources/parsing/index.ts

@@ -1,12 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export {
-  JobListResponsesLimitOffset,
   Jobs,
   type ParsingJob,
   type JobListResponse,
   type JobDeleteResponse,
   type JobCreateParams,
   type JobListParams,
+  type JobListResponsesLimitOffset,
 } from './jobs';
 export { Parsing } from './parsing';

package/src/resources/parsing/jobs.ts

@@ -1,11 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
-import * as Core from '../../core';
-import { LimitOffset, type LimitOffsetParams } from '../../pagination';
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { LimitOffset, type LimitOffsetParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 import * as polling from '../../lib/polling';
-import { Uploadable } from '../../uploads';
+import { Uploadable } from '../../core/uploads';
 
 export class Jobs extends APIResource {
   /**
@@ -15,7 +16,7 @@ export class Jobs extends APIResource {
    *
    * Returns: The created parsing job.
    */
-  create(body: JobCreateParams, options?: Core.RequestOptions): Core.APIPromise<ParsingJob> {
+  create(body: JobCreateParams, options?: RequestOptions): APIPromise<ParsingJob> {
     return this._client.post('/v1/parsing/jobs', { body, ...options });
   }
 
@@ -26,8 +27,8 @@ export class Jobs extends APIResource {
    *
    * Returns: Detailed information about the parse job.
    */
-  retrieve(jobId: string, options?: Core.RequestOptions): Core.APIPromise<ParsingJob> {
-    return this._client.get(`/v1/parsing/jobs/${jobId}`, options);
+  retrieve(jobID: string, options?: RequestOptions): APIPromise<ParsingJob> {
+    return this._client.get(path`/v1/parsing/jobs/${jobID}`, options);
   }
 
   /**
@@ -38,18 +39,10 @@ export class Jobs extends APIResource {
    * Returns: List of parsing jobs with pagination.
    */
   list(
-    query?: JobListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<JobListResponsesLimitOffset, JobListResponse>;
-  list(options?: Core.RequestOptions): Core.PagePromise<JobListResponsesLimitOffset, JobListResponse>;
-  list(
-    query: JobListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<JobListResponsesLimitOffset, JobListResponse> {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
-    }
-    return this._client.getAPIList('/v1/parsing/jobs', JobListResponsesLimitOffset, { query, ...options });
+    query: JobListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<JobListResponsesLimitOffset, JobListResponse> {
+    return this._client.getAPIList('/v1/parsing/jobs', LimitOffset<JobListResponse>, { query, ...options });
   }
 
   /**
@@ -59,8 +52,8 @@ export class Jobs extends APIResource {
    *
    * Returns: The deleted parsing job.
    */
-  delete(jobId: string, options?: Core.RequestOptions): Core.APIPromise<JobDeleteResponse> {
-    return this._client.delete(`/v1/parsing/jobs/${jobId}`, options);
+  delete(jobID: string, options?: RequestOptions): APIPromise<JobDeleteResponse> {
+    return this._client.delete(path`/v1/parsing/jobs/${jobID}`, options);
   }
 
   /**
@@ -70,8 +63,8 @@ export class Jobs extends APIResource {
    *
    * Returns: The cancelled parsing job.
    */
-  cancel(jobId: string, options?: Core.RequestOptions): Core.APIPromise<ParsingJob> {
-    return this._client.patch(`/v1/parsing/jobs/${jobId}`, options);
+  cancel(jobID: string, options?: RequestOptions): APIPromise<ParsingJob> {
+    return this._client.patch(path`/v1/parsing/jobs/${jobID}`, options);
   }
 
   /**
@@ -87,7 +80,7 @@ export class Jobs extends APIResource {
     jobId: string,
     pollIntervalMs?: number,
     pollTimeoutMs?: number,
-    options?: Core.RequestOptions,
+    options?: RequestOptions,
   ): Promise<ParsingJob> {
     const pollingIntervalMs = pollIntervalMs || 500;
     const pollingTimeoutMs = pollTimeoutMs;
@@ -114,7 +107,7 @@ export class Jobs extends APIResource {
     body: JobCreateParams,
     pollIntervalMs?: number,
     pollTimeoutMs?: number,
-    options?: Core.RequestOptions,
+    options?: RequestOptions,
   ): Promise<ParsingJob> {
     const job = await this.create(body, options);
     return this.poll(job.id, pollIntervalMs, pollTimeoutMs, options);
@@ -132,7 +125,7 @@ export class Jobs extends APIResource {
   async upload(
     file: Uploadable,
     body?: Omit<JobCreateParams, 'file_id'>,
-    options?: Core.RequestOptions,
+    options?: RequestOptions,
   ): Promise<ParsingJob> {
     const fileUploadResponse = await this._client.files.create({ file }, options);
 
@@ -160,14 +153,14 @@ export class Jobs extends APIResource {
     body?: Omit<JobCreateParams, 'file_id'>,
     pollIntervalMs?: number,
     pollTimeoutMs?: number,
-    options?: Core.RequestOptions,
+    options?: RequestOptions,
   ): Promise<ParsingJob> {
     const job = await this.upload(file, body, options);
     return this.poll(job.id, pollIntervalMs, pollTimeoutMs, options);
   }
 }
 
-export class JobListResponsesLimitOffset extends LimitOffset<JobListResponse> {}
+export type JobListResponsesLimitOffset = LimitOffset<JobListResponse>;
 
 /**
  * A job for parsing documents with its current state and result.
@@ -278,7 +271,7 @@ export namespace ParsingJob {
       content: string;
 
       /**
-       * The content to be used for embedding
+       * The content of the chunk to embed
        */
       content_to_embed: string;
 
@@ -435,18 +428,21 @@ export interface JobCreateParams {
    * The format of the returned content
    */
   return_format?: 'html' | 'markdown' | 'plain';
+
+  /**
+   * The strategy to use for OCR
+   */
+  mode?: 'fast' | 'high_quality';
 }
 
 export interface JobListParams extends LimitOffsetParams {}
 
-Jobs.JobListResponsesLimitOffset = JobListResponsesLimitOffset;
-
 export declare namespace Jobs {
   export {
     type ParsingJob as ParsingJob,
     type JobListResponse as JobListResponse,
     type JobDeleteResponse as JobDeleteResponse,
-    JobListResponsesLimitOffset as JobListResponsesLimitOffset,
+    type JobListResponsesLimitOffset as JobListResponsesLimitOffset,
     type JobCreateParams as JobCreateParams,
     type JobListParams as JobListParams,
   };

package/src/resources/parsing/parsing.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
+import { APIResource } from '../../core/resource';
 import * as JobsAPI from './jobs';
 import {
   JobCreateParams,
@@ -17,7 +17,6 @@ export class Parsing extends APIResource {
 }
 
 Parsing.Jobs = Jobs;
-Parsing.JobListResponsesLimitOffset = JobListResponsesLimitOffset;
 
 export declare namespace Parsing {
   export {
@@ -25,7 +24,7 @@ export declare namespace Parsing {
     type ParsingJob as ParsingJob,
     type JobListResponse as JobListResponse,
     type JobDeleteResponse as JobDeleteResponse,
-    JobListResponsesLimitOffset as JobListResponsesLimitOffset,
+    type JobListResponsesLimitOffset as JobListResponsesLimitOffset,
     type JobCreateParams as JobCreateParams,
     type JobListParams as JobListParams,
   };