DeepInfra 嵌入

DeepInfraEmbeddings 类使用 DeepInfra API 为给定的文本输入生成嵌入。本指南将引导您完成 DeepInfraEmbeddings 类的设置和使用，帮助您将其无缝集成到您的项目中。

安装

安装 @langchain/community 包，如下所示

提示

参见此部分以获取有关安装集成包的常规说明.

npm

npm i @langchain/community

Yarn

yarn add @langchain/community

pnpm

pnpm add @langchain/community

初始化

使用此集成，您可以使用 DeepInfra 嵌入模型为您的文本数据获取嵌入。以下是链接到嵌入模型。

首先，您需要在 DeepInfra 网站上注册并从这里获取 API 令牌。您可以从模型卡中复制名称，并开始在您的代码中使用它们。

要使用 DeepInfraEmbeddings 类，您需要一个来自 DeepInfra 的 API 令牌。您可以将此令牌直接传递给构造函数，也可以将其设置为环境变量 (DEEPINFRA_API_TOKEN)。

基本用法

以下是创建 DeepInfraEmbeddings 实例的方法

import { DeepInfraEmbeddings } from "@langchain/community/embeddings/deepinfra";

const embeddings = new DeepInfraEmbeddings({
  apiToken: "YOUR_API_TOKEN",
  modelName: "sentence-transformers/clip-ViT-B-32", // Optional, defaults to "sentence-transformers/clip-ViT-B-32"
  batchSize: 1024, // Optional, defaults to 1024
});

如果未提供 apiToken，它将从 DEEPINFRA_API_TOKEN 环境变量中读取。

生成嵌入

嵌入单个查询

要为单个文本查询生成嵌入，请使用 embedQuery 方法

const embedding = await embeddings.embedQuery(
  "What would be a good company name for a company that makes colorful socks?"
);
console.log(embedding);

嵌入多个文档

要为多个文档生成嵌入，请使用 embedDocuments 方法。此方法将根据 batchSize 参数自动处理批处理

const documents = [
  "Document 1 text...",
  "Document 2 text...",
  "Document 3 text...",
];

const embeddingsArray = await embeddings.embedDocuments(documents);
console.log(embeddingsArray);

自定义请求

您可以通过传递 configuration 参数来自定义 SDK 发送请求的基 URL

const customEmbeddings = new DeepInfraEmbeddings({
  apiToken: "YOUR_API_TOKEN",
  configuration: {
    baseURL: "https://your_custom_url.com",
  },
});

这使您能够在需要时通过自定义端点路由请求。

错误处理

如果未提供 API 令牌，并且在环境变量中也找不到，则会抛出错误

try {
  const embeddings = new DeepInfraEmbeddings();
} catch (error) {
  console.error("DeepInfra API token not found");
}

示例

以下是有关如何设置和使用 DeepInfraEmbeddings 类的完整示例

import { DeepInfraEmbeddings } from "@langchain/community/embeddings/deepinfra";

const embeddings = new DeepInfraEmbeddings({
  apiToken: "YOUR_API_TOKEN",
  modelName: "sentence-transformers/clip-ViT-B-32",
  batchSize: 512,
});

async function runExample() {
  const queryEmbedding = await embeddings.embedQuery("Example query text.");
  console.log("Query Embedding:", queryEmbedding);

  const documents = ["Text 1", "Text 2", "Text 3"];
  const documentEmbeddings = await embeddings.embedDocuments(documents);
  console.log("Document Embeddings:", documentEmbeddings);
}

runExample();

反馈和支持

有关反馈或问题，请联系[email protected].

相关

• 嵌入模型概念指南
• 嵌入模型操作指南