OpenAI嵌入模型

这将帮助您使用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["LANGCHAIN_TRACING_V2"] = "true"
# os.environ["LANGCHAIN_API_KEY"] = getpass.getpass("Enter your LangSmith API key: ")

安装

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

%pip install -qU langchain-openai

实例化

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

<!--IMPORTS:[{"imported": "OpenAIEmbeddings", "source": "langchain_openai", "docs": "https://python.langchain.com/api_reference/openai/embeddings/langchain_openai.embeddings.base.OpenAIEmbeddings.html", "title": "OpenAIEmbeddings"}]-->
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
)

索引和检索

嵌入模型通常用于检索增强生成 (RAG) 流程，既作为索引数据的一部分，也用于后续的检索。有关更详细的说明，请参见我们在 使用外部知识的教程 下的 RAG 教程。

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

<!--IMPORTS:[{"imported": "InMemoryVectorStore", "source": "langchain_core.vectorstores", "docs": "https://python.langchain.com/api_reference/core/vectorstores/langchain_core.vectorstores.in_memory.InMemoryVectorStore.html", "title": "OpenAIEmbeddings"}]-->
# 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

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

直接使用

在底层，向量存储和检索器实现调用 embeddings.embed_documents(...) 和 embeddings.embed_query(...) 来为 from_texts 和检索 invoke 操作中使用的文本创建嵌入。

您可以直接调用这些方法以获取适合您自己用例的嵌入。

嵌入单个文本

您可以使用 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 参考。

相关

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