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

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

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

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

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

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

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

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

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

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

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

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

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

   アプリケーションに名前を付けます。

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

   

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

   

   
   

認証トークンを生成する

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

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

1. 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”

2. 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 では以下の情報が必要です。

1. アカウント ID とテナント ID。アカウントとテナントの情報は、テナント内のプロファイル情報セクションで確認できます。「プロファイル情報」をご覧ください。
2. 認可。認可フィールドには、前の手順で生成された認証トークンを設定する必要があります。
   重要: 認証トークンを使用する場合は、以下のスクリーンショットのように、先頭に 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 
}

応答から、要求が成功し、スキルのステートが Deploying に更新されたことを確認できます。

スキルが利用可能になるまで待ち、GET ML Skill details API を使用して ML スキルのステータスを確認します。

応答から、ML スキルがデプロイされて利用可能になったことを確認できます。スキルが利用可能であることを UI で確認します。これで、デプロイした ML スキル sampleClassifierSkill をオートメーションのワークフロー内で利用して、予測を実行できるようになります。