以编程方式使用文档

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

概述

集成详情

设置

To access OpenAI embedding models you'll need to create a/an OpenAI account, get an API key, and install the langchain-openai 集成包。

凭证

前往 platform.openai.com 注册 OpenAI 并生成 API 密钥。完成后设置 OPENAI_API_KEY 环境变量：

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

如果通过代理或服务模拟器路由请求，可以通过环境变量设置基础 URL，而不是传递 base_url。解析顺序（首次匹配优先）：

  1. 显式 base_url (or openai_api_base) 关键字参数。
  2. OPENAI_API_BASE — 在初始化时由 LangChain 读取。
  3. OPENAI_BASE_URL — 由底层 openai SDK 客户端读取。

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

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

安装

LangChain OpenAI 集成位于 langchain-openai package:

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
)

索引和检索

嵌入模型常用于检索增强生成 (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
'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

使用 Azure OpenAI

使用 Azure OpenAI v1 API 与 API 密钥

要使用 OpenAIEmbeddings 与 Azure OpenAI，请将 base_url 设置为您的 Azure 端点，添加 /openai/v1/ appended:

from langchain_openai import OpenAIEmbeddings

embeddings = OpenAIEmbeddings(
    model="text-embedding-3-large",  # Your Azure deployment name
    base_url="https://{your-resource-name}.openai.azure.com/openai/v1/",
    api_key="your-azure-api-key"
)

# Use as normal
vector = embeddings.embed_query("Hello world")

将 Azure OpenAI 与 Microsoft Entra ID 结合使用

v1 API 添加了对 Microsoft Entra ID 身份验证的本机支持，并具有自动令牌刷新功能。将令牌提供程序可调用对象传递给 api_key parameter:

from azure.identity import DefaultAzureCredential, get_bearer_token_provider
from langchain_openai import OpenAIEmbeddings

# Create a token provider that handles automatic refresh
token_provider = get_bearer_token_provider(
    DefaultAzureCredential(),
    "https://cognitiveservices.azure.com/.default"
)

embeddings = OpenAIEmbeddings(
    model="text-embedding-3-large",  # Your Azure deployment name
    base_url="https://{your-resource-name}.openai.azure.com/openai/v1/",
    api_key=token_provider  # Callable that handles token refresh
)

# Use as normal
vectors = embeddings.embed_documents(["Hello", "World"])

您还可以将令牌提供程序可调用对象传递给 api_key 参数（当使用 异步函数时）。您必须从 azure.identity.aio:

from azure.identity.aio import DefaultAzureCredential
from langchain_openai import OpenAIEmbeddings

credential = DefaultAzureCredential()

embeddings_async = OpenAIEmbeddings(
    model="text-embedding-3-large",
    api_key=credential
)

# Use async methods when using async callable
vectors = await embeddings_async.aembed_documents(["Hello", "World"])

API 参考

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