Skip to main content
本指南将帮助您开始使用 LangChain 的 OpenAI 嵌入模型。有关 OpenAIEmbeddings 功能和配置选项的详细文档,请参阅 API 参考

概述

集成详情

设置

要访问 OpenAI 嵌入模型,您需要创建一个 OpenAI 账户、获取 API 密钥,并安装 langchain-openai 集成包。

凭证

前往 platform.openai.com 注册 OpenAI 并生成 API 密钥。完成此操作后,设置 OPENAI_API_KEY 环境变量:
要启用模型调用的自动跟踪,请设置您的 LangSmith API 密钥:

安装

LangChain OpenAI 集成包含在 langchain-openai 包中:

实例化

现在我们可以实例化模型对象并生成聊天补全:
Azure OpenAI v1 API 支持langchain-openai>=1.0.1 起,OpenAIEmbeddings 可以直接与 Azure OpenAI 端点配合使用新的 v1 API,包括对 Microsoft Entra ID 身份验证的支持。详情请参阅下文的 与 Azure OpenAI 配合使用 部分。

索引与检索

嵌入模型常用于检索增强生成(RAG)流程中,既用于索引数据,也用于后续检索数据。更详细的说明,请参阅我们的 RAG 教程 下面,了解如何使用我们上面初始化的 embeddings 对象来索引和检索数据。在此示例中,我们将在 InMemoryVectorStore 中索引和检索一个示例文档。

直接使用

在底层,向量存储和检索器实现分别调用 embeddings.embed_documents(...)embeddings.embed_query(...) 来为 from_texts 和检索 invoke 操作中使用的文本创建嵌入。 您可以直接调用这些方法来获取您自己用例的嵌入。

嵌入单个文本

您可以使用 embed_query 嵌入单个文本或文档:

嵌入多个文本

您可以使用 embed_documents 嵌入多个文本:

与 Azure OpenAI 配合使用

Azure OpenAI v1 API 支持langchain-openai>=1.0.1 起,OpenAIEmbeddings 可以直接与 Azure OpenAI 端点配合使用新的 v1 API。这提供了一种统一的方式来使用 OpenAI 嵌入,无论其托管在 OpenAI 还是 Azure 上。对于传统的 Azure 特定实现,请继续使用 AzureOpenAIEmbeddings

使用 API 密钥与 Azure OpenAI v1 API

要将 OpenAIEmbeddings 与 Azure OpenAI 配合使用,请将 base_url 设置为您的 Azure 端点,并附加 /openai/v1/

使用 Microsoft Entra ID 与 Azure OpenAI

v1 API 原生支持 Microsoft Entra ID 身份验证,并可自动刷新令牌。将令牌提供程序可调用对象传递给 api_key 参数:
安装要求要使用 Microsoft Entra ID 身份验证,请安装 Azure Identity 库:
您也可以在使用异步函数时,将令牌提供程序可调用对象传递给 api_key 参数。您必须从 azure.identity.aio 导入 DefaultAzureCredential:
当使用异步可调用对象作为 API 密钥时,必须使用异步方法(aembed_queryaembed_documents)。同步方法将引发错误。

API 参考

有关 OpenAIEmbeddings 功能和配置选项的详细文档,请参阅 API 参考