---

page_type: 示例 languages:

• azdeveloper
• csharp
• html
• bicep products:
• ai-services
• azure-blob-storage
• azure-container-apps
• azure-cognitive-search
• azure-openai
• aspnet-core
• blazor
• defender-for-cloud
• azure-monitor
• dotnet-maui urlFragment: azure-search-openai-demo-csharp name: ChatGPT + 企业数据 (csharp) description: 一个使用 OpenAI 和 AI 搜索与您的数据对话的 C# 示例应用。

---

目录

• 功能
• 应用程序架构
• Azure 账户要求
• 开始使用
  • 成本估算
  • 项目设置
    • GitHub Codespaces
    • VS Code 远程容器
    • 本地环境
  • 部署
    • 从头开始部署
    • 使用现有 Azure 资源部署
    • 再次部署
    • 使用 App Spaces 部署
    • 本地运行
    • 共享环境
    • 清理资源
  • 使用应用程序
• 启用可选功能
  • 启用 Application Insights
  • 启用身份验证
  • 启用 GPT-4V 支持
• 指导
  • 生产化
  • 资源
  • 常见问题

使用 Azure OpenAI 和 Azure AI 搜索的 ChatGPT + 企业数据 (.NET)

本示例演示了如何使用检索增强生成模式，在您自己的数据上构建类似 ChatGPT 的体验。它使用 Azure OpenAI 服务访问 ChatGPT 模型 (gpt-4o-mini) ，并使用 Azure AI 搜索进行数据索引和检索。

该仓库包含示例数据，因此您可以直接从头到尾尝试。在这个示例应用程序中，我们使用一家名为 Contoso Electronics 的虚构公司，该体验允许其员工询问有关福利、内部政策以及职位描述和角色的问题。

有关此应用程序构建方式的更多详细信息，请参阅：

• 利用 Azure 和 ChatGPT 提供支持的智能 .NET 应用程序改变您的业务博客文章
• 使用 .NET 和 Azure 构建智能应用程序 - Build 会议

我们很想听听您的意见！您是否有兴趣构建或目前正在构建智能应用程序？请花几分钟时间完成这份调查问卷。

参与调查

功能

• 语音聊天、聊天和问答界面
• 探索多种选项，帮助用户通过引用、源内容跟踪等方式评估响应的可信度
• 展示数据准备、提示构造以及模型 (ChatGPT) 和检索器 (Azure AI 搜索) 之间交互编排的可能方法
• 在用户体验中直接提供设置，以调整行为并试验不同选项

应用程序架构

• 用户界面 - 应用程序的聊天界面是一个 Blazor WebAssembly 应用程序。该界面负责接收用户查询、将请求路由到应用程序后端，并显示生成的响应。
• 后端 - 应用程序后端是 ASP.NET Core Minimal API。后端托管 Blazor 静态 Web 应用程序，并负责协调不同服务之间的交互。本应用程序中使用的服务包括：
  • Azure AI 搜索 – 将存储在 Azure 存储帐户中的文档编制索引。这使得文档能够使用 向量搜索 功能进行搜索。
  • Azure OpenAI 服务 – 提供大型语言模型来生成响应。Semantic Kernel 与 Azure OpenAI 服务结合使用，用于编排更复杂的 AI 工作流。

开始使用

账户要求

为了部署和运行本示例，您需要

• Azure 账户 - 如果您是 Azure 新手，请获取一个 免费 Azure 账户，您将获得一些免费的 Azure 积分以开始使用。
• Azure 账户权限 - 您的 Azure 账户必须具有 Microsoft.Authorization/roleAssignments/write 权限，例如 用户访问管理员 或 所有者。

[!警告]
默认情况下，本示例将创建每月会产生费用的 Azure 容器应用和 Azure AI 搜索资源，以及按文档页数计费的 Azure AI 文档智能资源。如果您想避免这些费用，可以通过更改 infra 文件夹下的参数文件将其切换为免费版本（不过需要注意一些限制；例如，每个订阅最多只能有一个免费的 Azure AI 搜索资源，而免费的 Azure AI 文档智能资源仅分析每份文档的前两页。)

