调用插件节点

本文档介绍流程管理中调用插件节点的配置方法和应用实例。

节点介绍

机器人进入调用插件节点时,会执行 API 插件调用,主要的执行步骤分为下面两个:

  • 阶段 1:API 需要必要输入参数未获取到时,机器人将主动与用户对话完成参数收集。对话效果与参数收集一致。

  • 阶段 2:当必要的输入参数完整后,机器人自动调用 API 插件,并解析插件返回结果,根据后续分支配置继续进行对话。

image.png

操作说明

  • 节点名称:按照业务需求可以修改节点名称,系统展示默认值;

  • 选择API插件:按照流程需求选择对应API;

API插件的配置方法请参考《API插件》;
  • API插件参数收集:有两种模式,分别是Prompt模式和自定义模式:

    说明

    当随路参数与要收集的参数同名时,会直接赋值,不再进行收集。

    • Prompt模式:通过Prompt定义机器人在该节点的收集要求;

      API参数

      API参数默认将自动拉取已选择的API插件的所有参数。

      • 如果你不进行任何自定义修改,则参数会自动同步“知识库-API插件”中的修改;

      • 如果你进行了任何自定义修改,则此参数将不会自动同步“知识库-API插件”中的任意修改;

      参数描述

      参数描述默认也自动同步“知识库-API插件”中入参的参数解释。

      取值来源

      有三种来源:文本、参数、对话识别

      • 当取值来源为“文本”或“参数”时,直接进行使用并进行赋值;

      • 当取值来源为“对话识别”时,会从用户的回复中进行参数收集。

      说明

      参数收集Prompt:当用户选择Prompt模式时,可以输入参数收集的对话示例,辅助机器人完成参数的收集。

    • 自定义模式:按照参数定义顺序,对取值来源为“文本”或“参数”时,直接进行使用并进行赋值,对取值来源为“对话识别”的参数进行逐个收集,可以配置参数的询问话术和二次确认话术;

      API参数

      API参数默认将自动拉取已选择的API插件的所有参数。

      • 如果你不进行任何自定义修改,则参数会自动同步“知识库-API插件”中的修改;

      • 如果你进行了任何自定义修改,则此参数将不会自动同步“知识库-API插件”中的任意修改;

      参数描述

      参数描述默认也自动同步API插件中的参数解释信息。

      取值来源

      有三种来源:文本、参数、对话识别:

      • 当取值来源为“文本”或“参数”时:

        • 文本,支持用户输入默认值,并作为默认参数传入;image.png

        • 参数,用户可以选择对应的参数,机器人即可从选择的参数中获取对应的信息;image.png

      • 当取值来源为“对话识别”的参数时,可以进行询问当时、询问话术、选择指令、参数二次确认的配置。image.png

      说明

      询问方式:Prompt和固定话术两种方式;

      询问话术

      • Prompt:用户输入回复指令,可通过“/ ”的方式添加随路参数和系统参数;

      • 固定话术:机器人直接应用固定回复话术咨询用户;

      选择指令:指令用于外部系统与机器人对话的集成,如:转人工指令。机器人在回复时,同时随路下发指令信息供外部业务系统进行集成;

      参数二次确认:开启后,机器人主动与用户二次确认参数值是否正确。

  • API插件最大超时时间:调用API设置的超时时间,当调用返回超过设置的时间即为调用异常;

  • 分支条件:打开开关,机器人将按顺序进行分支条件判断,满足分支条件后跳转到后续节点。

应用示例

场景:售前售后工单处理流程,需要在提交工单前对用户的个人信息,如电话号码、姓名、住址等多个参数进行逐个收集,并对其中的重要参数进行二次确认动作。

示例流程如下:

image.png

配置步骤

  1. 新建流程,进入流程画布编辑界面;

  2. 输入意图边,当发生用户需要安装事件、用户报修/维修/检测事件、没有其他问题事件时,可以分别进入对应的意图边;

  3. 配置“用户报修/维修/检测”流程边,添加“保存维修工单”调用插件节点;

    1. 在调用插件节点选择已创建的API;

    2. 当选择完成后,“API参数”和“参数描述”自动进行拉取回填,选择“自定义模式”;然后逐个对参数进行配置:

      1. 选择取值来源为“对话识别”;image.png

  1. 点击“配置”,进行参数对话识别配置

    1. 选择询问方式为“prompt”;

    2. 询问话术可使用默认值;

    3. 打开参数二次确认开关,使用默认询问话术;image.png

  2. 配置“用户需要安装”流程边,添加“保存安装工单”调用插件节点;

    1. 在调用插件节点选择已创建的API;

    2. 当选择完成后,“API参数”和“参数描述”自动进行拉取回填,选择“Prompt模式”;然后逐个对参数进行配置:

      1. 选择取值来源为“对话识别”;

      2. 在“参数收集Prompt”框中填写收集规则,用于定制参数收集过程。image.png

  3. API调用成功后,添加机器人回复节点,分别配置提交服务单成功后的回复话术。

机器人回复节点的配置方法可参考《机器人回复节点》。

效果展示

以“用户报修/维修/检测”链路进行验证,按验证对话中机器人安装插件参数的要求分别收集用户信息,并且进行二次参数确认,最后提交工单派发任务。

收集用户信息:

image.png

二次确认:

image.png

自动提交工单:

image.png