Hci

更新时间:
复制 MD 格式

msg

msg(instructions, todo_detail, timeout_min)

方法描述

重要

此功能对客户端和服务端的版本要求:

  • 编辑器和本地型机器人客户端的版本:大于等于4.13.0.1171

  • Express机器人的版本:大于等于4.13.0.1173

  • 如线下输出版本的RPA服务端使用此功能,服务端版本:大于等于4.16.0

自动化流程运行到此方法时,引擎向服务端发送HCI通知

  • 发送后,阻塞当前任务、并等待人工处理完成后再继续执行,同时任务状态仍然为运行中

  • 服务型机器人的任务查询

  • 本地型机器人的任务

  • 自动化流程中,支持多次调用本方法。但使用如上OpenAPI等方式获取任务状态时,只会返回最后一条未关闭的HCI通知内容

客户端侧交互效果及操作

  • 客户端侧交互效果

    image

  • 如果用户在弹出框中确认继续,则机器人继续运行此自动化流程

  • 如果用户在弹出框中确认停止运行,则机器人立刻停止运行此自动化流程,任务状态变为异常结束

  • 默认超时时间为120分钟,如果弹出框出现后的持续时间超过此阈值,则任务自动结束,任务状态为异常结束

参数说明

  • instructions<str>最大2000字符。此内容会出现在弹出框中,如上图所示,用于引导用户进入到系统后的操作

  • todo_detail<str>最大1000字符

    • 用于提供给您的上层系统,获得当前人工介入需要做哪些工作

    • 此内容会出现在使用OpenAPI查询任务、系统内置MCP Tool workersys_get_task_status或推送任务状态中

    • Agent集成使用的场景中,该内容会被大模型读取和使用

      说明

      如果Agent集成使用场景中使用服务型机器人,建议此内容中增加“使用 workersys_get_robot_runtime_url获得登录链接...”的相关文字,引导用户在Agent侧直接通过免登方式登录,提高用户体验

  • timeout_min<int>弹出框的最大等待时间,单位分钟

调用样例- rpa.console.hci.msg-

human_todo_msg="需要您先完成日报系统的登陆"
agent_todo_msg='''自动化操作等待用户按照引导完成操作后才能继续。
Agent可通过mcp调用get_remote_robot_connectlink获得登陆链接,用户通过浏览器访问此链接可完成所需操作。'''

rpa.console.hci.msg(human_todo_msg,agent_todo_msg)

说明

编辑器中调试运行自动化流程时,此方法只出现弹出框,不向服务端上报HCI通知