成本估算

定价因地区和使用情况而异，因此无法准确预测您的具体费用。不过，您可以使用 Azure 定价计算器 来估算以下资源的成本：

• Azure 容器应用。环境类型：仅按使用量计费。该解决方案使用按使用量计费计划，因为我们没有特定的硬件要求。
• Azure OpenAI 服务。标准层，GPT 和 Ada 模型。按每 1,000 个 token 的用量计费，且每个问题至少会使用 1,000 个 token。
• Azure AI 文档智能。使用预构建布局的 SO（标准）层。按文档页数计费，示例文档共有 261 页。
• Azure AI 搜索 基本层，1 个副本，免费语义搜索级别。按小时计费。
• Azure Blob 存储。标准层，采用 ZRS（区域冗余存储）。按存储和读取操作计费。
• Azure Monitor。按需付费层。费用基于所摄入的数据。

为了降低成本，您可以切换到各种服务的免费 SKU，但这些 SKU 存在限制。有关更多详细信息，请参阅此低成本部署指南。

⚠️ 为避免不必要的成本，请务必在不再使用应用程序时将其关闭，方法是在门户中删除资源组，或运行 azd down。

项目设置

您有几种方式可以设置该项目。最简单的方式是使用 GitHub Codespaces，因为它会为您自动配置所有工具，但如果您愿意，也可以在本地进行设置。

GitHub Codespaces

您可以通过 GitHub Codespaces 虚拟运行此仓库，它将在您的浏览器中打开一个基于 Web 的 VS Code：

VS Code 远程容器

另一种相关选项是 VS Code 远程容器，它将使用 Dev Containers 扩展，在您的本地 VS Code 中打开该项目：

本地环境

请安装以下先决条件：

• Azure 开发者 CLI

• .NET 8

• Git

• Powershell 7+ (pwsh) - 仅适用于 Windows 用户。

  重要提示: 确保您可以在 PowerShell 命令行中运行 pwsh.exe。如果失败，您可能需要升级 PowerShell。

• Docker

  重要提示: 在运行任何 azd 配置或部署命令之前，请确保 Docker 已启动并正在运行。

然后，运行以下命令以在您的本地环境中获取该项目：

1. 运行 azd auth login
2. 克隆仓库或运行 azd init -t azure-search-openai-demo-csharp
3. 运行 azd env new azure-search-openai-demo-csharp

部署

从头开始部署

📺 直播：在 Codespaces 中从头开始部署 📺 直播：在 Windows 11 中从头开始部署

重要提示: 在运行任何 azd 配置或部署命令之前，请确保 Docker 已启动并正在运行。

如果您没有任何现有的 Azure 服务，并希望从头开始部署，请执行以下命令：

1. 运行 azd up - 此命令将配置 Azure 资源并将示例部署到这些资源上，包括根据 ./data 文件夹中的文件构建搜索索引。

• 对于目标位置，目前支持本示例中使用的模型的区域是 美国东部。有关最新区域和模型列表，请查看 此处。
• 如果您有权访问多个 Azure 订阅，系统将提示您选择要使用的订阅。如果您只有一份订阅权限，则会自动选择该订阅。

注释: 本应用程序使用 gpt-4o-mini 模型。在选择部署区域时，请确保该区域支持此模型（即美国东部）。更多信息请参阅 Azure OpenAI 服务文档。

1. 应用程序成功部署后，控制台将显示一个 URL。单击该 URL 即可在浏览器中与应用程序交互。

输出将如下所示：

部署完成后，还需要几分钟来处理要添加到向量数据库中的文档。

使用现有资源

如果您已在 Azure 中拥有想要使用的资源，可以通过设置以下 azd 环境变量来配置 azd 使用这些资源：

