Skip to main content
Open In ColabOpen on GitHub

AzureAISearchRetriever

Azure AI Search（以前称为Azure Cognitive Search）是微软的云搜索服务，为开发者提供基础设施、API和工具，用于大规模检索向量、关键字和混合查询的信息。

AzureAISearchRetriever 是一个集成模块，用于从非结构化查询中返回文档。它基于 BaseRetriever 类，并针对 Azure AI Search 的 2023-11-01 稳定 REST API 版本，这意味着它支持向量索引和查询。

本指南将帮助您开始使用Azure AI搜索检索器。有关所有AzureAISearchRetriever功能和配置的详细文档，请访问API参考。

AzureAISearchRetriever 替换了 AzureCognitiveSearchRetriever，后者即将被弃用。我们建议切换到基于最新稳定版本搜索 API 的新版本。

集成详情​

检索器自托管云服务包
AzureAISearchRetriever❌✅langchain_community

设置​

要使用此模块，您需要：

  • 一个Azure AI搜索服务。如果您注册了Azure试用版，您可以免费创建一个。免费服务的配额较低，但足以运行此笔记本中的代码。

  • 一个现有的带有向量字段的索引。有几种方法可以创建一个，包括使用向量存储模块。或者，尝试Azure AI搜索REST API。

  • 一个API密钥。API密钥在创建搜索服务时生成。如果您只是查询索引，可以使用查询API密钥，否则请使用管理员API密钥。详情请参阅查找您的API密钥。

然后我们可以将搜索服务名称、索引名称和API密钥设置为环境变量（或者，您可以将它们作为参数传递给AzureAISearchRetriever）。搜索索引提供了可搜索的内容。

import os

os.environ["AZURE_AI_SEARCH_SERVICE_NAME"] = "<YOUR_SEARCH_SERVICE_NAME>"
os.environ["AZURE_AI_SEARCH_INDEX_NAME"] = "<YOUR_SEARCH_INDEX_NAME>"
os.environ["AZURE_AI_SEARCH_API_KEY"] = "<YOUR_API_KEY>"

如果你想从单个查询中获取自动追踪，你也可以通过取消注释以下内容来设置你的 LangSmith API 密钥：

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

安装​

这个检索器位于langchain-community包中。我们还需要一些额外的依赖项：

%pip install --upgrade --quiet langchain-community
%pip install --upgrade --quiet langchain-openai
%pip install --upgrade --quiet  azure-search-documents>=11.4
%pip install --upgrade --quiet  azure-identity

实例化​

对于AzureAISearchRetriever，提供一个index_name、content_key和top_k，设置为你想检索的结果数量。将top_k设置为零（默认值）将返回所有结果。

from langchain_community.retrievers import AzureAISearchRetriever

retriever = AzureAISearchRetriever(
    content_key="content", top_k=1, index_name="langchain-vector-demo"
)

用法​

现在你可以使用它从Azure AI搜索中检索文档。 这是你将调用的方法。它将返回与查询相关的所有文档。

retriever.invoke("here is my unstructured query string")

示例​

本节演示如何使用检索器处理内置的样本数据。如果您的搜索服务上已经有一个向量索引，可以跳过此步骤。

首先提供端点和密钥。由于我们在此步骤中创建向量索引，因此指定一个文本嵌入模型以获取文本的向量表示。此示例假设使用Azure OpenAI并部署了text-embedding-ada-002。由于此步骤创建索引，请确保使用搜索服务的管理员API密钥。

import os

from langchain_community.document_loaders import DirectoryLoader, TextLoader
from langchain_community.retrievers import AzureAISearchRetriever
from langchain_community.vectorstores import AzureSearch
from langchain_openai import AzureOpenAIEmbeddings, OpenAIEmbeddings
from langchain_text_splitters import TokenTextSplitter

os.environ["AZURE_AI_SEARCH_SERVICE_NAME"] = "<YOUR_SEARCH_SERVICE_NAME>"
os.environ["AZURE_AI_SEARCH_INDEX_NAME"] = "langchain-vector-demo"
os.environ["AZURE_AI_SEARCH_API_KEY"] = "<YOUR_SEARCH_SERVICE_ADMIN_API_KEY>"
azure_endpoint: str = "<YOUR_AZURE_OPENAI_ENDPOINT>"
azure_openai_api_key: str = "<YOUR_AZURE_OPENAI_API_KEY>"
azure_openai_api_version: str = "2023-05-15"
azure_deployment: str = "text-embedding-ada-002"

我们将使用Azure OpenAI的嵌入模型将我们的文档转换为存储在Azure AI搜索向量存储中的嵌入。我们还将索引名称设置为langchain-vector-demo。这将创建一个与该索引名称相关联的新向量存储。

embeddings = AzureOpenAIEmbeddings(
    model=azure_deployment,
    azure_endpoint=azure_endpoint,
    openai_api_key=azure_openai_api_key,
)

vector_store: AzureSearch = AzureSearch(
    embedding_function=embeddings.embed_query,
    azure_search_endpoint=os.getenv("AZURE_AI_SEARCH_SERVICE_NAME"),
    azure_search_key=os.getenv("AZURE_AI_SEARCH_API_KEY"),
    index_name="langchain-vector-demo",
)

接下来，我们将数据加载到我们新创建的向量存储中。在这个例子中，我们加载了state_of_the_union.txt文件。我们将文本分割成400个标记的块，没有重叠。最后，文档作为嵌入被添加到我们的向量存储中。

from langchain_community.document_loaders import TextLoader
from langchain_text_splitters import CharacterTextSplitter

loader = TextLoader("../../how_to/state_of_the_union.txt", encoding="utf-8")

documents = loader.load()
text_splitter = CharacterTextSplitter(chunk_size=400, chunk_overlap=0)
docs = text_splitter.split_documents(documents)

vector_store.add_documents(documents=docs)

接下来，我们将创建一个检索器。当前的 index_name 变量是上一步中的 langchain-vector-demo。如果你跳过了向量存储的创建，请在参数中提供你的索引名称。在此查询中，将返回最上面的结果。

retriever = AzureAISearchRetriever(
    content_key="content", top_k=1, index_name="langchain-vector-demo"
)

现在我们可以从我们上传的文档中检索与我们的查询相关的数据。

retriever.invoke("does the president have a plan for covid-19?")

在链中使用​

from langchain_core.output_parsers import StrOutputParser
from langchain_core.prompts import ChatPromptTemplate
from langchain_core.runnables import RunnablePassthrough
from langchain_openai import ChatOpenAI

prompt = ChatPromptTemplate.from_template(
    """Answer the question based only on the context provided.

Context: {context}

Question: {question}"""
)

llm = ChatOpenAI(model="gpt-4o-mini")


def format_docs(docs):
    return "\n\n".join(doc.page_content for doc in docs)


chain = (
    {"context": retriever | format_docs, "question": RunnablePassthrough()}
    | prompt
    | llm
    | StrOutputParser()
)
chain.invoke("does the president have a plan for covid-19?")

API参考​

有关所有AzureAISearchRetriever功能和配置的详细文档，请访问API参考。

这个页面有帮助吗？