Content Understanding API を使用する

Content Understanding API には、アナライザーの作成、管理、使用に使用できるプログラムインターフェイスが用意されています。

API を使用するために、クライアント アプリケーションは Microsoft Foundry リソースの Content Understanding エンドポイントに HTTP 呼び出しを送信し、ヘッダーに承認キーの 1 つを渡します。 エンドポイントとキーは、Azure portal または Microsoft Foundry ポータルで取得できます。 Microsoft Foundry API を使用して、Entra ID を使用してプログラムでプロジェクトに接続することもできます。

API を使用してコンテンツを分析する

API の最も一般的な用途の 1 つは、以前に作成した既存のアナライザーにコンテンツを送信し、分析の結果を取得することです。 分析要求は、非同期タスクを表す操作 ID 値を返します。 その後、クライアント アプリケーションは、別の要求を使用して操作 ID をエンドポイントに渡し、操作の状態を取得する必要があります。操作が完了し、結果が JSON 形式で返されるまで複数回ポーリングする可能性があります。

たとえば、ドキュメントを分析するために、クライアント アプリケーションは、次の JSON 本文を含む analyze 関数に POST 要求を送信する場合があります。

POST {endpoint}/contentunderstanding/analyzers/{analyzer}:analyze?api-version=2025-11-01
{
  "inputs": [
    {
      "url": "https://host.com/doc.pdf"
    }
  ]
}

この要求が認証されて正常に開始されると、応答は次の例のようになります。

Operation-Id: 1234abcd-1234-abcd-1234-abcd1234abcd
Operation-Location: {endpoint}/contentunderstanding/analyzerResults/1234abcd-1234-abcd-1234-abcd1234abcd?api-version=2025-11-01
{
  "id": "1234abcd-1234-abcd-1234-abcd1234abcd",
  "status": "NotStarted"
}

その後、クライアント アプリケーションは、返された操作 ID を使用して、 analyzerResults エンドポイントに GET 要求を送信して成功 (または失敗) するまで、操作の状態を確認する必要があります。

GET {endpoint}/contentunderstanding/analyzerResults/1234abcd-1234-abcd-1234-abcd1234abcd?api-version=2025-11-01

操作が正常に完了すると、応答には分析の結果を表す JSON ペイロードが含まれます。 具体的な結果は、コンテンツとスキーマによって異なります。