Copy Files From Source Repo (2024-12-20 20:17)

MicrosoftLearning · Dec 21, 2024 · 44fecf8 · 44fecf8
1 parent 44d19ba
commit 44fecf8
Show file tree

Hide file tree

Showing 6 changed files with 681 additions and 6 deletions.
diff --git a/Instructions/Exercises/01-app-develop.md b/Instructions/Exercises/01-app-develop.md
@@ -0,0 +1,295 @@
+---
+lab:
+  title: Azure OpenAI Service を使用したアプリケーションの開発
+---
+
+# Azure OpenAI Service を使用したアプリケーションの開発
+
+Azure OpenAI Service を使用すると、開発者はチャットボットや REST API または 言語固有の SDK を使用して、人間の自然な言語を理解することに優れたその他のアプリケーションを作成できます。 これらの言語モデルを使用する場合、開発者がプロンプトをどのように形成するかは、生成 AI モデルの応答方法に大きく影響します。 明瞭かつ簡潔に要求すれば、Azure OpenAI はコンテンツを調整し、書式設定を行うことができます。 この演習では、アプリケーションを Azure OpenAI に接続する方法と、類似するコンテンツのさまざまなプロンプトが、要件をより十分に満たす AI モデルの応答を形成するためにどのように役立つかを学習します。
+
+この演習のシナリオで、あなたは野生動物のマーケティング キャンペーンに取り組むソフトウェア開発者の役割を演じます。 あなたは、生成 AI を使って広告メールを改善し、チームに適用される可能性のある記事を分類する方法を検討しています。 この演習で使われるプロンプト エンジニアリング手法は、さまざまなユース ケースにも同様に適用できます。
+
+この演習には約 **30** 分かかります。
+
+## Azure OpenAI リソースをプロビジョニングする
+
+まだ持っていない場合は、Azure サブスクリプションで Azure OpenAI リソースをプロビジョニングします。
+
+1. **Azure portal** (`https://portal.azure.com`) にサインインします。
+
+1. 次の設定で **Azure OpenAI** リソースを作成します。
+    - **[サブスクリプション]**: "Azure OpenAI Service へのアクセスが承認されている Azure サブスクリプションを選びます"**
+    - **[リソース グループ]**: *リソース グループを作成または選択します*
+    - **[リージョン]**: *以下のいずれかのリージョンから**ランダム**に選択する*\*
+        - カナダ東部
+        - 米国東部
+        - 米国東部 2
+        - フランス中部
+        - 東日本
+        - 米国中北部
+        - スウェーデン中部
+        - スイス北部
+        - 英国南部
+    - **[名前]**: "*希望する一意の名前*"
+    - **価格レベル**: Standard S0
+
+    > \* Azure OpenAI リソースは、リージョンのクォータによって制限されます。 一覧表示されているリージョンには、この演習で使用されるモデル タイプの既定のクォータが含まれています。 リージョンをランダムに選択することで、サブスクリプションを他のユーザーと共有しているシナリオで、1 つのリージョンがクォータ制限に達するリスクが軽減されます。 演習の後半でクォータ制限に達した場合は、別のリージョンに別のリソースを作成する必要が生じる可能性があります。
+
+3. デプロイが完了するまで待ちます。 次に、Azure portal でデプロイされた Azure OpenAI リソースに移動します。
+
+## モデルをデプロイする
+
+次に、CLI から Azure OpenAI モデル リソースをデプロイします。 この例を使い、次の変数を上記から独自のリソースの値に置き換えます。
+
+```dotnetcli
+az cognitiveservices account deployment create \
+   -g *Your resource group* \
+   -n *Name of your OpenAI service* \
+   --deployment-name gpt-35-turbo \
+   --model-name gpt-35-turbo \
+   --model-version 0125  \
+   --model-format OpenAI \
+   --sku-name "Standard" \
+   --sku-capacity 5
+```
+
+    > \* Sku-capacity is measured in thousands of tokens per minute. A rate limit of 5,000 tokens per minute is more than adequate to complete this exercise while leaving capacity for other people using the same subscription.
+
+> [!NOTE]
+> net7.0 フレームワークがサポート対象外であるという警告が表示された場合、この演習では無視できます。
+
+## アプリケーションを構成する
+
+C# と Python の両方のアプリケーションが用意されており、どちらのアプリも同じ機能を備えています。 まず、非同期 API 呼び出しで Azure OpenAI リソースを使用できるように、アプリケーションの主要な部分をいくつか完成させます。
+
+1. Visual Studio Code の **[エクスプローラー]** ペインで、**Labfiles/01-code-generation** フォルダーを参照し、言語の優先順位に応じて、**CSharp** または **Python** フォルダーを展開します。 各フォルダーには、Azure OpenAI 機能を統合するアプリの言語固有のファイルが含まれています。
+2. コード ファイルが含まれている **CSharp** または **Python** フォルダーを右クリックし、統合ターミナルを開きます。 次に、言語設定に応じて適切なコマンドを実行して、Azure OpenAI SDK パッケージをインストールします。
+
+    **C#:**
+
+    ```
+    dotnet add package Azure.AI.OpenAI --version 2.0.0
+    ```
+
+    **Python**:
+
+    ```
+    pip install openai==1.54.3
+    ```
+
+3. **[エクスプローラー]** ペインの **CSharp** または **Python** フォルダーで、使用する言語の構成ファイルを開きます
+
+    - **C#**: appsettings.json
+    - **Python**: .env
+    
+4. 次を含めて構成値を更新します。
+    - 作成した Azure OpenAI リソースの**エンドポイント**と**キー** (Azure Portal の Azure OpenAI リソースの [**キーとエンドポイント**] ページで使用できます)
+    - モデル デプロイに指定した**デプロイ名**。
+5. 構成ファイルを保存します。
+
+## Azure OpenAI サービスを使うコードを追加する
+
+これで、Azure OpenAI SDK を使って、デプロイされたモデルを使う準備が整いました。
+
+1. **[エクスプローラー]** ペインの **CSharp** または **Python** フォルダーで、希望の言語のコード ファイルを開き、コメント "***Add Azure OpenAI package***" を、Azure OpenAI SDK ライブラリを追加するコードに置き換えます。
+
+    **C#** : Program.cs
+
+    ```csharp
+    // Add Azure OpenAI packages
+    using Azure.AI.OpenAI;
+    using OpenAI.Chat;
+    ```
+
+    **Python**: application.py
+
+    ```python
+    # Add Azure OpenAI package
+    from openai import AsyncAzureOpenAI
+    ```
+
+2. コード ファイルでコメント "***Configure the Azure OpenAI client***" を見つけて、Azure OpenAI クライアントを構成するコードを追加します。
+
+    **C#** : Program.cs
+
+    ```csharp
+    // Configure the Azure OpenAI client
+       AzureOpenAIClient azureClient = new (new Uri(oaiEndpoint), new ApiKeyCredential(oaiKey));
+        ChatClient chatClient = azureClient.GetChatClient(oaiDeploymentName);
+        ChatCompletion completion = chatClient.CompleteChat(
+        [
+        new SystemChatMessage(systemMessage),
+        new UserChatMessage(userMessage),
+        ]);
+    ```
+
+    **Python**: application.py
+
+    ```python
+    # 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
+
+    ```csharp
+    // Get response from Azure OpenAI
+    Console.WriteLine($"{completion.Role}: {completion.Content[0].Text}");
+
+    ```
+
+    **Python**: application.py
+
+    ```python
+    # 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` を開きます。 インタラクションごとに、このファイルに**システム メッセージ**を入力して保存します。 各イテレーションは、システム メッセージを変更できるように、最初に一時停止します。
+1. 対話型ターミナル ペインで、フォルダー コンテキストが優先言語のフォルダーであることを確認します。 その後、次のコマンドを入力してアプリケーションを作成します。
+
+    - **C#** : `dotnet run`
+    - **Python**: `python application.py`
+
+    > **ヒント**: ターミナル ツールバーの **最大化パネル サイズ** (**^**) アイコンを使用すると、コンソール テキストをさらに表示できます。
+
+1. 最初のイテレーションでは、次のプロンプトを入力します。
+
+    **システム メッセージ**
+
+    ```prompt
+    You are an AI assistant
+    ```
+
+    **ユーザー メッセージ:**
+
+    ```prompt
+    Write an intro for a new wildlife Rescue
+    ```
+
+1. 出力を確認します。 AI モデルは、野生動物の救護に関する適切で一般的な概要を生成します。
+1. 次に、応答の形式を指定する以下のプロンプトを入力します。
+
+    **システム メッセージ**
+
+    ```prompt
+    You are an AI assistant helping to write emails
+    ```
+
+    **ユーザー メッセージ:**
+
+    ```prompt
+    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 に貼り付けます。
+
+1. 出力を確認します。 今度は、特定の動物と寄付の呼びかけを含む応答がメール形式で表示されます。
+1. 次に、コンテンツを追加で指定する以下のプロンプトを入力します。
+
+    **システム メッセージ**
+
+    ```prompt
+    You are an AI assistant helping to write emails
+    ```
+
+    **ユーザー メッセージ:**
+
+    ```prompt
+    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 
+    \n 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.
+    ```
+
+1. 出力を確認します。また、明確な指示に基づいてメールがどのように変わったかを確認します。
+1. 次に、以下のプロンプトを入力して、トーンに関する詳細をシステム メッセージに追加します。
+
+    **システム メッセージ**
+
+    ```prompt
+    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.
+    ```
+
+    **ユーザー メッセージ:**
+
+    ```prompt
+    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 
+    \n 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.
+    ```
+
+1. 出力を確認します。 メールは同様の形式で表示されますが、今度は、よりくだけたトーンになります。 ジョークが含まれている可能性もあります。
+1. 最後のイテレーションでは、メールの生成から離れて、"グラウンディング コンテキスト" を検討します。** ここでは、単純なシステム メッセージを指定し、ユーザー プロンプトの始まりとしてグラウンディング コンテキストを提供するようにアプリを変更します。 その後、アプリはユーザー入力を追加し、グラウンディング コンテキストから情報を抽出してユーザー プロンプトに回答するようになります。
+1. ファイル `grounding.txt` を開き、挿入するグラウンディング コンテキストをざっと読みます。
+1. アプリのコメント "***Format and send the request to the model***" の直後、既存のコードの前に、`grounding.txt` からテキストを読み取る次のコード スニペットを追加して、ユーザー プロンプトにグラウンディング コンテキストを追加します。
+
+    **C#** : Program.cs
+
+    ```csharp
+    // Format and send the request to the model
+    Console.WriteLine("\nAdding grounding context from grounding.txt");
+    string groundingText = System.IO.File.ReadAllText("grounding.txt");
+    userMessage = groundingText + userMessage;
+    ```
+
+    **Python**: application.py
+
+    ```python
+    # Format and send the request to the model
+    print("\nAdding grounding context from grounding.txt")
+    grounding_text = open(file="grounding.txt", encoding="utf8").read().strip()
+    user_message = grounding_text + user_message
+    ```
+
+1. ファイルを保存し、アプリを再実行します。
+1. 次のプロンプトを入力します (**システム メッセージ**は入力されたままで、`system.txt` に保存されています)。
+
+    **システム メッセージ**
+
+    ```prompt
+    You're an AI assistant who helps people find information. You'll provide answers from the text provided in the prompt, and respond concisely.
+    ```
+
+    **ユーザー メッセージ:**
+
+    ```prompt
+    What animal is the favorite of children at Contoso?
+    ```
+
+> **ヒント**: Azure OpenAI からの完全な応答を確認したい場合は、**printFullResponse** 変数を `True` に設定し、アプリを再実行します。
+
+## クリーンアップ
+
+Azure OpenAI リソースでの作業が完了したら、**Azure portal** (`https://portal.azure.com`) でデプロイまたはリソース全体を忘れずに削除します。
diff --git a/Instructions/Exercises/02-natural-language-azure-openai.md b/Instructions/Exercises/02-natural-language-azure-openai.md
@@ -39,12 +39,12 @@ Azure OpenAI Service を使用すると、開発者はチャットボットや
 
 ## モデルをデプロイする
 
