OpenAIEmbeddings

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

概述

集成详情

Provider	Package
OpenAI	langchain-openai

设置

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

凭证

前往 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: ")

安装

LangChain 的 OpenAI 集成位于 langchain-openai 包：

%pip install -qU langchain-openai

实例化

现在，我们可以实例化我们的模型对象并生成聊天补全：

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 Reference:OpenAIEmbeddings

索引与检索

Embedding 模型常用于检索增强生成 (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 Reference:InMemoryVectorStore

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

直接使用

在底层，vectorstore 和 retriever 的实现会调用 embeddings.embed_documents(...) 和 embeddings.embed_query(...)，分别用于为 from_texts 和检索 invoke 操作中使用的文本创建 embeddings。

你可以直接调用这些方法来为自己的用例获取 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 参考。

Related

• Embedding model conceptual guide
• Embedding model how-to guides