次の方法で共有


Microsoft Foundry API をインポートする

適用対象: すべての API Management レベル

Microsoft Foundry にデプロイされた AI モデル エンドポイントを API として API Management インスタンスにインポートできます。 API Management で AI ゲートウェイ ポリシーやその他の機能を使用して、統合を簡素化し、監視性を向上させ、モデル エンドポイントの制御を強化します。

API Management での AI API の管理の詳細については、以下を参照してください。

クライアント互換性オプション

API Management では、Microsoft Foundry の AI API に対して次のクライアント互換性オプションがサポートされています。 ウィザードを使用して API をインポートする場合は、モデルのデプロイに適したオプションを選択します。 このオプションは、クライアントが API を呼び出す方法と、API Management インスタンスが Foundry ツールに要求をルーティングする方法を決定します。

  • Azure OpenAI: Microsoft Foundry モデルのデプロイで Azure OpenAI を管理します。

    クライアントは、/openaiなどの/openai/deployments/my-deployment/chat/completions エンドポイントで展開を呼び出します。 要求パスにはデプロイ名が含まれます。 Foundry ツールに Azure OpenAI モデルのデプロイのみが含まれている場合は、このオプションを使用します。

  • Azure AI: Azure AI モデル推論 API を介して公開される Microsoft Foundry のモデル エンドポイントを管理します。

    クライアントは、/modelsなどの/my-model/models/chat/completions エンドポイントで展開を呼び出します。 要求本文にはデプロイメントの名前が含まれます。 このオプションは、Azure AI モデル推論 API を介して公開されるモデルと Foundry Models の Azure OpenAI にデプロイされたモデルを柔軟に切り替える場合に使用します。

  • Azure OpenAI v1 - Azure OpenAIAPI バージョン 1 API を使用して、Microsoft Foundry モデルのデプロイで Azure OpenAI を管理します。

    クライアントは、 openai/v1/my-model/chat/completionsなどの Azure OpenAI v1 モデル エンドポイントでデプロイを呼び出します。 要求本文にはデプロイ名が含まれます。

[前提条件]

  • 既存の API Management インスタンスがある。 まだない場合は、作成してください

  • 1 つ以上のモデルがデプロイされたサブスクリプションの Foundry ツール。 たとえば、Microsoft Foundry または Azure OpenAI にデプロイされたモデルが挙げられます。

ポータルを使用して Microsoft Foundry API をインポートする

次の手順を使用して、AI API を API Management にインポートします。

API をインポートすると、API Management によって自動的に次の構成が行われます。

  • 各 API の REST API エンドポイントの操作。
  • Foundry ツールのデプロイにアクセスするために必要なアクセス許可を持つシステム割り当て ID。
  • backend リソースと、AZURE AI サービス エンドポイントに API 要求を送信する set-backend-service ポリシー。
  • インスタンスのシステム割り当てマネージド ID を使用したバックエンドへの認証。
  • (必要に応じて)API の監視と管理に役立つポリシー。

Microsoft Foundry API を API Management にインポートするには:

  1. Azure ポータルで、API Management インスタンスに移動します。

  2. 左側のメニューの [API] で、[API]>[+ API の追加] を選択します。

  3. [リソースから作成で、Azure Microsoft Foundry を選択します。

    ポータルで OpenAI 互換 API を作成するスクリーンショット。

  4. [AI サービスの選択] タブで、次 の操作を行 います。

    1. Foundry Tools を検索する サブスクリプション を選択します。 サービス内のモデル デプロイに関する情報を取得するには、サービス名の横にある デプロイ リンクを選択します。 ポータルでの AI サービスのデプロイのスクリーンショット。
    2. Foundry ツールを選択します。
    3. 次へを選択します。
  5. [ API の構成 ] タブで、次の手順を実行します。

    1. API の表示名と、必要に応じて説明を入力します。

    2. [基本パス] に、API Management インスタンスがデプロイ エンドポイントへのアクセスに使用するパスを入力します。

    3. 必要に応じて、API に関連付ける 1 つ以上の 製品 を選択します。

    4. [クライアントの互換性] で、サポートするクライアントの種類に基づいて、次のいずれかのオプションを選択します。 詳細については、「 クライアント互換性オプション 」を参照してください。

      • Azure OpenAI - クライアントが Microsoft Foundry モデル デプロイの Azure OpenAI にのみアクセスする必要がある場合は、このオプションを選択します。
      • Azure AI - クライアントが Microsoft Foundry の他のモデルにアクセスする必要がある場合は、このオプションを選択します。
      • Azure OpenAI v1 - Foundry モデルのデプロイで Azure OpenAI API バージョン 1 を使用する場合は、このオプションを選択します。
    5. 次へを選択します。

      ポータルでの Microsoft Foundry API の構成のスクリーンショット。

  6. [ トークン消費の管理 ] タブで、必要に応じて設定を入力するか、API の監視と管理に役立つ次のポリシーを定義する既定値をそのまま使用します。

  7. [ セマンティック キャッシュの適用 ] タブで、必要に応じて設定を入力するか、API のパフォーマンスを最適化して待機時間を短縮するために役立つポリシーを定義する既定値を受け入れます。

  8. [ AI コンテンツ の安全性 ] タブで、必要に応じて設定を入力するか、既定値を受け入れて、安全でないコンテンツを含むプロンプトをブロックするように Azure AI Content Safety サービスを構成します。

  9. レビューを選択します。

  10. ポータルで設定が検証されたら、[ 作成] を選択します。

AI API をテストする

AI API が期待どおりに動作することを確認するには、API Management テスト コンソールでテストします。

  1. 前の手順で作成した API を選びます。

  2. [テスト] タブを選びます。

  3. モデルのデプロイと互換性のある操作を選択します。 ページにパラメーターとヘッダーのフィールドが表示されます。

  4. 必要に応じてパラメーターとヘッダーを入力します。 操作によっては、 要求本文の構成または更新が必要になる場合があります。 チャット完了操作の基本的な要求本文の例を次に示します。

    {
      "model": "any",
      "messages": [
        {
          "role": "user",
          "content": "Help me plan a trip to Paris",
          "max_tokens": 100
        }
      ]
    }
    

    テスト コンソールで、API Management によって Ocp-Apim-Subscription-Key ヘッダーが自動的に追加され、組み込みの オール アクセス サブスクリプションのサブスクリプション キーが設定されます。 このキーを使用すると、API Management インスタンス内のすべての API にアクセスできます。 必要に応じて 、Ocp-Apim-Subscription-Key ヘッダーを表示するには、 HTTP 要求の横にある "目" アイコンを選択します。

  5. 送信を選択します。

    テストが成功すると、バックエンドは成功した HTTP 応答コードといくつかのデータで応答します。 応答には、言語モデルのトークン使用量を監視および管理するのに役立つトークン使用状況データが含まれます。