-Azure には、モデルのデプロイ、管理、調査に使用できる **Azure AI Studio** という名前の Web ベース ポータルが用意されています。 Azure AI Studio を使用してモデルをデプロイすることで、Azure OpenAI の調査を開始します。
+Azure には、モデルのデプロイ、管理、調査に使用できる **Azure AI Foundry portal** という名前の Web ベース ポータルが用意されています。 Azure AI Foundry ポータルを使用してモデルをデプロイすることで、Azure OpenAI の調査を開始します。
 
-> **注**: Azure AI Studio を使用すると、実行するタスクを提案するメッセージ ボックスが表示される場合があります。 これらを閉じて、この演習の手順に従うことができます。
+> **注**: Azure AI Foundry ポータルを使用すると、実行するタスクを提案するメッセージ ボックスが表示される場合があります。 これらを閉じて、この演習の手順に従うことができます。
 
-1. Azure portal にある Azure OpenAI リソースの **[概要]** ページで、**[開始する]** セクションまで下にスクロールし、ボタンを選択して **AI Studio** に移動します。
-1. Azure AI Studio の左ペインで、**[デプロイ]** ページを選び、既存のモデル デプロイを表示します。 まだデプロイがない場合は、次の設定で **gpt-35-turbo-16k** モデルの新しいデプロイを作成します。
+1. Azure portal にある Azure OpenAI リソースの **[概要]** ページで、**[開始する]** セクションまで下にスクロールし、ボタンを選択して **AI Foundry portal** (以前は AI Studio) に移動します。
+1. Azure AI Foundry の左ペインで、**[デプロイ]** ページを選び、既存のモデル デプロイを表示します。 まだデプロイがない場合は、次の設定で **gpt-35-turbo-16k** モデルの新しいデプロイを作成します。
     - **デプロイの名前**: *任意の一意の名前*
     - **モデル**: gpt-35-turbo-16k "(16k モデルが使用できない場合は、gpt-35-turbo を選びます)"**
     - **モデル バージョン**: *既定のバージョンを使用する*
@@ -87,7 +87,7 @@ C# と Python の両方のアプリケーションが提供されています。
     **Python**:
 
     ```
-    pip install openai==1.13.3
+    pip install openai==1.55.3
     ```
 
 3. **[エクスプローラー]** ペインの **CSharp** または **Python** フォルダーで、使用する言語の構成ファイルを開きます
@@ -97,7 +97,7 @@ C# と Python の両方のアプリケーションが提供されています。
     
 4. 次を含めて構成値を更新します。
     - 作成した Azure OpenAI リソースの**エンドポイント**と**キー** (Azure Portal の Azure OpenAI リソースの [**キーとエンドポイント**] ページで使用できます)
-    - モデル デプロイに指定した**デプロイ名** (Azure AI Studio の **[デプロイ]** ページでアクセスできます)。
+    - モデル デプロイに指定した**デプロイ名** (Azure AI Foundry ポータルの **[デプロイ]** ページで使用できます)。
 5. 構成ファイルを保存します。
 
 ## Azure OpenAI サービスを使うコードを追加する