Skip to main content

Interface: MixedbreadAIEmbeddingsParams

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

Extends​

  • Omit<EmbeddingsRequestWithoutInput, "model">

Properties​

apiKey?​

optional apiKey: string

The API key to use.

Default​

{process.env.MXBAI_API_KEY}

Defined in​

packages/llamaindex/src/embeddings/MixedbreadAIEmbeddings.ts:26

baseUrl?​

optional baseUrl: string

The base URL for the API.

Defined in​

packages/llamaindex/src/embeddings/MixedbreadAIEmbeddings.ts:31

dimensions?​

optional dimensions: number

The number of dimensions to use for the embeddings.

Inherited from​

Omit.dimensions

Defined in​

node_modules/.pnpm/@mixedbread-ai+sdk@2.2.11_encoding@0.1.13/node_modules/@mixedbread-ai/sdk/dist/api/client/requests/EmbeddingsRequest.d.ts:23

embedBatchSize?​

optional embedBatchSize: number

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

Default​

{128}

Defined in​

packages/llamaindex/src/embeddings/MixedbreadAIEmbeddings.ts:37

embedInfo?​

optional embedInfo: EmbeddingInfo

The embed info for the model.

Defined in​

packages/llamaindex/src/embeddings/MixedbreadAIEmbeddings.ts:42

encodingFormat?​

optional encodingFormat: EmbeddingsRequestEncodingFormat

Inherited from​

Omit.encodingFormat

Defined in​

node_modules/.pnpm/@mixedbread-ai+sdk@2.2.11_encoding@0.1.13/node_modules/@mixedbread-ai/sdk/dist/api/client/requests/EmbeddingsRequest.d.ts:19

maxRetries?​

optional maxRetries: number

The maximum number of retries to attempt.

Default​

{3}

Defined in​

packages/llamaindex/src/embeddings/MixedbreadAIEmbeddings.ts:48

model?​

optional model: string

The model to use for generating embeddings.

Default​

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

Defined in​

packages/llamaindex/src/embeddings/MixedbreadAIEmbeddings.ts:20

normalized?​

optional normalized: boolean

Whether to normalize the embeddings.

Inherited from​

Omit.normalized

Defined in​

node_modules/.pnpm/@mixedbread-ai+sdk@2.2.11_encoding@0.1.13/node_modules/@mixedbread-ai/sdk/dist/api/client/requests/EmbeddingsRequest.d.ts:18

prompt?​

optional prompt: string

The prompt to use for the embedding creation.

Inherited from​

Omit.prompt

Defined in​

node_modules/.pnpm/@mixedbread-ai+sdk@2.2.11_encoding@0.1.13/node_modules/@mixedbread-ai/sdk/dist/api/client/requests/EmbeddingsRequest.d.ts:25

timeoutInSeconds?​

optional timeoutInSeconds: number

Timeouts for the request.

Defined in​

packages/llamaindex/src/embeddings/MixedbreadAIEmbeddings.ts:53

truncationStrategy?​

optional truncationStrategy: TruncationStrategy

The truncation strategy to use for the input.

Inherited from​

Omit.truncationStrategy

Defined in​

node_modules/.pnpm/@mixedbread-ai+sdk@2.2.11_encoding@0.1.13/node_modules/@mixedbread-ai/sdk/dist/api/client/requests/EmbeddingsRequest.d.ts:21