モデルをデプロイし、ランタイム API を使ってテキストからエンティティを抽出する

Foundry でカスタム モデルをデプロイする方法については、「微調整されたモデルをデプロイする」を参照してください。

デプロイ ジョブを送信する

デプロイ ジョブを送信するには、次の URL、ヘッダー、JSON 本文を使って PUT 要求を送信します。 プレースホルダーの値をあなた自身の値に置き換えてください。

{Endpoint}/language/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}?api-version={API-VERSION}

ヘッダー

要求を認証するには、次のヘッダーを使います。

要求本文

要求の本文で次の JSON を使います。 デプロイに割り当てるモデルの名前を使います。

{
  "trainedModelLabel": "{MODEL-NAME}"
}

API 要求を送信すると、ジョブが正しく送信されたことを示す 202 応答を受け取ります。 応答ヘッダーで、次のように書式設定された operation-location 値を抽出します。

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}?api-version={API-VERSION}

この操作は非同期であるため、{JOB-ID} を使って要求が識別されます。 この URL を使用してデプロイの状態を取得できます。

デプロイ ジョブの状態を取得する

次の GET 要求を使って、デプロイ ジョブの状態に関するクエリを実行します。 前のステップで取得した URL を使うことも、プレースホルダーの値を実際の値に置き換えることもできます。

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}?api-version={API-VERSION}

ヘッダー

要求を認証するには、次のヘッダーを使います。

応答本文

要求を送信すると、次の応答が返されます。 status パラメーターが "succeeded" に変化するまで、このエンドポイントのポーリングを続けます。 要求の成功を示す 200 コードを取得します。

{
    "jobId":"{JOB-ID}",
    "createdDateTime":"{CREATED-TIME}",
    "lastUpdatedDateTime":"{UPDATED-TIME}",
    "expirationDateTime":"{EXPIRATION-TIME}",
    "status":"running"
}

デプロイされたモデルを置き換えるには、デプロイされたモデルを同じリージョン内の別のモデルと交換します。

1. [ 名前 ] でモデル名を選択し、[ モデルのデプロイ] を選択します。

2. [ スワップ モデル] を選択します。

   再デプロイが完了するまでに数分かかります。 それまでの間、デプロイされたモデルは、このプロセスが完了するまで、Translator API で引き続き使用できます。

デプロイ スワップ ジョブを始めるには、次の URL、ヘッダー、JSON 本文を使って POST 要求を作ります。

要求 URL

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/deployments/:swap?api-version={API-VERSION}

ヘッダー

要求を認証するには、次のヘッダーを使います。

要求本文

{
  "firstDeploymentName": "{FIRST-DEPLOYMENT-NAME}",
  "secondDeploymentName": "{SECOND-DEPLOYMENT-NAME}"
}

API 要求を送信すると、成功を示す 202 応答を受け取ります。

プロジェクトが不要になった場合は、Foundry から削除できます。

1. Foundry ホーム ページに移動します。 この手順を既に完了していてセッションがアクティブでない限り、サインインして認証プロセスを開始します。
2. 削除したいプロジェクトを選択します Foundry での構築を続行
3. [管理センター] を選択します。
4. [ プロジェクトの削除] を選択します。

ハブとそのすべてのプロジェクトを削除するには:

1. [概要] タブの [ハブ] セクションに移動します。

2. 右側の [ハブの 削除] を選択します。

3. リンクをクリックすると、ハブを削除するための Azure portal が開きます。

デプロイを削除するには、次の URL、ヘッダー、JSON 本文を使って DELETE 要求を作成します。

要求 URL

{Endpoint}/language/authoring/analyze-text/projects/{PROJECT-NAME}/deployments/{deploymentName}?api-version={API-VERSION}

ヘッダー

要求を認証するには、次のヘッダーを使います。

API 要求を送信すると、成功を示す 202 応答が返されます。これは、デプロイが削除されていることを意味します。 呼び出しが成功すると、ジョブの状態を確認するために使用する Operation-Location ヘッダーが返されます。

