AI Center ガイド

AI Center API を使用してインフラストラクチャコストを削減する

API 要求を使用して、ML スキルのステートをプログラムによって変更できます。これらの API をオートメーションワークフロー内で使用して ML スキルのデプロイ/デプロイ解除を行い、インフラストラクチャの稼働時間を最適化し、コストを節約することもできます。すべての AI Center API のリストについては、 Swagger をご覧ください。

accountnameとtenantnameはアカウント固有である点に注意してください。詳しくは、 API のリストをご覧ください。

AI Center API を使用して以下の手順を実行します。

sampleClassifierSkill の ML スキル ID を見つけます。
この ML スキルを停止 (デプロイを解除) します。
ML スキルを開始 (再デプロイ) し、ステータスが更新されることを確認します。

UiPath は 2022 年 11 月、AI Center 内のすべてのコンポーネントとプログラムを使用して対話するための API を提供することを発表しました。現在では、ユーザーインターフェイスを使用することなく、API を使用してデータセットの管理、ML モデルのトレーニング、ML スキルのデプロイを行えるようになりました。

API を利用する主なユースケースの 1 つとして、ML スキルのデプロイステータスを管理することがあります。オートメーションによっては、ML スキルを常時アクティブにしておく必要がない場合があります。ML スキルを使用していないときはデプロイを解除することで、ハードウェアコスト (AI ユニット) を節約できます。

AI Center API にアクセスするには、以下の手順を実行します。

外部アプリケーションを登録します (1 回限りの設定)。
認証トークンを生成します (有効期限が切れた場合は更新します)。
AI Center API の呼び出しを実行します。

注:

最初の 2 つの手順で、アプリケーションを確実に登録および認証してアクセス制御を適用します。

外部アプリケーションを登録する

API を使用するには、アプリを AI Center のスコープに外部アプリケーションとして登録する必要があります。

左側のナビゲーションパネルの [Admin] ページに移動し、[External Applications] を選択します。
新しい外部アプリケーションを追加するために、[ + Add Application] を選択して名前を付けます。

注:
AI Center API にアクセスできるのはconfidential application 種類のみです。
外部アプリケーションに対する AI Center の範囲を有効化するために、以下の手順を実行します。
1. Add scope を選択
2. [リソース] ドロップダウンから [AI Center API Access (preview)] を選択します。
3. [Application Scope] タブに移動します。
4. アクセスを有効化する API を選択します。次の例では、分かりやすくするためにすべての API を選択していますが、特定の API に特定の外部アプリケーションに対するアクセスを割り当てることができます。
[Add] を選択します。アプリ ID とアプリシークレットが表示されたポップアップが生成されます。

ヒント:
アプリ ID とアプリシークレットは、[ Edit External application] からいつでも表示できます。これらの資格情報は、次の手順で認証トークンを生成するために使用します。詳しくは、「外部アプリケーションを管理する」をご覧ください。

認証トークンを生成する

認証とセキュリティで保護されたアクセスのために、外部アプリケーションは UiPath® Identity Server にアクセストークンを要求します。生成された認証トークンは 1 時間で有効期限が切れ、この期限を過ぎると、新しい認証トークンを再生成する必要があります。

Postman を使用する場合は、無料で登録して、Postman の Web ベースのインターフェイスまたはダウンロード可能なアプリケーションのいずれかを使用できます。詳しくは、 Postman の公式 Web サイトをご覧ください。

Identity Server のエンドポイント「https://cloud.uipath.com/identity_/connect/token」に対して、要求の本文に以下を含む POST 要求を生成します。
```
client_id: App ID from previous step
client_secret: App Secret from previous step
grant_type: “client_credentials”
client_id: App ID from previous step
client_secret: App Secret from previous step
grant_type: “client_credentials”
```
grant_type を client_credentials に設定します。

Postman にはコンテンツの種類として application/x-www-form-urlencoded を使用します。

この要求により、次のスクリーンショットのような認証トークンが生成され、この外部アプリケーションに対して有効化されている権限のリストが表示されます。この認証トークンを、AI Center API の呼び出しを行う際に使用します。

詳しくは、資格情報と認証トークンに関するこちらのページをご覧ください。

AI Center API の呼び出しを実行します。

API 呼び出しは、 https://cloud.uipath.com/accountname/tenantname/aifabric_/ の構造に従います。 "accountname" と "tenantname" はアカウントに固有です。ほとんどの API には、次の情報が必要です。

アカウント ID と テナント ID。アカウントとテナントの情報は、テナント内のプロファイル情報セクションで確認できます。詳しくは、「プロファイル情報」をご覧ください。
認可。認可フィールドには、前の手順で生成された認証トークンを設定する必要があります。
重要:
認証トークンを使用する場合は、先頭に Bearer を付けます。

これで、特定の API にアクセスできるようになります。この例では、 sampleClassifierSkill を使用します。[ML スキル] リストで、このスキルが存在していて、現在 [利用可能 ] なステートであることを確認できます。

ML スキルの詳細を確認する

GET ML Skills 呼び出しを使用すると、アカウントとテナント内のすべての ML スキルのリストを取得できます。また、ML スキル名をクエリの一部として追加し、特定の ML スキルを検索してその詳細を取得することもできます。次の例では、sampleClassifierSkill の ML スキル id を確認できます。

GET /ai-deployer/v1/mlskills?name=sampleClassifierSkill

次の応答では、重要なフィールドを黄色で強調表示しています。sampleClassifierSkillが Available のステートであることをダブルチェックします。この ML スキル id を後続の API で使用して、ステートを更新します。

ML スキルを停止

ML スキルを停止するには、以下の手順を実行します。

要求クエリに、stop 更新アクションと ML スキル id を含める必要があります。
ヘッダーに、アカウント、テナント、認証の情報を含める必要があります。

PUT /ai-deployer/v2/mlskills/stop/{mlSkillId}

以下の応答は、ML スキルのステータスの変更が成功したことを示しています。

UI をチェックして、sampleClassifierSkill がデプロイ解除されたことを確認できます。

ML スキルを再開

ML スキルを再実行 (デプロイ) するには、updateType を Resume に設定して API 呼び出しを実行します。

POST /ai-deployer/v1/mlskills/{mlSkillId}?updateType=RESUME

{ "deploymentsRequired": 1, 
"gpuRequired": 0, 
"mlPackageVersionId": <package-version-id>, 
"processor": "CPU", 
"publicSkill": false, 
"autoUpdate": false, 
"inactivityPeriodInDays": 7, 
"replicas": 1, 
"requestMemory": 2, 
"requestCPU": 0.5, 
"limitMemory": 9, 
"limitCPU": 2 
}
{ "deploymentsRequired": 1, 
"gpuRequired": 0, 
"mlPackageVersionId": <package-version-id>, 
"processor": "CPU", 
"publicSkill": false, 
"autoUpdate": false, 
"inactivityPeriodInDays": 7, 
"replicas": 1, 
"requestMemory": 2, 
"requestCPU": 0.5, 
"limitMemory": 9, 
"limitCPU": 2 
}