跳转到内容

MixedbreadAIEmbeddings

定义于:.build/typescript/packages/providers/mixedbread/src/MixedbreadAIEmbeddings.ts:81

使用 mixedbread ai API 生成嵌入向量的类。

该类利用模型“mixedbread-ai/mxbai-embed-large-v1”为文本文档生成嵌入向量。这些嵌入向量可用于多种自然语言处理任务,例如相似性比较、聚类分析,或作为机器学习模型的特征。

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);
  • BaseEmbedding

MixedbreadAIEmbeddings<Options>(nodes, options?): Promise

定义于:.build/typescript/packages/providers/mixedbread/src/MixedbreadAIEmbeddings.ts:81

使用 mixedbread ai API 生成嵌入向量的类。

该类利用模型“mixedbread-ai/mxbai-embed-large-v1”为文本文档生成嵌入向量。这些嵌入向量可用于各种自然语言处理任务,例如相似性比较、聚类分析,或作为机器学习模型中的特征。

Options extends Record<string, unknown>

BaseNode<Metadata>[]

Options

Promise

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);

new MixedbreadAIEmbeddings(params?): MixedbreadAIEmbeddings

定义于:.build/typescript/packages/providers/mixedbread/src/MixedbreadAIEmbeddings.ts:92

MixedbreadAIEmbeddings 的构造函数。

Partial<MixedbreadAIEmbeddingsParams>

一个可选对象,包含用于配置实例的属性。

MixedbreadAIEmbeddings

如果未提供API密钥或在环境变量中未找到。

如果批次大小超过256。

BaseEmbedding.constructor

请求参数: EmbeddingsRequestWithoutInput

定义于:.build/typescript/packages/providers/mixedbread/src/MixedbreadAIEmbeddings.ts:82


请求选项: RequestOptions

定义于:.build/typescript/packages/providers/mixedbread/src/MixedbreadAIEmbeddings.ts:83

getTextEmbedding(text): Promise<number[]>

定义于:.build/typescript/packages/providers/mixedbread/src/MixedbreadAIEmbeddings.ts:150

为单个文本生成嵌入向量。

string

要生成嵌入的字符串。

Promise<number[]>

一个 Promise,其解析结果为表示嵌入向量的数字数组。

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

BaseEmbedding.getTextEmbedding


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

定义于:.build/typescript/packages/providers/mixedbread/src/MixedbreadAIEmbeddings.ts:164

为文本数组生成嵌入向量。

string[]

用于生成嵌入的字符串数组。

Promise<number[][]>

一个解析为嵌入向量数组的 Promise 对象。

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

BaseEmbedding.getTextEmbeddings