Interface MixedbreadAIEmbeddingsParams

Interface extending EmbeddingsParams with additional parameters specific to the MixedbreadAIEmbeddings class.

interface MixedbreadAIEmbeddingsParams {
    apiKey?: string;
    baseUrl?: string;
    batchSize?: number;
    model?: string;
}

Hierarchy (view full)

  • Toolkit
  • Omit<EmbeddingsRequestWithoutInput, "model">
    • MixedbreadAIEmbeddingsParams

Properties

apiKey? baseUrl? batchSize? model?

Properties

Optional apiKey

apiKey?: string

The API key to use.

Default

{process.env.MXBAI_API_KEY}

Optional baseUrl

baseUrl?: string

The base URL for the API.

Optional batchSize

batchSize?: number

The maximum number of documents to embed in a single request.

Default

{128}

Optional model

model?: string

The model to use for generating embeddings.

Default

{"mixedbread-ai/mxbai-embed-large-v1"}

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc