MixedbreadAIEmbeddings

Defined in: providers/mixedbread/src/MixedbreadAIEmbeddings.ts:81

Class for generating embeddings using the mixedbread ai API.

This class leverages the model "mixedbread-ai/mxbai-embed-large-v1" to generate embeddings for text documents. The embeddings can be used for various NLP tasks such as similarity comparison, clustering, or as features in machine learning models.

Examples

const mxbai = new MixedbreadAIEmbeddings({ apiKey: 'your-api-key' });
const texts = ["Baking bread is fun", "I love baking"];
const result = await mxbai.getTextEmbeddings(texts);
console.log(result);

const mxbai = new MixedbreadAIEmbeddings({
 apiKey: 'your-api-key',
 model: 'mixedbread-ai/mxbai-embed-large-v1',
 encodingFormat: MixedbreadAI.EncodingFormat.Binary,
 dimensions: 512,
 normalized: true,
});
const query = "Represent this sentence for searching relevant passages: Is baking bread fun?";
const result = await mxbai.getTextEmbedding(query);
console.log(result);

Extends

BaseEmbedding

MixedbreadAIEmbeddings<Options>(nodes, options?): Promise<BaseNode<Metadata>[]>

Defined in: providers/mixedbread/src/MixedbreadAIEmbeddings.ts:81

Class for generating embeddings using the mixedbread ai API.

Type Parameters

• Options extends Record<string, unknown>

Parameters

nodes

BaseNode<Metadata>[]

options?

Options

Returns

Promise<BaseNode<Metadata>[]>

Examples

const mxbai = new MixedbreadAIEmbeddings({ apiKey: 'your-api-key' });
const texts = ["Baking bread is fun", "I love baking"];
const result = await mxbai.getTextEmbeddings(texts);
console.log(result);

const mxbai = new MixedbreadAIEmbeddings({
 apiKey: 'your-api-key',
 model: 'mixedbread-ai/mxbai-embed-large-v1',
 encodingFormat: MixedbreadAI.EncodingFormat.Binary,
 dimensions: 512,
 normalized: true,
});
const query = "Represent this sentence for searching relevant passages: Is baking bread fun?";
const result = await mxbai.getTextEmbedding(query);
console.log(result);

Constructors

new MixedbreadAIEmbeddings()

new MixedbreadAIEmbeddings(params?): MixedbreadAIEmbeddings

Defined in: providers/mixedbread/src/MixedbreadAIEmbeddings.ts:92

Constructor for MixedbreadAIEmbeddings.

Parameters

params?

Partial<MixedbreadAIEmbeddingsParams>

An optional object with properties to configure the instance.

Returns

MixedbreadAIEmbeddings

Throws

If the API key is not provided or found in the environment variables.

Throws

If the batch size exceeds 256.

Overrides

BaseEmbedding.constructor

Properties

requestParams

requestParams: EmbeddingsRequestWithoutInput

Defined in: providers/mixedbread/src/MixedbreadAIEmbeddings.ts:82

requestOptions

requestOptions: RequestOptions

Defined in: providers/mixedbread/src/MixedbreadAIEmbeddings.ts:83

Methods

getTextEmbedding()

getTextEmbedding(text): Promise<number[]>

Defined in: providers/mixedbread/src/MixedbreadAIEmbeddings.ts:150

Generates an embedding for a single text.

Parameters

text

string

A string to generate an embedding for.

Returns

Promise<number[]>

A Promise that resolves to an array of numbers representing the embedding.

Example

const query = "Represent this sentence for searching relevant passages: Is baking bread fun?";
const result = await mxbai.getTextEmbedding(text);
console.log(result);

Overrides

BaseEmbedding.getTextEmbedding

getTextEmbeddings()

getTextEmbeddings(texts): Promise<number[][]>

Defined in: providers/mixedbread/src/MixedbreadAIEmbeddings.ts:164

Generates embeddings for an array of texts.

Parameters

texts

string[]

An array of strings to generate embeddings for.

Returns

Promise<number[][]>

A Promise that resolves to an array of embeddings.

Example

const texts = ["Baking bread is fun", "I love baking"];
const result = await mxbai.getTextEmbeddings(texts);
console.log(result);

Overrides

BaseEmbedding.getTextEmbeddings

MixedbreadAIEmbeddings

On this page