@mixedbread/sdk 0.1.0-alpha.9 → 0.2.0

package/src/core.ts

@@ -16,7 +16,12 @@ import {
   type RequestInit,
   type Response,
   type HeadersInit,
+  init,
 } from './_shims/index';
+
+// try running side effects outside of _shims/index to workaround https://github.com/vercel/next.js/issues/76881
+init();
+
 export { type Response };
 import { BlobLike, isBlobLike, isMultipartBody } from './uploads';
 export {
@@ -28,6 +33,20 @@ export {
 
 export type Fetch = (url: RequestInfo, init?: RequestInit) => Promise<Response>;
 
+/**
+ * An alias to the builtin `Array` type so we can
+ * easily alias it in import statements if there are name clashes.
+ */
+type _Array<T> = Array<T>;
+
+/**
+ * An alias to the builtin `Record` type so we can
+ * easily alias it in import statements if there are name clashes.
+ */
+type _Record<K extends keyof any, T> = Record<K, T>;
+
+export type { _Array as Array, _Record as Record };
+
 type PromiseOrValue<T> = T | Promise<T>;
 
 type APIResponseProps = {
@@ -48,8 +67,8 @@ async function defaultParseResponse<T>(props: APIResponseProps): Promise<T> {
   }
 
   const contentType = response.headers.get('content-type');
-  const isJSON =
-    contentType?.includes('application/json') || contentType?.includes('application/vnd.api+json');
+  const mediaType = contentType?.split(';')[0]?.trim();
+  const isJSON = mediaType?.includes('application/json') || mediaType?.endsWith('+json');
   if (isJSON) {
     const json = await response.json();
 
@@ -366,7 +385,7 @@ export abstract class APIClient {
       getHeader(headers, 'x-stainless-timeout') === undefined &&
       options.timeout
     ) {
-      reqHeaders['x-stainless-timeout'] = String(options.timeout);
+      reqHeaders['x-stainless-timeout'] = String(Math.trunc(options.timeout / 1000));
     }
 
     this.validateHeaders(reqHeaders, headers);
@@ -395,7 +414,7 @@ export abstract class APIClient {
       !headers ? {}
       : Symbol.iterator in headers ?
         Object.fromEntries(Array.from(headers as Iterable<string[]>).map((header) => [...header]))
-      : { ...headers }
+      : { ...(headers as any as Record<string, string>) }
     );
   }
 

package/src/index.ts

@@ -8,7 +8,16 @@ import { type LimitOffsetParams, LimitOffsetResponse } from './pagination';
 import * as Uploads from './uploads';
 import * as API from './resources/index';
 import * as TopLevelAPI from './resources/top-level';
-import { InfoResponse } from './resources/top-level';
+import {
+  EmbedParams,
+  Embedding,
+  EmbeddingCreateResponse,
+  InfoResponse,
+  MultiEncodingEmbedding,
+  RerankParams,
+  RerankResponse,
+} from './resources/top-level';
+import { EmbeddingCreateParams, Embeddings } from './resources/embeddings';
 import {
   FileCreateParams,
   FileDeleteResponse,
@@ -40,7 +49,7 @@ import {
 } from './resources/vector-stores/vector-stores';
 
 const environments = {
-  production: 'https://api.mixedbread.ai',
+  production: 'https://api.mixedbread.com',
   local: 'http://127.0.0.1:8000',
 };
 type Environment = keyof typeof environments;
@@ -55,7 +64,7 @@ export interface ClientOptions {
    * Specifies the environment to use for the API.
    *
    * Each environment maps to a different base URL:
-   * - `production` corresponds to `https://api.mixedbread.ai`
+   * - `production` corresponds to `https://api.mixedbread.com`
    * - `local` corresponds to `http://127.0.0.1:8000`
    */
   environment?: Environment | undefined;
@@ -128,9 +137,9 @@ export class Mixedbread extends Core.APIClient {
   /**
    * API Client for interfacing with the Mixedbread API.
    *
-   * @param {string | undefined} [opts.apiKey=process.env['MXBAI_API_KEY'] ?? undefined]
+   * @param {string | undefined} [opts.apiKey=process.env['MIXEDBREAD_API_KEY'] ?? undefined]
    * @param {Environment} [opts.environment=production] - Specifies the environment URL to use for the API.
-   * @param {string} [opts.baseURL=process.env['MIXEDBREAD_BASE_URL'] ?? https://api.mixedbread.ai] - Override the default base URL for the API.
+   * @param {string} [opts.baseURL=process.env['MIXEDBREAD_BASE_URL'] ?? https://api.mixedbread.com] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
    * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
@@ -140,12 +149,12 @@ export class Mixedbread extends Core.APIClient {
    */
   constructor({
     baseURL = Core.readEnv('MIXEDBREAD_BASE_URL'),
-    apiKey = Core.readEnv('MXBAI_API_KEY'),
+    apiKey = Core.readEnv('MIXEDBREAD_API_KEY'),
     ...opts
   }: ClientOptions = {}) {
     if (apiKey === undefined) {
       throw new Errors.MixedbreadError(
-        "The MXBAI_API_KEY environment variable is missing or empty; either provide it, or instantiate the Mixedbread client with an apiKey option, like new Mixedbread({ apiKey: 'My API Key' }).",
+        "The MIXEDBREAD_API_KEY environment variable is missing or empty; either provide it, or instantiate the Mixedbread client with an apiKey option, like new Mixedbread({ apiKey: 'My API Key' }).",
       );
     }
 
@@ -175,10 +184,26 @@ export class Mixedbread extends Core.APIClient {
     this.apiKey = apiKey;
   }
 
+  vectorStores: API.VectorStores = new API.VectorStores(this);
   parsing: API.Parsing = new API.Parsing(this);
   files: API.Files = new API.Files(this);
-  vectorStores: API.VectorStores = new API.VectorStores(this);
   extractions: API.Extractions = new API.Extractions(this);
+  embeddings: API.Embeddings = new API.Embeddings(this);
+
+  /**
+   * Create embeddings for text or images using the specified model, encoding format,
+   * and normalization.
+   *
+   * Args: params: The parameters for creating embeddings.
+   *
+   * Returns: EmbeddingCreateResponse: The response containing the embeddings.
+   */
+  embed(
+    body: TopLevelAPI.EmbedParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TopLevelAPI.EmbeddingCreateResponse> {
+    return this.post('/v1/embeddings', { body, ...options });
+  }
 
   /**
    * Returns service information, including name and version.
@@ -189,6 +214,20 @@ export class Mixedbread extends Core.APIClient {
     return this.get('/', options);
   }
 
+  /**
+   * Rerank different kind of documents for a given query.
+   *
+   * Args: params: RerankParams: The parameters for reranking.
+   *
+   * Returns: RerankResponse: The reranked documents for the input query.
+   */
+  rerank(
+    body: TopLevelAPI.RerankParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TopLevelAPI.RerankResponse> {
+    return this.post('/v1/reranking', { body, ...options });
+  }
+
   protected override defaultQuery(): Core.DefaultQuery | undefined {
     return this._options.defaultQuery;
   }
@@ -225,30 +264,27 @@ export class Mixedbread extends Core.APIClient {
   static fileFromPath = Uploads.fileFromPath;
 }
 
+Mixedbread.VectorStores = VectorStores;
+Mixedbread.VectorStoresLimitOffset = VectorStoresLimitOffset;
 Mixedbread.Parsing = Parsing;
 Mixedbread.Files = Files;
 Mixedbread.FileObjectsLimitOffset = FileObjectsLimitOffset;
-Mixedbread.VectorStores = VectorStores;
-Mixedbread.VectorStoresLimitOffset = VectorStoresLimitOffset;
 Mixedbread.Extractions = Extractions;
+Mixedbread.Embeddings = Embeddings;
 export declare namespace Mixedbread {
   export type RequestOptions = Core.RequestOptions;
 
   export import LimitOffset = Pagination.LimitOffset;
   export { type LimitOffsetParams as LimitOffsetParams, type LimitOffsetResponse as LimitOffsetResponse };
 
-  export { type InfoResponse as InfoResponse };
-
-  export { Parsing as Parsing };
-
   export {
-    Files as Files,
-    type FileObject as FileObject,
-    type FileDeleteResponse as FileDeleteResponse,
-    FileObjectsLimitOffset as FileObjectsLimitOffset,
-    type FileCreateParams as FileCreateParams,
-    type FileUpdateParams as FileUpdateParams,
-    type FileListParams as FileListParams,
+    type Embedding as Embedding,
+    type EmbeddingCreateResponse as EmbeddingCreateResponse,
+    type MultiEncodingEmbedding as MultiEncodingEmbedding,
+    type InfoResponse as InfoResponse,
+    type RerankResponse as RerankResponse,
+    type EmbedParams as EmbedParams,
+    type RerankParams as RerankParams,
   };
 
   export {
@@ -270,10 +306,25 @@ export declare namespace Mixedbread {
     type VectorStoreSearchParams as VectorStoreSearchParams,
   };
 
+  export { Parsing as Parsing };
+
+  export {
+    Files as Files,
+    type FileObject as FileObject,
+    type FileDeleteResponse as FileDeleteResponse,
+    FileObjectsLimitOffset as FileObjectsLimitOffset,
+    type FileCreateParams as FileCreateParams,
+    type FileUpdateParams as FileUpdateParams,
+    type FileListParams as FileListParams,
+  };
+
   export { Extractions as Extractions };
 
+  export { Embeddings as Embeddings, type EmbeddingCreateParams as EmbeddingCreateParams };
+
   export type SearchFilter = API.SearchFilter;
   export type SearchFilterCondition = API.SearchFilterCondition;
+  export type Usage = API.Usage;
 }
 
 export { toFile, fileFromPath } from './uploads';

package/src/resources/embeddings.ts

@@ -0,0 +1,67 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../resource';
+import * as Core from '../core';
+import * as TopLevelAPI from './top-level';
+
+export class Embeddings extends APIResource {
+  /**
+   * Create embeddings for text or images using the specified model, encoding format,
+   * and normalization.
+   *
+   * Args: params: The parameters for creating embeddings.
+   *
+   * Returns: EmbeddingCreateResponse: The response containing the embeddings.
+   */
+  create(
+    body: EmbeddingCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TopLevelAPI.EmbeddingCreateResponse> {
+    return this._client.post('/v1/embeddings', { body, ...options });
+  }
+}
+
+export interface EmbeddingCreateParams {
+  /**
+   * The model to use for creating embeddings.
+   */
+  model: string;
+
+  /**
+   * The input to create embeddings for.
+   */
+  input: string | Array<string>;
+
+  /**
+   * The number of dimensions to use for the embeddings.
+   */
+  dimensions?: number | null;
+
+  /**
+   * The prompt to use for the embedding creation.
+   */
+  prompt?: string | null;
+
+  /**
+   * Whether to normalize the embeddings.
+   */
+  normalized?: boolean;
+
+  /**
+   * 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'>;
+}
+
+export declare namespace Embeddings {
+  export { type EmbeddingCreateParams as EmbeddingCreateParams };
+}

package/src/resources/extractions/content.ts

@@ -20,7 +20,7 @@ export class Content extends APIResource {
  * The result of an extraction job.
  */
 export interface ExtractionResult {
-  data: unknown;
+  data: Record<string, unknown>;
 
   warnings: Array<string>;
 }
@@ -34,7 +34,7 @@ export interface ContentCreateParams {
   /**
    * The JSON schema to use for extraction
    */
-  json_schema: unknown;
+  json_schema: Record<string, unknown>;
 }
 
 export declare namespace Content {

package/src/resources/extractions/jobs.ts

@@ -80,12 +80,12 @@ export interface ExtractionJob {
   /**
    * Error information if failed
    */
-  error: unknown | null;
+  error: Record<string, unknown> | null;
 
   /**
    * The JSON schema used for extraction
    */
-  json_schema: unknown;
+  json_schema: Record<string, unknown>;
 }
 
 export interface JobCreateParams {
@@ -97,7 +97,7 @@ export interface JobCreateParams {
   /**
    * The JSON schema to use for extraction
    */
-  json_schema: unknown;
+  json_schema: Record<string, unknown>;
 }
 
 export declare namespace Jobs {

package/src/resources/extractions/schema.ts

@@ -45,7 +45,7 @@ export interface CreatedJsonSchema {
   /**
    * The created JSON schema
    */
-  json_schema: unknown;
+  json_schema: Record<string, unknown>;
 }
 
 /**
@@ -55,7 +55,7 @@ export interface EnhancedJsonSchema {
   /**
    * The enhanced JSON schema
    */
-  json_schema: unknown;
+  json_schema: Record<string, unknown>;
 }
 
 /**
@@ -75,7 +75,7 @@ export interface ValidatedJsonSchema {
   /**
    * The validated JSON schema
    */
-  json_schema: unknown;
+  json_schema: Record<string, unknown>;
 }
 
 export interface SchemaCreateParams {
@@ -89,14 +89,14 @@ export interface SchemaEnhanceParams {
   /**
    * The JSON schema to enhance
    */
-  json_schema: unknown;
+  json_schema: Record<string, unknown>;
 }
 
 export interface SchemaValidateParams {
   /**
    * The JSON schema to validate
    */
-  json_schema: unknown;
+  json_schema: Record<string, unknown>;
 }
 
 export declare namespace Schema {

package/src/resources/extractions.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './extractions/index';

package/src/resources/index.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export * from './shared';
+export { Embeddings, type EmbeddingCreateParams } from './embeddings';
 export { Extractions } from './extractions/extractions';
 export {
   FileObjectsLimitOffset,
@@ -30,4 +31,12 @@ export {
   type VectorStoreQuestionAnsweringParams,
   type VectorStoreSearchParams,
 } from './vector-stores/vector-stores';
-export { type InfoResponse } from './top-level';
+export {
+  type Embedding,
+  type EmbeddingCreateResponse,
+  type MultiEncodingEmbedding,
+  type InfoResponse,
+  type RerankResponse,
+  type EmbedParams,
+  type RerankParams,
+} from './top-level';

package/src/resources/parsing/jobs.ts

@@ -178,6 +178,11 @@ export interface ParsingJob {
    */
   id: string;
 
+  /**
+   * The ID of the file to parse
+   */
+  file_id: string;
+
   /**
    * The status of the job
    */
@@ -342,6 +347,11 @@ export interface JobListResponse {
    */
   id: string;
 
+  /**
+   * The ID of the file to parse
+   */
+  file_id: string;
+
   /**
    * The status of the job
    */

package/src/resources/parsing.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './parsing/index';

package/src/resources/shared.ts

@@ -39,3 +39,20 @@ export interface SearchFilterCondition {
    */
   operator: 'eq' | 'not_eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'not_in' | 'like' | 'not_like';
 }
+
+export interface Usage {
+  /**
+   * The number of tokens used for the prompt
+   */
+  prompt_tokens: number;
+
+  /**
+   * The total number of tokens used
+   */
+  total_tokens: number;
+
+  /**
+   * The number of tokens used for the completion
+   */
+  completion_tokens?: number | null;
+}