AzureOpenAIEmbeddings

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

概述

集成细节

提供者	包
AzureOpenAI	langchain-openai

设置

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

凭据

您需要部署一个 Azure OpenAI 实例。您可以按照此指南在 Azure 门户上部署一个版本。

实例运行后，请确保您拥有实例的名称和密钥。您可以在 Azure 门户中实例的“密钥和端点”部分找到密钥。

AZURE_OPENAI_ENDPOINT=<YOUR API ENDPOINT>
AZURE_OPENAI_API_KEY=<YOUR_KEY>
AZURE_OPENAI_API_VERSION="2024-02-01"

import getpass
import os

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

如果您希望自动跟踪模型调用，您还可以通过取消注释以下内容来设置您的LangSmith API 密钥

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

安装

LangChain AzureOpenAI 集成位于langchain-openai 包中

%pip install -qU langchain-openai

实例化

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

from langchain_openai import AzureOpenAIEmbeddings

embeddings = AzureOpenAIEmbeddings(
    model="text-embedding-3-large",
    # dimensions: Optional[int] = None, # Can specify dimensions with new text-embedding-3 models
    # azure_endpoint="https://<your-endpoint>.openai.azure.com/", If not provided, will read env variable AZURE_OPENAI_ENDPOINT
    # api_key=... # Can provide an API key directly. If missing read env variable AZURE_OPENAI_API_KEY
    # openai_api_version=..., # If not provided, will read env variable AZURE_OPENAI_API_VERSION
)

API 参考：AzureOpenAIEmbeddings

索引和检索

嵌入模型通常用于检索增强生成 (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 参考：InMemoryVectorStore

'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.0011676070280373096, 0.007125577889382839, -0.014674457721412182, -0.034061674028635025, 0.01128

嵌入多个文本

您可以使用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.0011966148158535361, 0.007160289213061333, -0.014659193344414234, -0.03403077274560928, 0.011280
[-0.005595256108790636, 0.016757294535636902, -0.011055258102715015, -0.031094247475266457, -0.00363

API 参考

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

相关

• 嵌入模型概念指南
• 嵌入模型操作指南