1. 运行 azd env set AZURE_OPENAI_SERVICE {现有 OpenAI 服务名称}
2. 运行 azd env set AZURE_OPENAI_RESOURCE_GROUP {OpenAI 服务所在的现有资源组名称}
3. 运行 azd env set AZURE_OPENAI_CHATGPT_DEPLOYMENT {现有 ChatGPT 部署名称}。仅当您的 ChatGPT 部署不是默认的 'chat' 时才需要。
4. 运行 azd env set AZURE_OPENAI_EMBEDDING_DEPLOYMENT {现有嵌入模型部署名称}。仅当您的嵌入模型部署不是默认的 embedding 时才需要。
5. 运行 azd up

!注意
您还可以使用现有的搜索和存储账户。有关要传递给 azd env set 以配置这些现有资源的环境变量列表，请参阅 ./infra/main.parameters.json。

部署或重新部署本地克隆的仓库

[!重要]
在运行任何 azd 配置或部署命令之前，请确保 Docker 已启动并正在运行。

• 运行 azd up

使用 App Spaces 部署您的仓库

[!NOTE]
确保您的仓库中包含 AZD 支持的 Bicep 文件，并添加一个初始的 GitHub Actions 工作流文件。该工作流可以手动触发（用于首次部署）或在代码更改时自动触发（使用最新更改重新部署）。 为使您的仓库与 App Spaces 兼容，您需要修改主 Bicep 文件和主参数文件，以允许 AZD 部署到具有相应标签的现有资源组。

1. 在主参数文件中添加 AZURE_RESOURCE_GROUP，以便从 App Spaces 在 GitHub Actions 工作流文件中设置的环境变量中读取值。

   "resourceGroupName": {
      "value": "${AZURE_RESOURCE_GROUP}"
    }
   

2. 在主参数文件中添加 AZURE_TAGS，以便从 App Spaces 在 GitHub Actions 工作流文件中设置的环境变量中读取值。

   "tags": {
      "value": "${AZURE_TAGS}"
    }
   

3. 在主 Bicep 文件中添加对资源组和标签的支持，以读取由 App Spaces 设置的值。

   param resourceGroupName string = ''
   param tags string = ''
   

