本文档介绍流程管理中调用插件节点的配置方法和应用实例。
节点介绍
机器人进入调用插件节点时,会执行 API 插件调用,主要的执行步骤分为下面两个:
阶段 1:API 需要必要输入参数未获取到时,机器人将主动与用户对话完成参数收集。对话效果与参数收集一致。
阶段 2:当必要的输入参数完整后,机器人自动调用 API 插件,并解析插件返回结果,根据后续分支配置继续进行对话。

操作说明
节点名称:按照业务需求可以修改节点名称,系统展示默认值;
选择API插件:按照流程需求选择对应API;
API插件的配置方法请参考《API插件》;
API插件参数收集:有两种模式,分别是Prompt模式和自定义模式:
说明当随路参数与要收集的参数同名时,会直接赋值,不再进行收集。
Prompt模式:通过Prompt定义机器人在该节点的收集要求;
API参数
API参数默认将自动拉取已选择的API插件的所有参数。
如果你不进行任何自定义修改,则参数会自动同步“知识库-API插件”中的修改;
如果你进行了任何自定义修改,则此参数将不会自动同步“知识库-API插件”中的任意修改;
参数描述
参数描述默认也自动同步“知识库-API插件”中入参的参数解释。
取值来源
API 参数的取值来源支持三种方式:固定值、引用、模型识别
固定值:参数值来源于固定的文本内容,通过直接设置文本和参数名完成赋值;

引用:支持从三种来源引用参数值:
API 插件的输入/输出参数;
系统预设参数;
随路参数(即对话过程中传递的上下文参数)。
当使用随路参数传入与 API 参数同名的值时,系统将自动优先采用该传入值,不再通过对话流程获取;
说明当当前节点为“参数收集”节点,且取值来源设置为“引用”时,系统将支持添加参数来源选项。此时,“参数”可选择当前流程收集的参数。

模型识别:由机器人通过自然语言交互的方式主动与用户对话,收集所需参数信息并填充至 API 请求中。
说明参数收集Prompt:当用户选择Prompt模式时,可以输入参数收集的对话示例,辅助机器人完成参数的收集。
自定义模式:按照参数定义顺序,对取值来源为“文本”或“参数”时,直接进行使用并进行赋值,对取值来源为“对话识别”的参数进行逐个收集,可以配置参数的询问话术和二次确认话术;
API参数
API参数默认将自动拉取已选择的API插件的所有参数。
如果你不进行任何自定义修改,则参数会自动同步“知识库-API插件”中的修改;
如果你进行了任何自定义修改,则此参数将不会自动同步“知识库-API插件”中的任意修改;
参数描述
参数描述默认也自动同步API插件中的参数解释信息。
取值来源
API 参数的取值来源支持三种方式:固定值、引用、模型识别
当取值来源为“固定值”时,参数值来源于固定的文本内容,通过直接设置文本和参数名完成赋值。

当取值来源为“引用”时,支持从三种来源引用参数值:
API 插件的输入/输出参数;
系统预设参数;
随路参数(即对话过程中传递的上下文参数)。
当使用随路参数传入与 API 参数同名的值时,系统将自动优先采用该传入值,不再通过对话流程获取。
说明当当前节点为“参数收集”节点,且取值来源设置为“引用”时,系统将支持添加参数来源选项。此时,“参数”可选择当前流程收集的参数。

当取值来源为“模型识别”的参数时,由机器人通过自然语言交互的方式主动与用户对话,收集所需参数信息并填充至 API 请求中。支持进行询问当时、询问话术、选择指令、参数二次确认的配置。

说明询问方式:Prompt和固定话术两种方式;
询问话术:
Prompt:用户输入回复指令,可通过“/ ”的方式添加随路参数和系统参数;
固定话术:机器人直接应用固定回复话术咨询用户;
选择指令:指令用于外部系统与机器人对话的集成,如:转人工指令。机器人在回复时,同时随路下发指令信息供外部业务系统进行集成;
参数二次确认:开启后,机器人主动与用户二次确认参数值是否正确。
API插件最大超时时间:调用API设置的超时时间,当调用返回超过设置的时间即为调用异常;
分支条件:打开开关,机器人将按顺序进行分支条件判断,满足分支条件后跳转到后续节点。
应用示例
场景:售前售后工单处理流程,需要在提交工单前对用户的个人信息,如电话号码、姓名、住址等多个参数进行逐个收集,并对其中的重要参数进行二次确认动作。
示例流程如下:

配置步骤
新建流程,进入流程画布编辑界面;
输入意图边,当发生用户需要安装事件、用户报修/维修/检测事件、没有其他问题事件时,可以分别进入对应的意图边;
配置“用户报修/维修/检测”流程边,添加“保存维修工单”调用插件节点;
在调用插件节点选择已创建的API;
当选择完成后,“API参数”和“参数描述”自动进行拉取回填,选择“自定义模式”;然后逐个对参数进行配置:
选择取值来源为“对话识别”;

点击“配置”,进行参数对话识别配置
选择询问方式为“prompt”;
询问话术可使用默认值;
打开参数二次确认开关,使用默认询问话术;

配置“用户需要安装”流程边,添加“保存安装工单”调用插件节点;
在调用插件节点选择已创建的API;
当选择完成后,“API参数”和“参数描述”自动进行拉取回填,选择“Prompt模式”;然后逐个对参数进行配置:
选择取值来源为“对话识别”;
在“参数收集Prompt”框中填写收集规则,用于定制参数收集过程。

API调用成功后,添加机器人回复节点,分别配置提交服务单成功后的回复话术。
机器人回复节点的配置方法可参考《机器人回复节点》。
效果展示
以“用户报修/维修/检测”链路进行验证,按验证对话中机器人安装插件参数的要求分别收集用户信息,并且进行二次参数确认,最后提交工单派发任务。
收集用户信息:

二次确认:

自动提交工单:




