OpenAI 嵌入

这将帮助您使用 LangChain 开始使用 OpenAI 嵌入模型。有关 OpenAIEmbeddings 功能和配置选项的详细文档，请参阅 API 参考。

概览

集成细节

提供者	包
OpenAI	langchain-openai

设置

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

Credentials

前往 platform.openai.com 注册 OpenAI 并生成一个 API 密钥。完成此操作后，请设置 OPENAI_API_KEY 环境变量：

import getpass
import os

if not os.getenv("OPENAI_API_KEY"):
    os.environ["OPENAI_API_KEY"] = getpass.getpass("Enter your OpenAI API key: ")

要启用对您的模型调用的自动跟踪，请设置您的LangSmith API密钥：

# os.environ["LANGSMITH_TRACING"] = "true"
# os.environ["LANGSMITH_API_KEY"] = getpass.getpass("Enter your LangSmith API key: ")

安装

The LangChain OpenAI 整合模块位于 langchain-openai 包中:

%pip install -qU langchain-openai

Instantiation

现在我们就可以实例化我们的模型对象并生成聊天完成内容:

from langchain_openai import OpenAIEmbeddings

embeddings = OpenAIEmbeddings(
    model="text-embedding-3-large",
    # With the `text-embedding-3` class
    # of models, you can specify the size
    # of the embeddings you want returned.
    # dimensions=1024
)

API 参考:OpenAI 嵌入

索引与检索​

嵌入模型通常用于检索增强生成（RAG）流程中，既用于数据索引，也用于后续的数据检索。有关更详细的说明，请参阅我们的 RAG 教程。

以下，查看如何使用我们上面初始化的 embeddings 对象来索引和检索数据。在此示例中，我们将在 InMemoryVectorStore 中索引并检索一个示例文档。

# Create a vector store with a sample text
from langchain_core.vectorstores import InMemoryVectorStore

text = "LangChain is the framework for building context-aware reasoning applications"

vectorstore = InMemoryVectorStore.from_texts(
    [text],
    embedding=embeddings,
)

# Use the vectorstore as a retriever
retriever = vectorstore.as_retriever()

# Retrieve the most similar text
retrieved_documents = retriever.invoke("What is LangChain?")

# show the retrieved document's content
retrieved_documents[0].page_content

API 参考:内存向量存储

'LangChain is the framework for building context-aware reasoning applications'

直接使用​

在底层，向量存储和检索器实现会调用 embeddings.embed_documents(...) 和 embeddings.embed_query(...) 分别为用于 from_texts 和检索 invoke 操作的文本生成嵌入。

您可以直接调用这些方法，以获取适用于您自身用例的嵌入（embeddings）。

嵌入单个文本​

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

single_vector = embeddings.embed_query(text)
print(str(single_vector)[:100])  # Show the first 100 characters of the vector

[-0.019276829436421394, 0.0037708976306021214, -0.03294256329536438, 0.0037671267054975033, 0.008175

嵌入多个文本​

您可以通过 embed_documents 嵌入多个文本：

text2 = (
    "LangGraph is a library for building stateful, multi-actor applications with LLMs"
)
two_vectors = embeddings.embed_documents([text, text2])
for vector in two_vectors:
    print(str(vector)[:100])  # Show the first 100 characters of the vector

[-0.019260549917817116, 0.0037612367887049913, -0.03291035071015358, 0.003757466096431017, 0.0082049
[-0.010181212797760963, 0.023419594392180443, -0.04215526953339577, -0.001532090245746076, -0.023573

API 参考

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

相关

• 嵌入模型 概念指南
• 嵌入模型 使用指南