使用 API 工作流

从 Orchestrator 使用 API 工作流

要从 Orchestrator 运行已发布的 API 工作流，请执行以下操作：

1. 在 Automation Cloud Orchestrator 中，转到 API 工作流流程所在的文件夹。
2. 导航至“自动化”>“流程”。
3. 对于所需的 API 工作流流程，选择相应行末尾的“开始作业” 。
4. 在打开的页面中，提供：
   • 执行目标选项
   • “runtime 参数”选项。“输入”部分表示您的 API 请求输入架构，并可用于指定用作执行输入的属性。
5. 要运行流程，请选择“开始” 。

成功运行工作流后，您可以在工作流执行详细信息中查看生成的响应： “自动化” > “作业” 。

在智能体中调用 API 工作流

通过将 API 工作流集成为工具来扩展 UiPath 智能体的功能。智能体会自动查询这些工作流以收集相关上下文，从而精确控制智能体和 AI 模型可用的数据。

以下场景演示了 API 工作流如何转换从 Workday 检索的数据，从而将向智能体公开的信息仅限于姓名和电子邮件地址。在 Workday 沙盒中，我们将 Bety Liu 配置为经理，并为其分配了直接下属和同事。智能体的查询示例包括：

• “谁向 BellyLiu 报告？”
• “为 Betxt 提供所有对等点。”
• “BellyLiu 的同事中有没有下属？”

重要提示：该智能体不存储您的 Workday 凭据，无法直接查询 Workday，且仅依赖于 API 工作流返回的响应。

开始之前，请确保满足以下先决条件：

• 您已将Workday API 工作流发布到 Orchestrator。确认从 Orchestrator 执行工作流是否成功。
• Platform Units 已分配给您的租户。
• 要遵循提供的 Workday 集成示例，请确保您的工作流包括：
  • 包含名字和姓氏字段的输入架构。
  • 一个输出架构，包含同级和直接下属 的数组 。

1. 手动创建智能体。或者，也可以通过以下提示词使用 Autopilot 生成器：

   “查询 Workday 以获取经理、报告和同级详细信息。”

   您的智能体已使用 Autopilot 创建，Autopilot 会提供智能体提示和配置。在此示例中，最初接受了建议的提示词，但后来对“用户提示词”进行了简化，以仅包含{{query }}变量。

2. 在智能体的数据管理器面板中，定义一个名为query的输入属性，类型为字符串。这可确保“用户提示”包含有效的引用。
   
3. 选择在云端调试。系统将提示您提供“用户提示”的查询。但是，执行追踪面板显示智能体当前无权访问 Workday，因此尚无法提供响应。
4. 在智能体的“工具”部分中，选择“添加工具” > “API 工作流” 。
5. 选择现有 API 工作流（查询 Workday 的工作流），并为其提供说明。最佳做法是为智能体提供足够的详细信息，以便智能体根据您的提示自动配置工作流。清晰的说明通常会包含有关输入参数的详细信息。例如：
   “接受员工的名字和姓氏作为输入，并在响应中提供其直接下属和同事。输入的名称是我们将在 Workday 中查找的经理的名称。”
6. 选择“在云端调试” ，再次运行代理。提供以下查询：“谁向 Belly 报告？”。执行追踪面板现在可以识别出智能体调用 API 工作流的情况，包括：
   • 发送到 API 工作流的请求
   • 从 API 工作流收到的响应
   • 智能体如何使用响应来完成您的查询

恭喜!

现在，您可以创建智能体用户提示词的变体。根据查询的不同，智能体可能会触发对 API 工作流的多次调用，然后才能提供完整的响应。

在 Maestro 中将 API 工作流用作任务

Maestro 中封装了详细的 API 链和数据转换的 API 工作流。这可以使 Maestro 的主要流程清晰、简洁且易于遵循。通过隔离 API 工作流中的特定 API 交互，您可以保持可读性并提升跨多个流程的可重用性。

以下场景演示了 Maestro 如何在与员工解约时调用 Workday API，然后向 Slack 团队发送通知。

开始之前，请确保满足以下先决条件：

• 您已将Workday API 工作流发布到 Orchestrator。确认从 Orchestrator 执行工作流是否成功。

  确保您的 API 工作流包括：

  • 包含“名字”和“姓氏”字段的输入架构。
  • 一个输出架构，包含同级和直接下属 的数组 。

步骤 1：创建智能体流程

1. 创建智能体流程。
2. 添加“开始事件”元素。将其命名为“聘用员工”。
   1. 对于“开始”事件 的 操作 属性，选择“等待连接器事件” 。
   2. 对于“连接器”属性，请选择“Workday REST - 工作器已创建” 。这是触发流程的事件。
3. 添加“任务”元素并将“开始”事件连接到该元素。将其命名为“查找员工关系”。
4. 添加另一个“任务”元素，将其命名为“发送通知”，然后将“查找员工关系”元素与其连接。
5. 添加结束事件。将其命名为“已发送通知”。

这是流程设置。每当聘用新员工时，流程都会触发 API 工作流，该工作流会检索员工信息，例如报告结构和关联关系。

步骤 2：配置“查找员工关系”任务

智能体流程所需的 API 工作流位于“查找员工关系”任务中。以下是配置方法：

1. 选择“查找员工关系”任务。
2. 对于“操作”属性，选择“启动并等待 API 工作流” 。
3. 对于“API 工作流”属性，选择已发布的 Workday API 工作流。属性面板显示所选工作流的输入和输出。对于此示例：
   • 输入包括姓氏和名字。
   • 输出包括管理器、同级和报告的详细信息。
4. 按如下方式配置输入：
   • “开始”事件 响应对象中的变量形式的 名字 。打开“表达式编辑器”，选择“插入变量”，然后导航至“聘用员工” >“响应” >“工作器” >“工作器 全名” 。然后将Split(' ')[0]添加到表达式中。内容应如下所示：

     vars.response_1.worker.descriptor.Split(' ')[0]

     其中worker是开始事件响应中的响应对象， .Split(' ')[0]使用空格字符拆分全名，并获取全名的第一部分。
   • “开始”事件 响应对象中的变量形式的 姓氏 。打开“表达式编辑器”，选择“插入变量”，然后导航至“聘用员工” >“响应” >“工作器” >“工作器 全名” 。然后将Split(' ')[1]添加到表达式中。内容应如下所示：

     vars.response_1.worker.descriptor.Split(' ')[1]

     其中worker是来自开始事件响应的响应对象， .Split(' ')[1]用空格字符拆分全名，并获取全名的第二部分。

步骤 3：自定义发送通知任务

在此步骤中，您将配置“发送通知”任务，以使用从在步骤 2 中执行的 API 工作流返回的数据。

1. 选择“发送通知”任务。
2. 对于“操作”属性，选择“执行连接器事件” 。
3. 对于“连接器”属性，选择Slack ，并将其配置为使用您的连接。
4. 对于“活动”属性，选择“向频道发送消息” 。
5. 对于频道名称/ID ，请写入应发送通知的 Slack 频道的 ID。
6. 对于“消息”属性，请从步骤 2 中选择：经理、对等和报告 中的输出变量。
7. 对于“以其他方式发送” 属性，选择机器人。

步骤 4：测试您的智能体流程

要成功测试此智能体流程，请确保您有权访问 Workday 沙盒环境。

选择“测试”以验证您的工作流。Maestro 会提示您提供两个基本连接：

• Slack 连接 —由“发送通知”任务必需。
• Workday 连接 —由“启动”事件需求。

重要提示： Maestro 不会请求连接 API 工作流，因为这些连接在 API 工作流本身中单独管理。