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("AZURE_OPENAI_API_KEY"):
os.environ["AZURE_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
)
索引与检索
嵌入模型通常用于检索增强生成（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.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参考。