import type { RequestInit, RequestInfo } from "./internal/builtin-types.mjs"; import type { PromiseOrValue, MergedRequestInit, FinalizedRequestInit } from "./internal/types.mjs"; export type { Logger, LogLevel } from "./internal/utils/log.mjs"; import * as Opts from "./internal/request-options.mjs"; import * as Errors from "./core/error.mjs"; import * as Pagination from "./core/pagination.mjs"; import { type LimitOffsetParams, LimitOffsetResponse, type CursorParams, CursorResponse } from "./core/pagination.mjs"; import * as Uploads from "./core/uploads.mjs"; import * as API from "./resources/index.mjs"; import * as TopLevelAPI from "./resources/top-level.mjs"; import { Embedding, EmbeddingCreateResponse, MultiEncodingEmbedding, InfoResponse, RerankResponse, EmbedParams, RerankParams } from "./resources/top-level.mjs"; import { APIPromise } from "./core/api-promise.mjs"; import { APIKey, APIKeyCreated, APIKeyCreateParams, APIKeyDeleteResponse, APIKeyListParams, APIKeys, APIKeysLimitOffset, Scope } from "./resources/api-keys.mjs"; import { Chat, ChatCreateCompletionParams, ChatCreateCompletionResponse } from "./resources/chat.mjs"; import { APIKeyCreateOrUpdateParams, DataSource, DataSourceAPIKeyParams, DataSourceCreateParams, DataSourceDeleteResponse, DataSourceListParams, DataSourceOauth2Params, DataSources, DataSourcesCursor, DataSourceType, DataSourceUpdateParams, LinearDataSource, NotionDataSource, Oauth2Params } from "./resources/data-sources/data-sources.mjs"; import { EmbeddingCreateParams, Embeddings, EncodingFormat } from "./resources/embeddings.mjs"; import { Extractions } from "./resources/extractions/extractions.mjs"; import { FileCreateParams, FileCreateParamsWithMultipart, FileDeleteResponse, FileHelpers, FileListParams, FileObject, FileObjectsCursor, Files, FileUpdateParams, PaginationWithTotal } from "./resources/files/files.mjs"; import { Parsing } from "./resources/parsing/parsing.mjs"; import { AgenticSearchConfig, AudioChunkGeneratedMetadata, AudioURL, CodeChunkGeneratedMetadata, ContextualizationConfig, ExpiresAfter, FileCounts, ImageChunkGeneratedMetadata, ImageURLOutput, MarkdownChunkGeneratedMetadata, MarkdownHeading, PdfChunkGeneratedMetadata, RerankConfig, ScoredAudioURLInputChunk, ScoredImageURLInputChunk, ScoredTextInputChunk, ScoredVideoURLInputChunk, Store, StoreChunkSearchOptions, StoreConfig, StoreCopyAndPollHelperParams, StoreCopyParams, StoreCreateParams, StoreDeleteResponse, StoreGrepParams, StoreGrepResponse, StoreHelpers, StoreListChunksParams, StoreListChunksResponse, StoreListParams, StoreMetadataFacetsParams, StoreMetadataFacetsResponse, StorePollHelperParams, StoreQuestionAnsweringParams, StoreQuestionAnsweringResponse, Stores, StoresCursor, StoreSearchParams, StoreSearchResponse, StoreUpdateParams, TextChunkGeneratedMetadata, VideoChunkGeneratedMetadata, VideoURL } from "./resources/stores/stores.mjs"; import { type Fetch } from "./internal/builtin-types.mjs"; import { HeadersLike, NullableHeaders } from "./internal/headers.mjs"; import { FinalRequestOptions, RequestOptions } from "./internal/request-options.mjs"; import { type LogLevel, type Logger } from "./internal/utils/log.mjs"; declare const environments: { production: string; development: string; local: string; }; type Environment = keyof typeof environments; export interface ClientOptions { /** * Api key to authenticate with Mixedbread */ apiKey?: string | undefined; /** * Specifies the environment to use for the API. * * Each environment maps to a different base URL: * - `production` corresponds to `https://api.mixedbread.com` * - `development` corresponds to `https://api.dev.mixedbread.com` * - `local` corresponds to `http://127.0.0.1:8000` */ environment?: Environment | undefined; /** * Override the default base URL for the API, e.g., "https://api.example.com/v2/" * * Defaults to process.env['MIXEDBREAD_BASE_URL']. */ baseURL?: string | null | undefined; /** * The maximum amount of time (in milliseconds) that the client should wait for a response * from the server before timing out a single request. * * Note that request timeouts are retried by default, so in a worst-case scenario you may wait * much longer than this timeout before the promise succeeds or fails. * * @unit milliseconds */ timeout?: number | undefined; /** * Additional `RequestInit` options to be passed to `fetch` calls. * Properties will be overridden by per-request `fetchOptions`. */ fetchOptions?: MergedRequestInit | undefined; /** * Specify a custom `fetch` function implementation. * * If not provided, we expect that `fetch` is defined globally. */ fetch?: Fetch | undefined; /** * The maximum number of times that the client will retry a request in case of a * temporary failure, like a network error or a 5XX error from the server. * * @default 2 */ maxRetries?: number | undefined; /** * Default headers to include with every request to the API. * * These can be removed in individual requests by explicitly setting the * header to `null` in request options. */ defaultHeaders?: HeadersLike | undefined; /** * Default query parameters to include with every request to the API. * * These can be removed in individual requests by explicitly setting the * param to `undefined` in request options. */ defaultQuery?: Record | undefined; /** * Set the log level. * * Defaults to process.env['MIXEDBREAD_LOG'] or 'warn' if it isn't set. */ logLevel?: LogLevel | undefined; /** * Set the logger. * * Defaults to globalThis.console. */ logger?: Logger | undefined; } /** * API Client for interfacing with the Mixedbread API. */ export declare class Mixedbread { #private; apiKey: string; baseURL: string; maxRetries: number; timeout: number; logger: Logger; logLevel: LogLevel | undefined; fetchOptions: MergedRequestInit | undefined; private fetch; protected idempotencyHeader?: string; private _options; /** * API Client for interfacing with the Mixedbread API. * * @param {string | undefined} [opts.apiKey=process.env['MXBAI_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.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 {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls. * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation. * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request. * @param {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API. * @param {Record} opts.defaultQuery - Default query parameters to include with every request to the API. */ constructor({ baseURL, apiKey, ...opts }?: ClientOptions); /** * Create a new client instance re-using the same options given to the current client with optional overriding. */ withOptions(options: Partial): 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?: RequestOptions): APIPromise; /** * Returns service information, including name and version. * * Returns: InfoResponse: A response containing the service name and version. */ info(options?: RequestOptions): APIPromise; /** * 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?: RequestOptions): APIPromise; protected defaultQuery(): Record | undefined; protected validateHeaders({ values, nulls }: NullableHeaders): void; protected authHeaders(opts: FinalRequestOptions): Promise; protected stringifyQuery(query: object | Record): string; private getUserAgent; protected defaultIdempotencyKey(): string; protected makeStatusError(status: number, error: Object, message: string | undefined, headers: Headers): Errors.APIError; buildURL(path: string, query: Record | null | undefined, defaultBaseURL?: string | undefined): string; /** * Used as a callback for mutating the given `FinalRequestOptions` object. */ protected prepareOptions(options: FinalRequestOptions): Promise; /** * Used as a callback for mutating the given `RequestInit` object. * * This is useful for cases where you want to add certain headers based off of * the request properties, e.g. `method` or `url`. */ protected prepareRequest(request: RequestInit, { url, options }: { url: string; options: FinalRequestOptions; }): Promise; get(path: string, opts?: PromiseOrValue): APIPromise; post(path: string, opts?: PromiseOrValue): APIPromise; patch(path: string, opts?: PromiseOrValue): APIPromise; put(path: string, opts?: PromiseOrValue): APIPromise; delete(path: string, opts?: PromiseOrValue): APIPromise; private methodRequest; request(options: PromiseOrValue, remainingRetries?: number | null): APIPromise; private makeRequest; getAPIList = Pagination.AbstractPage>(path: string, Page: new (...args: any[]) => PageClass, opts?: PromiseOrValue): Pagination.PagePromise; requestAPIList = Pagination.AbstractPage>(Page: new (...args: ConstructorParameters) => PageClass, options: PromiseOrValue): Pagination.PagePromise; fetchWithTimeout(url: RequestInfo, init: RequestInit | undefined, ms: number, controller: AbortController): Promise; private shouldRetry; private retryRequest; private calculateDefaultRetryTimeoutMillis; buildRequest(inputOptions: FinalRequestOptions, { retryCount }?: { retryCount?: number; }): Promise<{ req: FinalizedRequestInit; url: string; timeout: number; }>; private buildHeaders; private _makeAbort; private buildBody; static Mixedbread: typeof Mixedbread; static DEFAULT_TIMEOUT: number; static MixedbreadError: typeof Errors.MixedbreadError; static APIError: typeof Errors.APIError; static APIConnectionError: typeof Errors.APIConnectionError; static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError; static APIUserAbortError: typeof Errors.APIUserAbortError; static NotFoundError: typeof Errors.NotFoundError; static ConflictError: typeof Errors.ConflictError; static RateLimitError: typeof Errors.RateLimitError; static BadRequestError: typeof Errors.BadRequestError; static AuthenticationError: typeof Errors.AuthenticationError; static InternalServerError: typeof Errors.InternalServerError; static PermissionDeniedError: typeof Errors.PermissionDeniedError; static UnprocessableEntityError: typeof Errors.UnprocessableEntityError; static toFile: typeof Uploads.toFile; stores: API.Stores; parsing: API.Parsing; files: API.Files; extractions: API.Extractions; embeddings: API.Embeddings; dataSources: API.DataSources; apiKeys: API.APIKeys; chat: API.Chat; } export declare namespace Mixedbread { export type RequestOptions = Opts.RequestOptions; export import LimitOffset = Pagination.LimitOffset; export { type LimitOffsetParams as LimitOffsetParams, type LimitOffsetResponse as LimitOffsetResponse }; export import Cursor = Pagination.Cursor; export { type CursorParams as CursorParams, type CursorResponse as CursorResponse }; export { 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 { Stores as Stores, type ScoredVideoURLInputChunk as ScoredVideoURLInputChunk, type ExpiresAfter as ExpiresAfter, type ScoredAudioURLInputChunk as ScoredAudioURLInputChunk, type ScoredImageURLInputChunk as ScoredImageURLInputChunk, type ScoredTextInputChunk as ScoredTextInputChunk, type Store as Store, type StoreChunkSearchOptions as StoreChunkSearchOptions, type MarkdownChunkGeneratedMetadata as MarkdownChunkGeneratedMetadata, type MarkdownHeading as MarkdownHeading, type TextChunkGeneratedMetadata as TextChunkGeneratedMetadata, type PdfChunkGeneratedMetadata as PdfChunkGeneratedMetadata, type CodeChunkGeneratedMetadata as CodeChunkGeneratedMetadata, type AudioChunkGeneratedMetadata as AudioChunkGeneratedMetadata, type VideoChunkGeneratedMetadata as VideoChunkGeneratedMetadata, type ImageChunkGeneratedMetadata as ImageChunkGeneratedMetadata, type AudioURL as AudioURL, type ImageURLOutput as ImageURLOutput, type VideoURL as VideoURL, type StoreConfig as StoreConfig, type ContextualizationConfig as ContextualizationConfig, type FileCounts as FileCounts, type RerankConfig as RerankConfig, type AgenticSearchConfig as AgenticSearchConfig, type StoreDeleteResponse as StoreDeleteResponse, type StoreGrepResponse as StoreGrepResponse, type StoreListChunksResponse as StoreListChunksResponse, type StoreMetadataFacetsResponse as StoreMetadataFacetsResponse, type StoreQuestionAnsweringResponse as StoreQuestionAnsweringResponse, type StoreSearchResponse as StoreSearchResponse, type StoresCursor as StoresCursor, type StoreCreateParams as StoreCreateParams, type StoreUpdateParams as StoreUpdateParams, type StoreListParams as StoreListParams, type StoreCopyParams as StoreCopyParams, type StoreGrepParams as StoreGrepParams, type StoreListChunksParams as StoreListChunksParams, type StoreMetadataFacetsParams as StoreMetadataFacetsParams, type StoreQuestionAnsweringParams as StoreQuestionAnsweringParams, type StoreSearchParams as StoreSearchParams, type StorePollHelperParams as StorePollHelperParams, type StoreCopyAndPollHelperParams as StoreCopyAndPollHelperParams, type StoreHelpers as StoreHelpers, }; export { Parsing as Parsing }; export { Files as Files, type FileObject as FileObject, type PaginationWithTotal as PaginationWithTotal, type FileDeleteResponse as FileDeleteResponse, type FileObjectsCursor as FileObjectsCursor, type FileCreateParams as FileCreateParams, type FileUpdateParams as FileUpdateParams, type FileListParams as FileListParams, type FileCreateParamsWithMultipart as FileCreateParamsWithMultipart, type FileHelpers as FileHelpers, }; export { Extractions as Extractions }; export { Embeddings as Embeddings, type EncodingFormat as EncodingFormat, type EmbeddingCreateParams as EmbeddingCreateParams, }; export { DataSources as DataSources, type DataSource as DataSource, type DataSourceOauth2Params as DataSourceOauth2Params, type DataSourceType as DataSourceType, type LinearDataSource as LinearDataSource, type NotionDataSource as NotionDataSource, type Oauth2Params as Oauth2Params, type DataSourceAPIKeyParams as DataSourceAPIKeyParams, type APIKeyCreateOrUpdateParams as APIKeyCreateOrUpdateParams, type DataSourceDeleteResponse as DataSourceDeleteResponse, type DataSourcesCursor as DataSourcesCursor, type DataSourceCreateParams as DataSourceCreateParams, type DataSourceUpdateParams as DataSourceUpdateParams, type DataSourceListParams as DataSourceListParams, }; export { APIKeys as APIKeys, type APIKey as APIKey, type APIKeyCreated as APIKeyCreated, type Scope as Scope, type APIKeyDeleteResponse as APIKeyDeleteResponse, type APIKeysLimitOffset as APIKeysLimitOffset, type APIKeyCreateParams as APIKeyCreateParams, type APIKeyListParams as APIKeyListParams, }; export { Chat as Chat, type ChatCreateCompletionResponse as ChatCreateCompletionResponse, type ChatCreateCompletionParams as ChatCreateCompletionParams, }; export type Usage = API.Usage; export type SearchFilter = API.SearchFilter; export type SearchFilterCondition = API.SearchFilterCondition; } //# sourceMappingURL=client.d.mts.map