使用 AI Center API 节省基础架构成本

通过 API 请求，您可以以编程方式更改 ML 技能的状态。 这些 API 甚至可以在自动化工作流中用于部署和取消部署 ML 技能，从而优化基础架构的正常运行时间并节省成本。 请参阅Swagger中记录的完整 AI Center API 集。

请注意， accountname和tenantname特定于您的帐户。 有关详细信息，请参阅API列表。

您可以使用 AI Center API 执行以下操作：

1. 查找sampleClassifierSkill的 ML 技能 ID
2. 停止 (取消部署) ML 技能
3. 启动（重新部署）并验证状态更新。

2022 年 11 月，我们宣布推出 API，以便以编程方式与 AI Center 中的每个组件进行交互。 您现在可以使用 API 管理数据集、训练 ML 模型和部署 ML 技能，而无需使用用户界面。

利用 API 的一个关键用例是管理 ML 技能的部署状态。 根据自动化的不同，您可能不需要 ML 技能始终处于活动状态。 在不使用 ML 技能时取消部署可以帮助您节省硬件成本 (AI Unit)。

访问 AI Center API 的步骤如下：

1. 注册外部应用程序（一次性安装）
2. 生成身份验证令牌（过期时续订）
3. 调用 AI Center API

注意：前两个步骤通过确保应用程序已注册并通过身份验证来强制执行访问控制

注册外部应用程序

要使用 API，您的应用程序需要注册为具有 AI Center 作用域的外部应用程序。

1. 从左侧导航面板转到Admin页面，然后选择External Applications 。
2. 要添加新的外部应用程序，请选择+ Add Application

   并为其命名。

   注意：只有confidential application类型可以访问 AI Center API。
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 请求访问令牌。 生成的身份验证令牌将在一小时后过期，届时您需要重新生成新的身份验证令牌。

如果要使用 Postman，可以免费注册，并选择使用 Postman 基于网页的界面或可下载的应用程序。 请参阅Postman官方网站。

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. 授权。 授权字段应填充上一步中生成的身份验证令牌。
   重要提示：使用身份验证令牌时，请为其添加不记名前缀，如下面的屏幕截图所示。

现在，您可以访问特定的 API。 此示例中使用sampleClassifierSkill 。 在“ML 技能” 列表中，您可以看到存在此技能，并且该技能当前处于“可用” 状态。

查找 ML 技能详细信息

使用GET ML Skills调用，您可以获取帐户和租户中所有 ML 技能的列表。 您还可以将 ML 技能名称添加为查询的一部分，以搜索特定 ML 技能并检索其详细信息。 在本例中，您将找到 的 ML 技能idsampleClassifierSkill

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

在下面的响应中，关键字段以黄色突出显示。 仔细检查sampleClassifierSkill 是否处于“可用”状态。 ML 技能id 将在后续 API 中用于更新状态。

停用 ML 技能

要停止 ML 技能，请执行以下操作：

• 请求查询应包含stop更新操作和 ML 技能id
• 标头应包含帐户、租户和身份验证信息

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

响应显示 ML 技能状态更改成功：

检查用户界面，您可以验证是否已取消部署sampleClassifierSkill 。

恢复 ML 技能

要重新启动（部署）ML 技能，请在updateType 设置为“继续”的情况下进行 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 
}

从响应中，您可以看到请求已成功完成，并且技能状态已更新为“正在部署”。

等待技能变为可用，然后使用GET ML Skill详细信息 API 检查 ML 技能状态。

从响应中可以看到，ML 技能现在已部署并且可用。 在用户界面中验证技能的可用性。 现在，您的自动化可以利用工作流中已部署的 ML 技能sampleClassifierSkill 来进行预测。