项目简介
azure-search-openai-demo-csharp是由Microsoft Azure Samples提供的一个开源示例项目,旨在展示如何使用Azure OpenAI和Azure AI Search构建类似ChatGPT的企业数据聊天应用。该项目采用了检索增强生成(Retrieval Augmented Generation, RAG)模式,利用Azure OpenAI Service访问ChatGPT模型(gpt-4o-mini),并使用Azure AI Search进行数据索引和检索。
项目包含了示例数据,可以直接运行体验。在这个示例应用中,使用了一个名为Contoso Electronics的虚构公司,员工可以询问有关公司福利、内部政策以及工作描述和角色等问题。
主要功能特性
azure-search-openai-demo-csharp项目具有以下主要功能特性:
- 提供语音聊天、文本聊天和问答界面
- 探索各种选项帮助用户评估回答的可信度,包括引用、源内容跟踪等
- 展示了数据准备、提示构建以及模型(ChatGPT)和检索器(Azure AI Search)之间交互编排的可能方法
- 在用户界面中直接提供设置选项,可以调整行为并尝试不同选项
应用架构
该应用的架构主要包含以下组件:
-
用户界面 - 应用的聊天界面是一个Blazor WebAssembly应用。该界面接受用户查询,将请求路由到应用后端,并显示生成的响应。
-
后端 - 应用后端是一个ASP.NET Core Minimal API。后端托管Blazor静态Web应用,并协调不同服务之间的交互。使用的服务包括:
-
Azure AI Search – 索引存储在Azure Storage Account中的文档数据。这使得文档可以使用向量搜索功能进行搜索。
-
Azure OpenAI Service – 提供大型语言模型生成响应。Semantic Kernel与Azure OpenAI Service一起使用,用于编排更复杂的AI工作流。
-
部署和使用
账户要求
要部署和运行此示例,你需要:
- Azure账户 - 如果你是Azure新用户,可以免费获得Azure账户和一些免费的Azure积分。
- Azure账户权限 - 你的Azure账户必须具有
Microsoft.Authorization/roleAssignments/write权限,例如用户访问管理员或所有者。
项目设置
你有几种选择来设置此项目。最简单的方法是使用GitHub Codespaces,因为它会为你设置所有工具,但你也可以在本地环境中设置。
GitHub Codespaces
你可以使用GitHub Codespaces在浏览器中虚拟运行此存储库,这将打开一个基于Web的VS Code:
本地环境
安装以下先决条件:
- Azure Developer CLI
- .NET 8
- Git
- Powershell 7+ (pwsh) - 仅适用于Windows用户
- Docker
然后,运行以下命令在本地环境中获取项目:
- 运行
azd auth login - 克隆存储库或运行
azd init -t azure-search-openai-demo-csharp - 运行
azd env new azure-search-openai-demo-csharp
部署
从头开始部署
如果你没有任何预先存在的Azure服务,并希望从全新部署开始,请执行以下命令:
-
运行
azd up- 这将预配Azure资源并将此示例部署到这些资源,包括基于./data文件夹中找到的文件构建搜索索引。-
对于目标位置,目前支持此示例中使用的模型的区域是East US或Sweden Central。有关区域和模型的最新列表,请查看这里。
-
如果你有权访问多个Azure订阅,系统会提示你选择要使用的订阅。如果你只有一个订阅的访问权限,它将自动被选择。
-
-
应用程序成功部署后,你将在控制台中看到一个URL。单击该URL以在浏览器中与应用程序交互。
使用应用
- 在Azure中:导航到由
azd部署的Azure Container App。URL在azd完成时打印出来(作为"Endpoint"),或者你可以在Azure门户中找到它。 - 在本地运行时,导航到http://localhost:7181以访问客户端应用,导航到http://localhost:7181/swagger以访问Open API服务器页面。
进入Web应用后:
- 在语音聊天页面,选择语音设置对话框并配置文本到语音的首选项。
- 你可以键入消息与Blazor Clippy交互,也可以选择Speak切换按钮使用语音转文本作为输入。
- 在聊天上下文中尝试不同的主题。对于聊天,尝试后续问题、澄清、要求简化或详细说明答案等。
- 探索引用和来源
- 单击"设置"图标尝试不同的选项,调整提示等。
可选功能
启用Application Insights
要启用Application Insights并跟踪每个请求,以及记录错误,请在运行azd up之前将AZURE_USE_APPLICATION_INSIGHTS变量设置为true:
- 运行
azd env set AZURE_USE_APPLICATION_INSIGHTS true - 运行
azd up
启用身份验证
默认情况下,部署的Azure容器应用没有启用身份验证或访问限制,这意味着任何具有可路由网络访问权限的人都可以与你的索引数据聊天。你可以按照添加容器应用身份验证教程要求对你的Azure Active Directory进行身份验证,并针对已部署的容器应用进行设置。
启用视觉(多模态)支持
使用GPT-4o-mini,可以通过提供文本和图像作为源内容来支持丰富的检索增强生成。要启用视觉支持,你需要在配置时启用USE_VISION并使用GPT-4o或GPT-4o-mini模型。
生产化考虑
这个示例旨在作为你自己的生产应用程序的起点,但在部署到生产环境之前,你应该对安全性和性能进行全面审查。以下是一些需要考虑的事项:
- OpenAI容量: 默认TPM(每分钟令牌数)设置为30K。这相当于每分钟大约30个对话(假设每个用户消息/响应1K)。
- Azure存储: 默认存储帐户使用
Standard_LRSSKU。为了提高弹性,我们建议在生产部署中使用Standard_ZRS。 - Azure AI搜索: 如果你看到有关超出搜索服务容量的错误,增加副本数可能会有所帮助。
- Azure容器应用: 默认情况下,此应用程序部署的容器具有0.5个CPU核心和1GB内存。最小副本数为1,最大为10。
- 身份验证: 默认情况下,部署的应用是公开可访问的。我们建议限制对经过身份验证的用户的访问。
- 网络: 我们建议在虚拟网络内部署。如果应用程序仅供内部企业使用,请使用专用DNS区域。
- 负载测试: 我们建议为你预期的用户数量运行负载测试。
资源
- 使用ChatGPT革新你的企业数据:使用Azure OpenAI和Azure AI搜索的下一代应用
- Azure AI搜索
- Azure OpenAI服务
Azure.AI.OpenAINuGet包- 原始Blazor应用
通过这个示例项目,开发者可以快速上手构建基于Azure OpenAI和Azure AI Search的智能企业数据聊天应用,实现类似ChatGPT的交互体验。项目提供了完整的部署和使用指南,同时也给出了生产化的建议,为企业级应用开发提供了很好的参考。🚀💻🤖
