使用 Azure OpenAI 服务开发应用程序

借助 Azure OpenAI 服务，开发人员可以通过使用 REST API 或特定语言 SDK 创建擅长理解人类自然语言的聊天机器人和其他应用程序。 使用这些语言模型时，开发人员如何塑造其提示会极大地影响生成式 AI 模型的响应方式。 Azure OpenAI 模型能够以清晰简洁的方式定制内容并设置内容格式。 在本练习中，你将学习如何将应用程序连接到 Azure OpenAI，并了解类似内容的不同提示如何帮助 AI 模型做出响应，以更好地满足你的要求。

在本练习的应用场景中，你将担任野生动物市场营销活动的软件开发人员角色。 你正在探索如何使用生成式 AI 来改进广告电子邮件和对可能适用于团队的文章进行分类。 练习中使用的提示工程技术同样适用于各种用例。

该练习大约需要 30 分钟。

克隆本课程的存储库

如果尚未克隆用于本课程的存储库，请克隆它：

1. 启动 Visual Studio Code。
2. 打开命令面板（SHIFT+CTRL+P 或视图 > 命令面板…）并运行 Git: Clone 命令将https://github.com/MicrosoftLearning/mslearn-openai存储库克隆到本地文件夹（任意文件夹均可）。
3. 克隆存储库后，在 Visual Studio Code 中打开文件夹。

4. 等待其他文件安装完毕，以支持存储库中的 C# 代码项目。

   注意：如果系统提示你添加生成和调试所需的资产，请选择以后再说。

预配 Azure OpenAI 资源

如果还没有 Azure OpenAI 资源，请在 Azure 订阅中预配 Azure OpenAI 资源。

1. 登录到 Azure 门户，地址为 **。

2. 请使用以下设置创建 Azure OpenAI 资源：
   • 订阅**：选择已被批准访问 Azure OpenAI 服务的 Azure 订阅
   • 资源组：创建或选择资源组
   • 区域**：从以下任何区域中进行随机选择***
     • 美国东部
     • 美国东部 2
     • 美国中北部
     • 美国中南部
     • 瑞典中部
     • 美国西部
     • 美国西部 3
   • 名称：所选项的唯一名称**
   • 定价层：标准版 S0

   * Azure OpenAI 资源受区域配额约束。 列出的区域包括本练习中使用的模型类型的默认配额。 在与其他用户共享订阅的情况下，随机选择一个区域可以降低单个区域达到配额限制的风险。 如果稍后在练习中达到配额限制，你可能需要在不同的区域中创建另一个资源。

3. 等待部署完成。 然后在 Azure 门户中转至部署的 Azure OpenAI 资源。

部署模型

接下来，你将从 Cloud Shell 部署 Azure OpenAI 模型资源。

1. 使用页面顶部搜索栏右侧的 [>_] 按钮在 Azure 门户中创建新的 Cloud Shell，选择 Bash 环境。 Cloud Shell 在 Azure 门户底部的窗格中提供命令行接口。

   备注：如果以前创建了使用 PowerShell 环境的 Cloud Shell，请将其切换到 Bash。

2. 参考此示例，将下列变量替换为上述自己的值：

    az cognitiveservices account deployment create \
       -g <your_resource_group> \
       -n <your_OpenAI_service> \
       --deployment-name gpt-4o \
       --model-name gpt-4o \
       --model-version 2024-05-13 \
       --model-format OpenAI \
       --sku-name "Standard" \
       --sku-capacity 5
   

备注：SKU 容量以每分钟多少千个令牌进行度量。 每分钟 5,000 个令牌的速率限制足以完成此练习，同时也为使用同一订阅的其他用户留出容量。

配置应用程序

C# 和 Python 的应用程序都已提供，并且这两个应用具有相同的功能。 首先，你将通过异步 API 调用使用 Azure OpenAI 资源完成要启用的应用程序的一些关键部件。

1. 在 Visual Studio Code 的“资源管理器”窗格中，浏览到“Labfiles/01-app-develop”文件夹，然后根据语言首选项展开“CSharp”文件夹或“Python”文件夹。 每个文件夹都包含要集成 Azure OpenAI 功能的应用程序的特定语言文件。

2. 右键单击包含代码文件的“CSharp”或“Python”文件夹，并打开集成终端。**** 然后通过运行适用于语言首选项的命令，安装 Azure OpenAI SDK 包：

   C#：

    dotnet add package Azure.AI.OpenAI --version 2.1.0
   

   Python：

    pip install openai==1.65.2
   

3. 在“资源管理器”窗格中**，在“CSharp”或“Python”文件夹中，打开首选语言的配置文件**

   • C# ：appsettings.json
   • Python：.env
4. 更新配置值以包括：
   • 创建的 Azure OpenAI 资源的终结点** 和密钥（位于 Azure 门户中 Azure OpenAI 资源的“密钥和终结点”** 页）
   • 为模型部署指定的部署名称。
5. 保存此配置文件。

添加代码以使用 Azure OpenAI 服务

现在，你已准备好使用 Azure OpenAI SDK 来使用已部署的模型。

1. ****** 在“资源管理器”窗格的“CSharp”和“Python”文件夹中，打开首选语言的代码文件，并将注释“添加 Azure OpenAI 包”替换为代码以添加 Azure OpenAI SDK 库：

   C# ：Program.cs

    // Add Azure OpenAI packages
    using Azure.AI.OpenAI;
    using OpenAI.Chat;
   

   Python：application.py

    # Add Azure OpenAI package
    from openai import AsyncAzureOpenAI
   

2. 在代码文件中，找到注释“配置 Azure OpenAI 客户端”**，并添加代码以配置 Azure OpenAI 客户端：

   C# ：Program.cs

    // Configure the Azure OpenAI client
    AzureOpenAIClient azureClient = new (new Uri(oaiEndpoint), new ApiKeyCredential(oaiKey));
    ChatClient chatClient = azureClient.GetChatClient(oaiDeploymentName);
   

   Python：application.py

    # Configure the Azure OpenAI client
    client = AsyncAzureOpenAI(
        azure_endpoint = azure_oai_endpoint, 
        api_key=azure_oai_key,  
        api_version="2024-02-15-preview"
    )
   

3. 在调用 Azure OpenAI 模型的函数中，位于注释从 Azure OpenAI 获取响应下方，添加代码以格式化并向模型发送请求。

   C# ：Program.cs

    // Get response from Azure OpenAI
    ChatCompletionOptions chatCompletionOptions = new ChatCompletionOptions()
    {
        Temperature = 0.7f,
        MaxOutputTokenCount = 800
    };
   
    ChatCompletion completion = chatClient.CompleteChat(
        [
            new SystemChatMessage(systemMessage),
            new UserChatMessage(userMessage)
        ],
        chatCompletionOptions
    );
   
    Console.WriteLine($"{completion.Role}: {completion.Content[0].Text}");
   

   Python：application.py

    # Get response from Azure OpenAI
    messages =[
        {"role": "system", "content": system_message},
        {"role": "user", "content": user_message},
    ]
       
    print("\nSending request to Azure OpenAI model...\n")
   
    # Call the Azure OpenAI model
    response = await client.chat.completions.create(
        model=model,
        messages=messages,
        temperature=0.7,
        max_tokens=800
    )
   

4. 保存代码文件中的更改。

运行应用程序

配置应用后，请运行应用以将请求发送到模型并观察响应。 你会注意到，不同选项之间的唯一区别是提示的内容，所有其他参数（如标记计数和温度）对于每个请求保持不变。

1. 在首选语言的文件夹中，在 Visual Studio Code 中打开 system.txt。 对于每个交互，你将在此文件中输入“系统消息”并将其保存。 每次迭代都会先暂停，以便更改系统消息。

2. 在交互式终端窗格中，确保文件夹上下文是首选语言的文件夹。 然后，输入以下命令来创建应用程序。

   • C# ：dotnet run
   • Python：python application.py

   提示：可以使用 终端工具栏中的“最大化面板大小 ”图标^ 查看更多控制台文本。

3. 对于第一次迭代，请输入以下提示：

   系统消息

    You are an AI assistant
   

   用户消息：

    Write an intro for a new wildlife Rescue
   

4. 观察输出。 AI 模型可能会对野生动物救援生成良好的通用介绍。

5. 接下来，输入以下提示，以指定响应的格式：

   系统消息

    You are an AI assistant helping to write emails
   

   用户消息：

    Write a promotional email for a new wildlife rescue, including the following: 
    - Rescue name is Contoso 
    - It specializes in elephants 
    - Call for donations to be given at our website
   

   提示：你可能会发现 VM 中的自动键入不能很好地处理多行提示。 如果问题出在这里，请复制整个提示，然后将其粘贴到 Visual Studio Code 中。

6. 观察输出。 这一次，你可能会看到包含特定动物的电子邮件格式，以及捐款呼吁。

7. 接下来，输入以下提示，以额外指定内容：

   系统消息

    You are an AI assistant helping to write emails
   

   用户消息：

    Write a promotional email for a new wildlife rescue, including the following: 
    - Rescue name is Contoso 
    - It specializes in elephants, as well as zebras and giraffes 
    - Call for donations to be given at our website 
    Include a list of the current animals we have at our rescue after the signature, in the form of a table. These animals include elephants, zebras, gorillas, lizards, and jackrabbits.
   

8. 观察输出，并查看电子邮件是如何根据明确的说明更改的。

