😺

REST Clientを使ってAOAIサービスにデプロイしたEmbedding APIを動作確認する方法

2024/12/20に公開

やること

Pythonを用いずにAOAIサービスにデプロイしたモデルを動作確認する

REST Clientとは?

RESTfulなAPI(REST API)と通信するためのツールやライブラリを指します。REST APIを利用する際に、HTTPリクエスト(GET、POST、PUT、DELETEなど)を送信し、その応答(レスポンス)を受け取ることができます。
普段は何気なくPythonのrequestsライブラリでAPI通信を実装していますが、コードを書かずにAPIリクエストを送信できるというメリットがあります。

事前準備

REST Clientの追加

VSCodeで拡張機能を追加します。

ファイルの準備

①.env
AOAIのAPIキーとEmbeddingモデルの情報を.envに入力しておきます。

.env
AZURE_OPENAI_API_KEY = '<YOUR_OPENAI_API_KEY>'
AZURE_OPENAI_API_INSTANCE_NAME = '<YOUR_OPENAI_RESOURCE_NAME>'
AZURE_OPENAI_EMBED_DEPLOYMENT_NAME = '<YOUR_EMBEDED_DEPLOYMENT_NAME>'
AZURE_OPENAI_EMBED_API_VERSION = '<YOUR_EMBEDED_API_VERSION>'

②.http
.envから環境変数を持ってきて、試しに"Embedding API connection"と入力しておきます。

.http
POST https://{{$dotenv AZURE_OPENAI_API_INSTANCE_NAME}}.openai.azure.com/openai/deployments/{{$dotenv AZURE_OPENAI_EMBED_DEPLOYMENT_NAME}}/embeddings?api-version={{$dotenv AZURE_OPENAI_EMBED_API_VERSION}}
Content-Type: application/json
api-key: {{$dotenv AZURE_OPENAI_API_KEY}}

{ "input": "Embedding API connection test" }

実行してみる

.httpスクリプト上に表示されている`Send Request'をクリックします。

以下のようにレスポンスが返ってきたので無事接続を確認できました。

コメントなど

実際の開発業務ではPythonで実装すれば済む話なんですが、API自体のテスト・デバッグや細かいリクエストを手動で確認したいときに知っておくと便利だと思いました。

ヘッドウォータース

Discussion