Skip to main content
LibreChat is joining ClickHouse to power the open-source Agentic Data Stack 🎉 Learn more
LibreChat

Azure AI Search

如何配置 Azure AI Search 以便在 GPT 的协助下回答您的问题。

Azure AI Search 是一种内置的智能体工具,允许智能体查询您的 Azure AI Search 索引,并将返回的文档用于回答问题。

配置

必需

要开始使用,您需要一个 Azure AI Search endpoint URL、索引名称和 API 密钥。请在您的 .env 文件中定义它们:

AZURE_AI_SEARCH_SERVICE_ENDPOINT="..."
AZURE_AI_SEARCH_INDEX_NAME="..."
AZURE_AI_SEARCH_API_KEY="..."

AZURE_AI_SEARCH_SERVICE_ENDPOINT

这是搜索 endpoint 的 URL。它可以从 Cognitive Search 管理控制台的搜索服务首页获取(例如 https://example.search.windows.net)。

AZURE_AI_SEARCH_INDEX_NAME

这是要搜索的索引名称(例如 hotels-sample-index)。

AZURE_AI_SEARCH_API_KEY

这是使用 search endpoint 时需要使用的身份验证密钥。请从管理控制台颁发该密钥。请使用“值 (Value)”,而不是身份验证密钥的名称。

教程简介

在 Azure Portal 上创建或登录您的账户

1. 访问 https://azure.microsoft.com/en-us/ 并点击 Get startedTry Azure for Free 以创建账户并登录。

2. 选择按量付费或价值 $200 的 Azure 免费额度。

image

创建 Azure AI Search 服务

1. 访问您的控制面板。

2. 点击 Create a resource

image

3. 在搜索栏中搜索 Azure Search 并按回车键。

image

4. 现在,点击 Create

5. 配置基本设置,创建新的资源组或选择现有的资源组,为服务名称(Service Name)命名,然后选择位置。

image

6. 点击 Change Pricing Tier

image

现在选择免费选项或选择您偏好的选项(可能会产生费用)。

image

7. 点击 Review + create 并等待资源创建完成。

image

创建您的索引

1. 点击 Import data

image

2. 按照 Microsoft 教程操作:https://learn.microsoft.com/en-us/azure/search/search-get-started-portal,完成后,请将指定的索引名称保存到某处。

3. 现在您已经有了 AZURE_AI_SEARCH_INDEX_NAME,请将其复制并保存在本地安全的地方。

获取 Endpoint

1.Url: 中,你可以找到你的 AZURE_AI_SEARCH_SERVICE_ENDPOINT,请将其复制并保存在本地安全的地方。

image

2. 在左侧面板上,点击 keys

image

3. 点击 Add 并为您的密钥输入一个名称。

4. 复制密钥以获取 AZURE_AI_SEARCH_API_KEY

image

将工具添加到 Agent

添加环境变量后,重启 LibreChat 并将 Azure AI Search 添加到智能体中。

部署方式命令
Dockerdocker compose down && docker compose up -d
本地停止服务器,然后再次运行 npm run backend

在 LibreChat 中,选择 Agents,创建或编辑一个 agent,打开该 agent 的 Tools 列表,选择 Azure AI Search,然后保存该 agent。

测试它

向智能体提问,使其通过你的 Azure AI Search 索引进行回答。如果工具返回的内容过多,请调整 AZURE_AI_SEARCH_SEARCH_OPTION_TOPAZURE_AI_SEARCH_SEARCH_OPTION_SELECT

image

可选

以下是配置值,它们不是必需的,但可以在搜索过程中作为参数指定。

如果担心搜索结果数据过大并超过提示词(prompt)限制,请考虑通过使用 AZURE_AI_SEARCH_SEARCH_OPTION_TOP 和 AZURE_AI_SEARCH_SEARCH_OPTION_SELECT 来减小搜索结果数据的大小。

有关每个参数的详细信息,请参阅以下文档: https://learn.microsoft.com/en-us/rest/api/searchservice/search-documents

AZURE_AI_SEARCH_API_VERSION=2023-10-01-Preview
AZURE_AI_SEARCH_SEARCH_OPTION_QUERY_TYPE=simple
AZURE_AI_SEARCH_SEARCH_OPTION_TOP=3
AZURE_AI_SEARCH_SEARCH_OPTION_SELECT=field1, field2, field3

AZURE_AI_SEARCH_API_VERSION

指定搜索 API 的版本。当使用语义搜索或向量搜索等新功能时,您可能需要指定预览版本。默认值为 2023-11-1

AZURE_AI_SEARCH_SEARCH_OPTION_QUERY_TYPE

指定 simplefull。默认值为 simple

AZURE_AI_SEARCH_SEARCH_OPTION_TOP

指定要搜索的项目数量。默认值为 5。

AZURE_AI_SEARCH_SEARCH_OPTION_SELECT

指定要检索的索引字段,以逗号分隔。请注意,这些不是要搜索的字段。

这篇指南怎么样?