9. 接下来，输入以下提示，我们会在此处将有关语气的详细信息添加到系统消息：

   系统消息

    You are an AI assistant that helps write promotional emails to generate interest in a new business. Your tone is light, chit-chat oriented and you always include at least two jokes.
   

   用户消息：

    Write a promotional email for a new wildlife rescue, including the following: 
    - Rescue name is Contoso 
    - It specializes in elephants, as well as zebras and giraffes 
    - Call for donations to be given at our website 
    Include a list of the current animals we have at our rescue after the signature, in the form of a table. These animals include elephants, zebras, gorillas, lizards, and jackrabbits.
   

10. 观察输出。 这一次，你可能会看到采用类似格式的电子邮件，但语气要随意得多。 你甚至可能会看到笑话！

使用锚定上下文并维护聊天历史记录

1. 在最后一次迭代中，我们将偏离电子邮件生成，探索锚定上下文并维护聊天记录。 你在此处提供了简单的系统消息并更改应用，以提供锚定上下文作为聊天历史记录的开头。 然后，应用将追加用户输入，并从锚定上下文中提取信息以回答用户提示。
2. 打开文件 grounding.txt 并快速阅读要插入的锚定上下文。

3. 在应用中紧跟注释“初始化消息列表”之后和任何现有代码之前，添加以下从grounding.txt读取文本的代码片段，以使用锚定文本初始化聊天历史记录。

   C# ：Program.cs

    // Initialize messages list
    Console.WriteLine("\nAdding grounding context from grounding.txt");
    string groundingText = System.IO.File.ReadAllText("grounding.txt");
    var messagesList = new List<ChatMessage>()
    {
        new UserChatMessage(groundingText),
    };
   

   Python：application.py

    # Initialize messages array
    print("\nAdding grounding context from grounding.txt")
    grounding_text = open(file="grounding.txt", encoding="utf8").read().strip()
    messages_array = [{"role": "user", "content": grounding_text}]
   

4. 在注释“设置格式并向模型发送请求”下，将 while 循环末尾的注释中的代码替换为以下代码。 代码大致相同，但现在使用消息数组向模型发送请求。

   C# ：Program.cs

    // Format and send the request to the model
    messagesList.Add(new SystemChatMessage(systemMessage));
    messagesList.Add(new UserChatMessage(userMessage));
    GetResponseFromOpenAI(messagesList);
   

   Python：application.py

    # Format and send the request to the model
    messages_array.append({"role": "system", "content": system_text})
    messages_array.append({"role": "user", "content": user_text})
    await call_openai_model(messages=messages_array, 
        model=azure_oai_deployment, 
        client=client
    )
   

5. 在注释“定义将从 Azure OpenAI 终结点获取响应的函数”下，将函数声明替换为以下代码，以便在为 C# 调用函数GetResponseFromOpenAI或为 Python call_openai_model时使用聊天历史记录列表。

   C# ：Program.cs

    // Define the function that gets the response from Azure OpenAI endpoint
    private static void GetResponseFromOpenAI(List<ChatMessage> messagesList)
   

   Python：application.py

    # Define the function that will get the response from Azure OpenAI endpoint
    async def call_openai_model(messages, model, client):
   

6. 最后，替换从 Azure OpenAI 获取响应下的所有代码。 代码大致相同，但现在使用消息数组来存储对话历史记录。

   C# ：Program.cs

    // Get response from Azure OpenAI
    ChatCompletionOptions chatCompletionOptions = new ChatCompletionOptions()
    {
        Temperature = 0.7f,
        MaxOutputTokenCount = 800
    };
   
    ChatCompletion completion = chatClient.CompleteChat(
        messagesList,
        chatCompletionOptions
    );
   
    Console.WriteLine($"{completion.Role}: {completion.Content[0].Text}");
    messagesList.Add(new AssistantChatMessage(completion.Content[0].Text));
   

   Python：application.py

    # Get response from Azure OpenAI
    print("\nSending request to Azure OpenAI model...\n")
   
    # Call the Azure OpenAI model
    response = await client.chat.completions.create(
        model=model,
        messages=messages,
        temperature=0.7,
        max_tokens=800
    )   
   
    print("Response:\n" + response.choices[0].message.content + "\n")
    messages.append({"role": "assistant", "content": response.choices[0].message.content})
   

7. 保存文件并重新运行应用。

8. 输入以下提示（仍然输入 系统消息 并保存在 system.txt 中）。

   系统消息

    You're an AI assistant who helps people find information. You'll provide answers from the text provided in the prompt, and respond concisely.
   

   用户消息：

    What animal is the favorite of children at Contoso?
   

   请注意，模型使用锚定文本信息来回答你的问题。

9. 如果不更改系统消息，请输入以下用户消息提示：

   用户消息：

    How can they interact with it at Contoso?
   

   请注意，模型将“他们”识别为“儿童”，将“它”识别为他们最喜欢的动物，因为现在它有权访问聊天历史记录中上一个问题。

清理

使用完 Azure OpenAI 资源后，请记得在位于 https://portal.azure.com 的 Azure 门户 中删除部署或整个资源。