[Q]
事前申請が承認され、Azure OpenAI サービスが利用できるようになりました。Azure OpenAI Studio で使えていますが、API を使った質問もしてみたいのですが、どうすれば良いでしょうか?
[A]
Azure OpenAI Studio のサンプルコードを表示させる機能を使うと、API を呼び出す JSON テンプレートや Python スクリプト、C#、curl コマンドのサンプルを生成することができます。
以下は、curl コマンドを使って gpt-35-turbo
を チャット で利用する場合の大まかな手順ですが、手順5以降を変更すれば、JSON テンプレート、Pytyon スクリプト、C# のサンプルを生成できます。
また、プレイグラウンドで利用できる他のモデルのデプロイやチャット以外でも、同様の手順が使用できる場合があります。(プレイグラウンドの「入力候補」には 20 種類以上の例が用意されており使用すべきモデルも表示されます。)
<手順>
1.Azure ポータルで Azure OpenAI のリソースから Azure OpenAI Studio に移動します
2.Azure OpenAI Studio のデプロイで、使用するデプロイから「プレイグラウンドで開く」でチャットに移動します
3.必要に応じてチャットの「アシスタントのセットアップ」や「Configuration」で設定します
4.質問文を入力して送信せずに「コードの表示」をクリックします
5.サンプル コード の表示で「curl」を選んでコピーします
6.キー (api-key) をコピーします
7.Azure ポータルで Azure OpenAI リソースを確認します
8.curl コマンドを完成させて Cloud Shell などで実行します
手順の詳細については以下をご参照ください。
1.Azure ポータルで Azure OpenAI のリソースから Azure OpenAI Studio に移動します
Azure ポータル ( https://portal.azure.com ) を開いて、Azure OpenAI サービスのリソースを表示させます。(ホーム のすべてのサービスCognitive Services )
リソースが無い場合は「+作成」で作成してください。(ご参考: Azure OpenAI リソースの作成方法を教えてください。)
Azure OpenAI リソースの「Azure OpenAI Studio に移動する」をクリックします。
2.Azure OpenAI Studio のデプロイで、使用するデプロイから「プレイグラウンドで開く」でチャットに移動します
まだデプロイしていない場合は「+新しいデプロイの作成」でモデル gpt-35-turbo
をデプロイしてください。バージョンは最新を推奨します。
デプロイ名(上図の例では gpt35-001)をクリックすると下図の様にデプロイの情報が表示されますが、その上部にある「プレイグラウンドで開く」でもチャットに移動できます。
3.必要に応じてチャットの「アシスタントのセットアップ」や「Configuration」で設定します
下図の例はデフォルトのままです。
4.質問文を入力して、送信はせずに、「コードの表示」をクリックします
User message 欄に質問文(ユーザークエリ)を入力します。Enter キーを押さず、⩥ (送信) もクリックしないで上部の「コードの表示」をクリックします。
※ 最初は、質問文を送信して結果を確認し、質問文を改良するのも良いでしょう。「コードの表示」の左側にある「チャットをクリアする」をクリックすればリセットできます。
注意: 上図の例では質問文で「一緒にウェブページのアドレスもお願いします。」としていますが、AI に URL を生成させるとアドレスが実在しない場合も多いようです。
5.サンプル コード の表示で「curl」を選んでコピーします
コードの種類は、json、Python、C#、curl がありますので「curl」を選択して下部の「コピー」をクリックします。
メモ帳などにペーストしておきます。
※ URI で api-version を指定していますがバージョンが合っていないことがあります。その場合はお手数ですが、参考情報の「チャット入力候補」を参照して修正をお願いいたします。
6.キー (api-key) をコピーします
キー欄のコピーアイコンをクリックしてコピーします(キーの値を表示させなくてもコピーできます)。
※ 不正利用を防ぐため、このキーの管理には十分にご注意ください。
7.Azure ポータルで Azure OpenAI リソースを確認します
Azure OpenAI Studio プレイグラウンドから、Azure ポータル ( https://portal.azure.com ) に戻って、Azure OpenAI リソースを確認しましょう。
手順6のキーは、Azure OpenAI リソースのメニューの「キーとエンドポイント」でも確認でき、また再生成することもできます。
8.curl コマンドを完成させて Cloud Shell などで実行します
手順5のコードの -H "api-key: YOUR_API_KEY" \
の行の YOUR_API_KEY
の部分に、手順6でコピーしたキーをペーストします。
コード全体を選択してコピーします。
Azure ポータルの Cloud Shell の Bash などでも良いですが、セキュアなシェルの環境で実行します。
下図では、ポータル上部の Cloud Shell のアイコンをクリック後、Power Shell から Bash に切り替えて、ペーストしようとしています。
ペーストした後に、Enter キーを押して、しばらく待つと結果が表示されます。
以上です。
[参考情報]
ChatGPT および GPT-4 モデルの操作方法の説明
https://learn.microsoft.com/ja-jp/azure/cognitive-services/openai/how-to/chatgpt?pivots=programming-language-chat-completions
Azure OpenAI Service の REST API リファレンス
チャット入力候補
https://learn.microsoft.com/ja-jp/azure/cognitive-services/openai/reference#chat-completions
Best practices for prompt engineering with OpenAI API
https://help.openai.com/en/articles/6654000-best-practices-for-prompt-engineering-with-openai-api
ハンズオン手順:ロジックアプリを使って、Teams から Azure OpenAI に質問を投げられるようにしてみよう
[更新日]
Update:202306