アプリで Azure OpenAI API を使う

Azure OpenAI Service を使用すると、開発者はチャットボットや言語モデルをはじめとして、人間の自然な言語を理解することに優れたその他のアプリケーションを作成できます。 Azure OpenAI では、事前トレーニング済みの AI モデルにアクセスできるだけでなく、アプリケーションの特定の要件を満たすためにこれらのモデルをカスタマイズおよび微調整するための一連の API やツールが提供されます。この演習では、Azure OpenAI にモデルをデプロイし、それを独自のアプリケーションで使う方法について学習します。

この演習のシナリオでは、生成 AI を使ってハイキングの推奨事項を提供できるアプリの実装を任されたソフトウェア開発者の役割を果たします。この演習で使われる手法は、Azure OpenAI API を使う任意のアプリに適用できます。

この演習には約 30 分かかります。

Azure OpenAI リソースをプロビジョニングする

まだ持っていない場合は、Azure サブスクリプションで Azure OpenAI リソースをプロビジョニングします。

Azure portal (https://portal.azure.com) にサインインします。
次の設定で Azure OpenAI リソースを作成します。
- [サブスクリプション]: “Azure OpenAI Service へのアクセスが承認されている Azure サブスクリプションを選びます”**
- [リソースグループ]: リソースグループを作成または選択します
- [リージョン]: 以下のいずれかのリージョンからランダムに選択する*
  - オーストラリア東部
  - カナダ東部
  - 米国東部
  - 米国東部 2
  - フランス中部
  - 東日本
  - 米国中北部
  - スウェーデン中部
  - スイス北部
  - 英国南部
- [名前]: “希望する一意の名前”
- 価格レベル: Standard S0
* Azure OpenAI リソースは、リージョンのクォータによって制限されます。一覧表示されているリージョンには、この演習で使用されるモデルタイプの既定のクォータが含まれています。リージョンをランダムに選択することで、サブスクリプションを他のユーザーと共有しているシナリオで、1 つのリージョンがクォータ制限に達するリスクが軽減されます。演習の後半でクォータ制限に達した場合は、別のリージョンに別のリソースを作成する必要が生じる可能性があります。
デプロイが完了するまで待ちます。次に、Azure portal でデプロイされた Azure OpenAI リソースに移動します。

モデルをデプロイする

Azure OpenAI には、モデルのデプロイ、管理、探索に使用できる Azure OpenAI Studio という名前の Web ベースのポータルが用意されています。 Azure OpenAI Studio を使用してモデルをデプロイすることで、Azure OpenAI の探索を開始します。

Azure OpenAI リソースの [概要] ページで、 [Azure OpenAI Studio に移動する] ボタンを使用して、新しいブラウザータブで Azure OpenAI Studio を開きます。
Azure OpenAI Studio の [デプロイ] ページで、既存のモデルのデプロイを表示します。まだデプロイがない場合は、次の設定で gpt-35-turbo-16k モデルの新しいデプロイを作成します。
- モデル: gpt-35-turbo-16k “(16k モデルが使用できない場合は、gpt-35-turbo を選びます)”**
- モデルバージョン: 既定値に自動更新
- デプロイ名:”任意の一意の名前。** この名前は、ラボの後半で使います。”
- 詳細オプション
  - コンテンツフィルター: 既定
  - デプロイの種類:Standard
  - 1 分あたりのトークンのレート制限: 5K*
  - 動的クォータを有効にする: 有効
* この演習は、1 分あたり 5,000 トークンのレート制限内で余裕を持って完了できます。またこの制限によって、同じサブスクリプションを使用する他のユーザーのために容量を残すこともできます。

Visual Studio Code でアプリを開発する準備をする

Visual Studio Code を使って Azure OpenAI アプリを開発します。アプリのコードファイルは、GitHub リポジトリで提供されています。

ヒント: 既に mslearn-openai リポジトリをクローンしている場合は、Visual Studio Code で開きます。それ以外の場合は、次の手順に従って開発環境に複製します。

Visual Studio Code を起動します。
パレットを開き (SHIFT+CTRL+P)、Git:Clone コマンドを実行して、https://github.com/MicrosoftLearning/mslearn-openai リポジトリをローカルフォルダーに複製します (どのフォルダーでも問題ありません)。
リポジトリを複製したら、Visual Studio Code でフォルダーを開きます。

注:Visual Studio Code に、開いているコードを信頼するかどうかを求めるポップアップメッセージが表示された場合は、ポップアップの [はい、作成者を信頼します] オプションをクリックします。
リポジトリ内の C# コードプロジェクトをサポートするために追加のファイルがインストールされるまで待ちます。

注: ビルドとデバッグに必要なアセットを追加するように求めるプロンプトが表示された場合は、[今はしない] を選択します。

アプリケーションを構成する

C# と Python の両方のアプリケーションが提供されています。どちらのアプリにも同じ機能があります。まず、Azure OpenAI リソースの使用を有効にするために、アプリケーションの主要な部分をいくつか完成させます。

Visual Studio Code の [エクスプローラー] ペインで、Labfiles/02-azure-openai-api フォルダーを参照し、言語の設定に応じて CSharp または Python フォルダーを展開します。各フォルダーには、Azure OpenAI 機能を統合するアプリの言語固有のファイルが含まれています。
コードファイルが含まれている CSharp または Python フォルダーを右クリックし、統合ターミナルを開きます。次に、言語設定に応じて適切なコマンドを実行して、Azure OpenAI SDK パッケージをインストールします。

C#:
```
 dotnet add package Azure.AI.OpenAI --version 1.0.0-beta.14
```
Python:
```
 pip install openai==1.13.3
```
[エクスプローラー] ペインの CSharp または Python フォルダーで、使用する言語の構成ファイルを開きます
- C#: appsettings.json
- Python: .env
次を含めて構成値を更新します。
- 作成した Azure OpenAI リソースのエンドポイントとキー (Azure Portal の Azure OpenAI リソースの [キーとエンドポイント] ページで使用できます)
- モデルデプロイに指定したデプロイ名 (Azure OpenAI Studio の [デプロイ] ページでアクセスできます)。
構成ファイルを保存します。

Azure OpenAI サービスを使うコードを追加する

これで、Azure OpenAI SDK を使って、デプロイされたモデルを使う準備が整いました。

[エクスプローラー] ペインの CSharp または Python フォルダーで、希望の言語のコードファイルを開き、コメント “Add Azure OpenAI package” を、Azure OpenAI SDK ライブラリを追加するコードに置き換えます。

C# : Program.cs
```
 // Add Azure OpenAI package
 using Azure.AI.OpenAI;
```
Python: test-openai-model.py
```
 # Add Azure OpenAI package
 from openai import AzureOpenAI
```

使用する言語のアプリケーションコードで、コメント “Initialize the Azure OpenAI client…” を次のコードに置き換えて、クライアントを初期化し、システムメッセージを定義します。

C# : Program.cs

 // Initialize the Azure OpenAI client
 OpenAIClient client = new OpenAIClient(new Uri(oaiEndpoint), new AzureKeyCredential(oaiKey));
    
 // System message to provide context to the model
 string systemMessage = "I am a hiking enthusiast named Forest who helps people discover hikes in their area. If no area is specified, I will default to near Rainier National Park. I will then provide three suggestions for nearby hikes that vary in length. I will also share an interesting fact about the local nature on the hikes when making a recommendation.";

Python: test-openai-model.py

 # Initialize the Azure OpenAI client
 client = AzureOpenAI(
         azure_endpoint = azure_oai_endpoint, 
         api_key=azure_oai_key,  
         api_version="2024-02-15-preview"
         )
    
 # Create a system message
 system_message = """I am a hiking enthusiast named Forest who helps people discover hikes in their area. 
     If no area is specified, I will default to near Rainier National Park. 
     I will then provide three suggestions for nearby hikes that vary in length. 
     I will also share an interesting fact about the local nature on the hikes when making a recommendation.
     """

コメント “Add code to send request…” を要求の構築に必要なコードに置き換え、messages や temperature など、モデルのさまざまなパラメーターを指定します。

C# : Program.cs

 // Add code to send request...
 // Build completion options object
 ChatCompletionsOptions chatCompletionsOptions = new ChatCompletionsOptions()
 {
     Messages =
     {
         new ChatRequestSystemMessage(systemMessage),
         new ChatRequestUserMessage(inputText),
     },
     MaxTokens = 400,
     Temperature = 0.7f,
     DeploymentName = oaiDeploymentName
 };

 // Send request to Azure OpenAI model
 ChatCompletions response = client.GetChatCompletions(chatCompletionsOptions);

 // Print the response
 string completion = response.Choices[0].Message.Content;
 Console.WriteLine("Response: " + completion + "\n");

Python: test-openai-model.py

 # Add code to send request...
 # Send request to Azure OpenAI model
 response = client.chat.completions.create(
     model=azure_oai_deployment,
     temperature=0.7,
     max_tokens=400,
     messages=[
         {"role": "system", "content": system_message},
         {"role": "user", "content": input_text}
     ]
 )
 generated_text = response.choices[0].message.content

 # Print the response
 print("Response: " + generated_text + "\n")

変更内容をコードファイルに保存します。

アプリケーションのテスト

アプリが構成されたので、それを実行してモデルに要求を送信し、応答を確認します。

対話型ターミナルペインで、フォルダーコンテキストが優先言語のフォルダーであることを確認します。その後、次のコマンドを入力してアプリケーションを作成します。
- C# : dotnet run
- Python: python test-openai-model.py
ヒント: ターミナルツールバーの 最大化パネルサイズ (^) アイコンを使用すると、コンソールテキストをさらに表示できます。
プロンプトが表示されたら、テキスト What hike should I do near Rainier? を入力します。
応答が、messages 配列に追加したシステムメッセージに示されているガイドラインに従ってしていることに注意して、出力を確認します。
プロンプト Where should I hike near Boise? I'm looking for something of easy difficulty, between 2 to 3 miles, with moderate elevation gain. を入力し、出力を確認します。
使用する言語のコードファイルで、要求の temperature パラメーター値を 1.0 に変更し、ファイルを保存します。
上記のプロンプトを使ってアプリケーションを再度実行し、出力を確認します。

温度を上げると、ランダム性が高くなるため、同じテキストが指定された場合でも、多くの場合、応答が変化します。これを数回実行して、出力がどのように変化するかを確認できます。同じ入力で温度に異なる値を使用してみてください。

会話履歴を維持する

ほとんどの実際のアプリケーションでは、会話の前の部分を参照できることにより、AI エージェントとのより現実的な対話が可能になります。 Azure OpenAI API は設計上ステートレスですが、プロンプトに会話の履歴を提供することで、AI モデルが過去のメッセージを参照できるようになります。

アプリを再度実行し、プロンプト Where is a good hike near Boise? を指定します。
出力を確認し、それからプロンプト How difficult is the second hike you suggested? を指定します。
モデルからの応答は、言及しているハイキングを理解できないことを示している可能性があります。これを修正するには、モデルが参照用に過去の会話メッセージを保持できるようにします。
アプリケーションでは、以前のプロンプトと応答を、今後送信するプロンプトに追加する必要があります。 システムメッセージの定義の下に、次のコードを追加します。

C# : Program.cs
```
 // Initialize messages list
 var messagesList = new List<ChatRequestMessage>()
 {
     new ChatRequestSystemMessage(systemMessage),
 };
```
Python: test-openai-model.py
```
 # Initialize messages array
 messages_array = [{"role": "system", "content": system_message}]
```

コメント “Add code to send request…“の下で、コメントから while ループの最後までのすべてのコードを次のコードに置き換えて、ファイルを保存します。コードはほとんど同じですが、メッセージ配列を使って会話履歴を格納するようになりました。

C# : Program.cs

 // Add code to send request...
 // Build completion options object
 messagesList.Add(new ChatRequestUserMessage(inputText));

 ChatCompletionsOptions chatCompletionsOptions = new ChatCompletionsOptions()
 {
     MaxTokens = 1200,
     Temperature = 0.7f,
     DeploymentName = oaiDeploymentName
 };

 // Add messages to the completion options
 foreach (ChatRequestMessage chatMessage in messagesList)
 {
     chatCompletionsOptions.Messages.Add(chatMessage);
 }

 // Send request to Azure OpenAI model
 ChatCompletions response = client.GetChatCompletions(chatCompletionsOptions);

 // Return the response
 string completion = response.Choices[0].Message.Content;

 // Add generated text to messages list
 messagesList.Add(new ChatRequestAssistantMessage(completion));

 Console.WriteLine("Response: " + completion + "\n");

Python: test-openai-model.py

 # Add code to send request...
 # Send request to Azure OpenAI model
 messages_array.append({"role": "user", "content": input_text})

 response = client.chat.completions.create(
     model=azure_oai_deployment,
     temperature=0.7,
     max_tokens=1200,
     messages=messages_array
 )
 generated_text = response.choices[0].message.content
 # Add generated text to messages array
 messages_array.append({"role": "assistant", "content": generated_text})

 # Print generated text
 print("Summary: " + generated_text + "\n")

ファイルを保存します。追加したコードでは、以前の入力と応答がプロンプト配列に追加され、モデルが会話の履歴を理解できるようになっていることに注目してください。
ターミナルペインで次のコマンドを入力してアプリケーションを実行します。
- C# : dotnet run
- Python: python test-openai-model.py
アプリを再度実行し、プロンプト Where is a good hike near Boise? を指定します。
出力を確認し、それからプロンプト How difficult is the second hike you suggested? を指定します。
モデルが提案した 2 番目のハイキングについての応答が得られる可能性が高く、より現実的な会話が得られます。以前の回答を参照して追加のフォローアップの質問をすることができ、そのたびに履歴によってモデルが回答するためのコンテキストが提供されます。

ヒント: トークン数は 1200 のみに設定されているため、会話が長くなりすぎると、アプリケーションで使用できるトークンがなくなり、プロンプトが不完全になります。運用環境での使用では、履歴の長さを最新の入力と応答に制限すると、必要なトークンの数を制御するのに役立ちます。

クリーンアップ

Azure OpenAI リソースでの作業が完了したら、Azure portal (https://portal.azure.com) でデプロイまたはリソース全体を忘れずに削除します。