通过

使用 .NET 构建 AI 聊天应用

  • 项目

本快速入门介绍如何使用 OpenAI 或 Azure OpenAI 模型创建聊天 .NET 控制台聊天应用。 应用使用 Microsoft.Extensions.AI 库，因此可以使用 AI 抽象而不是特定的 SDK 编写代码。 借助 AI 抽象，你可以通过最少的代码更改来更改基础 AI 模型。

注意

该 Microsoft.Extensions.AI 库目前以预览版提供。

先决条件

  • .NET 8.0 SDK - 安装 .NET 8.0 SDK。
  • OpenAI 的 API 密钥，可以用于运行此示例。
  • 在 Windows 上，必须安装 PowerShell v7+。 若要验证版本，请在终端中运行 pwsh。 它应返回当前版本。 如果返回错误，请执行以下命令 dotnet tool update --global PowerShell。

先决条件

注意

还可以使用 语义内核 完成本文中的任务。 语义内核是一种轻型开源 SDK，可用于生成 AI 代理并将最新的 AI 模型集成到 .NET 应用中。

克隆示例存储库

可以使用前面的部分中的步骤创建自己的应用，也可以克隆包含所有快速入门的完整示例应用的 GitHub 存储库。 如果计划使用 Azure OpenAI，示例存储库也构建为 Azure 开发人员 CLI 模板，可以预配 Azure OpenAI 资源。

git clone https://github.com/dotnet/ai-samples.git

创建应用

完成以下步骤以创建 .NET 控制台应用以连接到 AI 模型。

  1. 在计算机上的空目录中，使用 dotnet new 命令创建新的控制台应用：

    dotnet new console -o ChatAppAI

  2. 将目录更改为应用文件夹：

    cd ChatAppAI

  3. 安装所需的包：

    dotnet add package Azure.Identity
dotnet add package Azure.AI.OpenAI
dotnet add package Microsoft.Extensions.AI.OpenAI
dotnet add package Microsoft.Extensions.Configuration
dotnet add package Microsoft.Extensions.Configuration.UserSecrets

    dotnet add package OpenAI
dotnet add package Microsoft.Extensions.AI.OpenAI
dotnet add package Microsoft.Extensions.Configuration
dotnet add package Microsoft.Extensions.Configuration.UserSecrets

  4. 在 Visual Studio Code 中打开应用（或所选编辑器）。

    code .

创建 AI 服务

示例 GitHub 存储库构造为 Azure Developer CLI (azd) 模板，azd 可以使用此模板为你预配 Azure OpenAI 服务和模型。

  1. 在终端或命令提示符下，导航到 src\quickstarts\azure-openai 示例存储库的目录。

  2. 运行 azd up 命令来预配 Azure OpenAI 资源。 创建 Azure OpenAI 服务并部署模型可能需要几分钟。

    azd up

    azd 还会为示例应用（例如 Azure OpenAI 终结点和模型名称）配置所需的用户机密。

配置应用

  1. 从终端或命令提示符导航到 .NET 项目的根目录。

  2. 运行以下命令，将 OpenAI API 密钥配置为示例应用的机密：

    dotnet user-secrets init
dotnet user-secrets set OpenAIKey <your-openai-key>
dotnet user-secrets set ModelName <your-openai-model-name>

添加应用代码

该应用使用该 Microsoft.Extensions.AI 包向 AI 模型发送和接收请求，旨在为用户提供有关徒步旅行小径的信息。

  1. 在 Program.cs 文件中，添加以下代码以连接到 AI 模型并进行身份验证。

    using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.AI;
using Azure.AI.OpenAI;
using Azure.Identity;

var config = new ConfigurationBuilder().AddUserSecrets<Program>().Build();
string endpoint = config["AZURE_OPENAI_ENDPOINT"];
string deployment = config["AZURE_OPENAI_GPT_NAME"];

IChatClient chatClient =
    new AzureOpenAIClient(new Uri(endpoint), new DefaultAzureCredential())
        .AsChatClient(deployment);

    注意

    DefaultAzureCredential 从本地工具搜索身份验证凭据。 如果不使用 azd 模板来预配 Azure OpenAI 资源，则需要将 Azure AI Developer 角色分配给用于登录到 Visual Studio 或 Azure CLI 的帐户。 有关详细信息，请参阅 使用 .NET 向 Azure AI 服务进行身份验证。

    using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.AI;
using OpenAI;

var config = new ConfigurationBuilder().AddUserSecrets<Program>().Build();
string model = config["ModelName"];
string key = config["OpenAIKey"];

// Create the IChatClient
IChatClient chatClient =
    new OpenAIClient(key).AsChatClient(model);

  2. 创建系统提示，为 AI 模型提供初始角色上下文和有关徒步旅行建议的说明：

    // Start the conversation with context for the AI model
List<ChatMessage> chatHistory = new()
    {
        new ChatMessage(ChatRole.System, """
            You are a friendly hiking enthusiast who helps people discover fun hikes in their area.
            You introduce yourself when first saying hello.
            When helping people out, you always ask them for this information
            to inform the hiking recommendation you provide:

            1. The location where they would like to hike
            2. What hiking intensity they are looking for

            You will then provide three suggestions for nearby hikes that vary in length
            after you get that information. You will also share an interesting fact about
            the local nature on the hikes when making a recommendation. At the end of your
            response, ask if there is anything else you can help with.
        """)
    };

  3. 创建一个对话循环，该循环接受来自用户的输入提示，将提示发送到模型，并输出响应完成：

    while (true)
{
    // Get user prompt and add to chat history
    Console.WriteLine("Your prompt:");
    var userPrompt = Console.ReadLine();
    chatHistory.Add(new ChatMessage(ChatRole.User, userPrompt));

    // Stream the AI response and add to chat history
    Console.WriteLine("AI Response:");
    var response = "";
    await foreach (var item in
        chatClient.CompleteStreamingAsync(chatHistory))
    {
        Console.Write(item.Text);
        response += item.Text;
    }
    chatHistory.Add(new ChatMessage(ChatRole.Assistant, response));
    Console.WriteLine();
}

  4. 使用 dotnet run 命令运行应用：

    dotnet run

    应用从 AI 模型输出完成响应。 发送其他后续提示，并询问其他问题以试验 AI 聊天功能。

清理资源

不再需要示例应用程序或资源时，请删除相应的部署和所有资源。

azd down

后续步骤