Skip to main content
Azure AI Search（以前称为 Azure Cognitive Search）是一种 Microsoft 云搜索服务，为开发者提供基础设施、API 和工具，用于大规模的向量、关键词和混合查询的信息检索。 AzureAISearchRetriever 是一个集成模块，用于从非结构化查询返回文档。它基于 BaseRetriever 类，针对 Azure AI Search 的 2023-11-01 稳定 REST API 版本，这意味着它支持向量索引和查询。 本指南将帮助您开始使用 Azure AI Search 检索器。有关所有 AzureAISearchRetriever 功能和配置的详细文档，请访问 API 参考。 AzureAISearchRetriever 取代了 AzureCognitiveSearchRetriever，后者即将被弃用。我们建议切换到基于搜索 API 最新稳定版本的新版本。

​
集成详情

​
设置

要使用此模块，您需要：
  • 一个 Azure AI 搜索服务。如果您注册 Azure 试用版，可以免费创建一个。免费服务的配额较低，但足以运行本笔记本中的代码。
  • 一个包含向量字段的现有索引。有几种创建方法，包括使用向量存储模块。或者，尝试 Azure AI 搜索 REST API。
  • 一个 API 密钥或 Azure AD 令牌。
然后，我们可以将搜索服务名称、索引名称和 API 密钥设置为环境变量（或者，您可以将它们作为参数传递给 AzureAISearchRetriever）。搜索索引提供可搜索的内容。 使用 API 密钥 
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>"
使用 Azure AD 令牌 
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_AD_TOKEN"] = "<YOUR_AZURE_AD_TOKEN>"
如果您想从单个查询获取自动跟踪，还可以通过取消注释以下内容来设置您的 LangSmith API 密钥： 
os.environ["LANGSMITH_API_KEY"] = getpass.getpass("Enter your LangSmith API key: ")
os.environ["LANGSMITH_TRACING"] = "true"

​
安装

此检索器位于 langchain-community 包中。我们还需要一些额外的依赖项： 
pip install -qU langchain-community
pip install -qU langchain-openai
pip install -qU  azure-search-documents>=11.4
pip install -qU  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 Search 检索文档。 这是您调用以执行此操作的方法。它将返回与查询相关的所有文档。 
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 Search 向量存储中。我们还将索引名称设置为 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-4.1-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 参考。
在 GitHub 上编辑此页面 或 提交问题。
通过 MCP 将这些文档连接到 Claude、VSCode 等 以获取实时答案。