4. 将 Azd 设置的默认标签与 App Spaces 设置的标签合并。将主 Bicep 文件中的 tags 初始化 替换为以下内容：

   var baseTags = { 'azd-env-name': environmentName }
   var updatedTags = union(empty(tags) ? {} : base64ToJson(tags), baseTags)
   使用 "updatedTags" 为 Bicep 文件中创建的资源组分配 "tags"，并将其他资源更新为使用 "baseTags" 而不是 "tags"。例如：
   ```json
   resource rg 'Microsoft.Resources/resourceGroups@2021-04-01' = {
     name: !empty(resourceGroupName) ? resourceGroupName : '${abbrs.resourcesResourceGroups}${environmentName}'
     location: location
     tags: updatedTags
   }
   

本地运行

[!IMPORTANT]
在运行任何 azd 配置/部署命令之前，请确保 Docker 已启动并正在运行。

1. 运行 azd auth login

2. 应用程序部署完成后，设置环境变量 AZURE_KEY_VAULT_ENDPOINT。您可以在 .azure/YOUR-ENVIRONMENT-NAME/.env 文件或 Azure 门户中找到该值。

3. 运行以下 .NET CLI 命令以启动 ASP.NET Core Minimal API 服务器（客户端主机）：

   dotnet run --project ./app/backend/MinimalApi.csproj --urls=http://localhost:7181/
   

导航至 http://localhost:7181,测试应用程序。

使用 .NET MAUI 客户端本地运行

此示例包含一个 .NET MAUI 客户端，将体验打包成可在 Windows/macOS 桌面以及 Android 和 iOS 设备上运行的应用程序。这里的 MAUI 客户端使用 Blazor 混合实现，使其能够与网站前端共享大部分代码。

1. 打开 app/app-maui.sln 以打开包含 MAUI 客户端的解决方案
2. 编辑 app/maui-blazor/MauiProgram.cs，将 client.BaseAddress 更新为后端的 URL。 如果是在 Azure 上运行，则使用上述步骤中的服务后端 URL；如果是在本地运行，则使用 http://localhost:7181。
3. 将 MauiBlazor 设置为启动项目并运行应用程序

共享环境

如果您想让其他人访问已部署的现有环境，请执行以下操作：

1. 安装 Azure CLI
2. 运行 azd init -t azure-search-openai-demo-csharp
3. 运行 azd env refresh -e {environment name} - 请注意，他们需要 azd 环境名称、订阅 ID 和位置才能运行此命令，这些信息可在您的 ./azure/{env name}/.env 文件中找到。这将填充他们的 azd 环境的 .env 文件，包含在本地运行应用程序所需的所有设置。
4. 运行 pwsh ./scripts/roles.ps1 - 这将为用户分配所有必要的角色，以便他们能够在本地运行应用程序。如果他们没有在订阅中创建角色的权限，则可能需要您代为运行此脚本。只需确保在 azd .env 文件或当前 shell 中将 AZURE_PRINCIPAL_ID 环境变量设置为用户的 Azure ID，该 ID 可通过 az account show 获取。

清理资源

运行 azd down

使用应用程序

• 在 Azure 中：导航至由 azd 部署的 Azure 容器应用。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。

1. 运行 azd env set AZURE_USE_APPLICATION_INSIGHTS true
2. 运行 azd up

要查看性能数据，前往您资源组中的 Application Insights 资源，单击“Investigate -> Performance”面板，然后导航到任意 HTTP 请求以查看计时数据。 要检查聊天请求的性能，使用“Drill into Samples”按钮查看针对任何聊天请求所进行的所有 API 调用的端到端跟踪记录：

要查看任何异常和服务器错误，导航到“Investigate -> Failures”面板，并使用筛选工具定位特定异常。您可以在右侧看到 Python 堆栈跟踪。

启用身份验证

默认情况下，部署的 Azure 容器应用不会启用任何身份验证或访问限制，这意味着任何具有可路由网络访问权限的人都可以与您索引的数据进行对话。您可以通过遵循 添加容器应用身份验证 教程，并将其配置到已部署的容器应用上，来要求使用 Azure Active Directory 进行身份验证。

要将访问权限限制为特定用户或组，您可以按照 将 Azure AD 应用程序限制为一组用户 中的步骤操作：在企业应用程序中更改“是否需要分配？”选项，然后为用户/组分配访问权限。未被明确授予访问权限的用户将收到错误消息 -AADSTS50105: 您的管理员已将应用程序 配置为阻止用户访问，除非他们被特别授予（“分配”）对该应用程序的访问权限。-

启用视觉（多模态）支持

借助 GPT-4o-mini，可以通过同时提供文本和图像作为源内容，实现增强的检索增强生成。要启用视觉支持，您需要在预配时启用 USE_VISION 并使用 GPT-4o 或 GPT-4o-mini 模型。

!注意 如果您之前已经部署了应用程序，在启用 GPT-4o 支持后，您需要重新索引支持材料并重新部署应用程序。这是因为启用 GPT-4o 支持需要向搜索索引中添加新字段。

要通过 Azure OpenAI 服务启用 GPT-4V 支持，请运行以下命令：

azd env set USE_VISION true
azd env set USE_AOAI true
azd env set AZURE_OPENAI_CHATGPT_MODEL_NAME gpt-4o-mini
azd env set AZURE_OPENAI_RESOURCE_LOCATION eastus # 请查看 GPT 模型的可用性以获取更多详细信息。
azd up

要通过 OpenAI 启用视觉支持，请运行以下命令：

azd env set USE_VISION true
azd env set USE_AOAI false
azd env set OPENAI_CHATGPT_DEPLOYMENT gpt-4o
azd up

要清理之前部署的资源，请运行以下命令：

azd down --purge
azd env set AZD_PREPDOCS_RAN false # 这是为了确保文档会使用新字段重新索引。

指导

除了以下提示外，您还可以在 docs 文件夹中找到详细的文档。

生产环境部署

本示例旨在作为您自己的生产应用程序的起点，但在部署到生产环境之前，您应全面审查安全性和性能。以下是一些需要考虑的事项：

• OpenAI 容量：默认的 TPM（每分钟令牌数）设置为 3 万。这相当于大约每分钟 30 次对话（假设每位用户的消息/回复约为 1 千个令牌）。您可以根据自己的账户最大容量，通过更改 infra/main.bicep 中的 chatGptDeploymentCapacity 和 embeddingDeploymentCapacity 参数来提高容量。您也可以在 Azure OpenAI Studio 的“配额”选项卡中查看自己拥有的容量。

• Azure 存储：默认存储帐户使用的是 Standard_LRS SKU。为了提高系统的容错能力，我们建议在生产部署中使用 Standard_ZRS，您可以在 infra/main.bicep 中的 storage 模块下使用 sku 属性进行指定。

• Azure AI 搜索：如果您遇到有关搜索服务容量超限的错误，可以尝试通过更改 infra/core/search/search-services.bicep 中的 replicaCount 来增加副本数量，或者直接从 Azure 门户手动扩展。

• Azure 容器应用：默认情况下，此应用程序部署的容器具有 0.5 个 CPU 核心和 1GB 内存。最小副本数为 1，最大为 10。对于此应用程序，您可以根据需求在 infra/core/host/container-app.bicep 文件中设置 containerCpuCoreCount、containerMaxReplicas、containerMemory 和 containerMinReplicas 等参数。您还可以使用自动缩放规则或计划性缩放规则，并根据负载情况调整 最大/最小 副本数。

• 身份验证：默认情况下，部署的应用程序是公开可访问的。我们建议将访问权限限制为经过身份验证的用户。有关如何启用身份验证，请参阅上方的 启用身份验证 部分。

• 网络：我们建议在虚拟网络内部署应用程序。如果应用程序仅供企业内部使用，则应使用专用 DNS 区域。此外，还可以考虑使用 Azure API 管理 (APIM) 来实现防火墙和其他形式的保护措施。有关更多信息，请参阅 Azure OpenAI 登陆区参考架构。

• 负载测试：我们建议针对预期的用户数量运行负载测试。

• 向 Web 客户端流式传输令牌：可以考虑使用 SignalR 库，它允许客户端与服务器之间的双向通信。您可以轻松地复用单个持久连接来向客户端流式传输令牌，并接收来自客户端的信号。SignalR 简化了在 AI 聊天机器人中实现常见功能的过程，例如取消令牌发送。当使用 Azure SignalR 服务 时，它可以轻松扩展到 100 万个连接。此外，Azure SignalR 非常适合无服务器部署，提供了一种经济高效的解决方案，无需担心服务器管理问题。有关代码示例，请参阅 signalr 分支。

资源

• 利用 ChatGPT 彻底革新您的企业数据：基于 Azure OpenAI 和 Azure AI 搜索的新一代应用程序
• Azure AI 搜索
• Azure OpenAI 服务
• Azure.AI.OpenAI NuGet 包
• 原始 Blazor 应用程序

!注意
本演示中使用的 PDF 文档包含使用语言模型（Azure OpenAI 服务）生成的信息。这些文档中的信息仅用于演示目的，并不反映 Microsoft 的观点或信念。Microsoft 对本文档中所含信息的完整性、准确性、可靠性、适用性或可用性不作任何明示或暗示的陈述或保证。所有权利归 Microsoft 所有。

常见问题解答

问题: 为什么在 Azure AI 搜索支持搜索大型文档的情况下，我们还需要将 PDF 文件拆分成块？

回答: 拆分文本块是为了应对 OpenAI 的令牌限制，从而控制每次发送给 OpenAI 的信息量。通过将内容拆分成块，我们可以更方便地找到适合注入 OpenAI 的文本片段。我们采用的拆分方法使用滑动窗口技术：前一个块末尾的句子会成为下一个块的开头。这样可以有效降低丢失文本上下文的风险。

azure-search-openai-demo-csharp 快速上手指南

本指南帮助中国开发者快速部署基于 .NET 的"ChatGPT + 企业数据”示例应用。该应用利用 Azure OpenAI Service 和 Azure AI Search，实现基于私有数据的检索增强生成（RAG）对话体验。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

系统要求

• 操作系统：Windows 10/11, macOS, 或 Linux
• Azure 账号：需拥有有效的 Azure 订阅，且账号具备 Microsoft.Authorization/roleAssignments/write 权限（如“用户访问管理员”或“所有者”角色）。

  注意：默认部署会创建产生费用的资源（如 Azure Container Apps, Azure AI Search 等）。若需降低成本，可参考官方文档修改配置以使用免费层级（有限额）。

前置依赖

请安装以下工具：

1. .NET 8 SDK

   • 下载地址：https://dotnet.microsoft.com/download/dotnet/8.0
   • 国内加速镜像：清华大学 .NET 镜像

2. Azure Developer CLI (azd)

   • 安装命令 (Windows PowerShell): powershell -ex AllSigned -c "Invoke-RestMethod 'https://aka.ms/install-azd.ps1' | Invoke-Expression"
   • 安装命令 (Linux/Mac): curl -fsSL https://aka.ms/install-azd.sh | bash
   • 国内用户若下载缓慢，可尝试手动下载二进制文件并配置环境变量。

3. Git

   • 下载地址：https://git-scm.com/downloads
   • 国内加速镜像：清华大学 Git 镜像

4. Docker Desktop

   • 下载地址：https://www.docker.com/products/docker-desktop/
   • 重要：在执行任何部署命令前，必须确保 Docker 引擎正在运行。

5. PowerShell 7+ (仅限 Windows 用户)

   • 确保可以在终端中运行 pwsh.exe。如果失败，请升级 PowerShell。

安装步骤

您可以选择使用 GitHub Codespaces 在线开发，或在本地环境部署。以下介绍本地环境的部署流程。

1. 认证与初始化

打开终端（Windows 推荐使用 PowerShell），执行以下命令登录 Azure 并初始化项目：

# 登录 Azure 开发者 CLI
azd auth login

# 克隆仓库并初始化环境 (或者直接 git clone 后运行下一步)
azd init -t azure-search-openai-demo-csharp

# 创建新的环境配置
azd env new azure-search-openai-demo-csharp

2. 部署资源

执行以下命令将应用部署到 Azure。此过程会自动创建所需的 Azure 资源（包括 AI 搜索索引、OpenAI 实例、容器应用等），并将 ./data 文件夹中的示例数据（Contoso Electronics 虚构公司数据）上传并建立索引。

#  provision 资源并部署应用
azd up

部署注意事项：

• 区域选择：当提示选择区域时，请选择支持 gpt-4o-mini 模型的区域，例如 East US。其他区域可能因模型不可用而导致部署失败。
• 订阅选择：如果您有多个订阅，系统将提示您选择；若只有一个，将自动选中。
• 耗时：首次部署可能需要几分钟时间，具体取决于网络状况和资源创建速度。

基本使用

部署成功后，终端会输出应用的访问地址。

1. 访问应用

在浏览器中打开 azd up 命令输出中显示的 URL（通常是以 .azurecontainerapps.io 结尾的地址）。

2. 体验功能

应用加载后，您将看到类似 ChatGPT 的界面，但背后连接的是示例企业数据：

• 提问测试：在对话框中输入关于"Contoso Electronics"公司员工福利、内部政策或职位描述的问题。
  • 示例问题：What are the health benefits for employees? (员工有哪些健康福利？)
  • 示例问题：What is the policy on remote work? (远程办公的政策是什么？)
• 查看引用：点击回答下方的引用来源，可以追踪回答依据的具体文档片段，验证回答的可信度。
• 调整设置：利用界面上的设置选项，微调行为参数或实验不同的提示词策略。

3. 本地运行（可选）

如果您希望在本地调试后端或前端，而非使用已部署的云端服务，请确保已获取相关服务的连接字符串，然后运行：

# 启动本地后端和前端
dotnet run

(注：本地运行通常需要手动配置 appsettings.json 或通过 azd env get-values 获取环境变量)

4. 清理资源

为避免产生不必要的费用，测试完成后请及时删除资源：

azd down

确认删除操作后，所有由 azd up 创建的资源组将被移除。