カスタム モデルをデプロイする方法の詳細については、「微調整されたモデルをデプロイする」を参照してください。

デプロイ リソースをプログラムで割り当てるには、Microsoft Entra 認証が必要です。 Microsoft Entra ID は、複数リージョンのデプロイのためにプロジェクトに割り当てる際に関心のあるリソースへのアクセス権があることを確認するために使用されます。 REST API 呼び出しを行うときに Microsoft Entra 認証をプログラムで使用する方法については、 Foundry Tools のドキュメントを参照してください。

リソースを割り当てる

以下の URL、ヘッダー、JSON 本文を使って POST 要求を送信し、デプロイ リソースを割り当てます。

要求 URL

API 要求を作るときは、次の URL を使います。 プレースホルダーの値をあなた自身の値に置き換えてください。

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/resources/:assign?api-version={API-VERSION}

ヘッダー

Microsoft Entra 認証を使用して、この API を認証します。

Body

次のサンプル JSON を本文として使います。

{
  "resourcesMetadata": [
    {
      "azureResourceId": "{AZURE-RESOURCE-ID}",
      "customDomain": "{CUSTOM-DOMAIN}",
      "region": "{REGION-CODE}"
    }
  ]
}

リソースの割り当て状態を取得する

デプロイ リソース割り当てジョブの状態を取得するには、次の GET 要求を使います。 プレースホルダーの値をあなた自身の値に置き換えてください。

要求 URL

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/resources/assign/jobs/{JOB-ID}?api-version={API-VERSION}

ヘッダー

要求を認証するには、次のヘッダーを使います。

応答本文

要求を送信すると、次の応答が返されます。 status パラメーターが succeeded に変わるまで、このエンドポイントのポーリングを続けます。

{
    "jobId":"{JOB-ID}",
    "createdDateTime":"{CREATED-TIME}",
    "lastUpdatedDateTime":"{UPDATED-TIME}",
    "expirationDateTime":"{EXPIRATION-TIME}",
    "status":"running"
}

プロジェクトが不要になった場合は、Foundry から削除できます。

1. Foundry ホーム ページに移動します。 この手順を既に完了していてセッションがアクティブでない限り、サインインして認証プロセスを開始します。
2. 削除したいプロジェクトを選択します Foundry での構築を続行
3. [管理センター] を選択します。
4. [ プロジェクトの削除] を選択します。

ハブとそのすべてのプロジェクトを削除するには:

1. [概要] タブの [ハブ] セクションに移動します。

2. 右側の [ハブの 削除] を選択します。

3. リンクをクリックすると、ハブを削除するための Azure portal が開きます。

リソースの割り当てを解除する

プロジェクトからデプロイ リソースの割り当てを解除または削除するには、以下の URL、ヘッダー、JSON 本文を使って POST 要求を送信します。

要求 URL

API 要求を作るときは、次の URL を使います。 プレースホルダーの値をあなた自身の値に置き換えてください。

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/resources/:unassign?api-version={API-VERSION}

ヘッダー

要求を認証するには、次のヘッダーを使います。

本文

次のサンプル JSON を本文として使います。

{
  "assignedResourceIds": [
    "{AZURE-RESOURCE-ID}"
  ]
}

リソースの割り当て解除状態を取得する

デプロイ リソースの割り当て解除ジョブの状態を取得するには、次の GET 要求を使います。 プレースホルダーの値をあなた自身の値に置き換えてください。

要求 URL

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/resources/unassign/jobs/{JOB-ID}?api-version={API-VERSION}

ヘッダー

要求を認証するには、次のヘッダーを使います。

応答本文

要求を送信すると、次の応答が返されます。 status パラメーターが "succeeded" に変化するまで、このエンドポイントのポーリングを続けます。

{
    "jobId":"{JOB-ID}",
    "createdDateTime":"{CREATED-TIME}",
    "lastUpdatedDateTime":"{UPDATED-TIME}",
    "expirationDateTime":"{EXPIRATION-TIME}",
    "status":"running"
}