调用插件节点

更新时间:
复制 MD 格式

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

节点介绍

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

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

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

image.png

操作说明

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

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

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

    说明

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

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

      API参数

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

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

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

      参数描述

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

      取值来源

      API 参数的取值来源支持三种方式:固定值、引用、模型识别

      • 固定值:参数值来源于固定的文本内容,通过直接设置文本和参数名完成赋值;image

      • 引用:支持从三种来源引用参数值:

        • API 插件的输入/输出参数;

        • 系统预设参数;

        • 随路参数(即对话过程中传递的上下文参数)。
          当使用随路参数传入与 API 参数同名的值时,系统将自动优先采用该传入值,不再通过对话流程获取。image

          说明

          当当前节点为“参数收集”节点,且取值来源设置为“引用”时,系统将支持添加参数来源选项。此时,“参数”可选择当前流程收集的参数。

          image

      • 模型识别:由机器人通过自然语言交互的方式主动与用户对话,收集所需参数信息并填充至 API 请求中。

      说明

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

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

      API参数

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

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

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

      参数描述

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

      取值来源

      API 参数的取值来源支持三种方式:固定值、引用、模型识别

      • 当取值来源为“固定值”时,参数值来源于固定的文本内容,通过直接设置文本和参数名完成赋值。image

      • 当取值来源为“引用”时,支持从三种来源引用参数值:

        • API 插件的输入/输出参数;

        • 系统预设参数;

        • 随路参数(即对话过程中传递的上下文参数)。
          当使用随路参数传入与 API 参数同名的值时,系统将自动优先采用该传入值,不再通过对话流程获取。

        image

        说明

        当当前节点为“参数收集”节点,且取值来源设置为“引用”时,系统将支持添加参数来源选项。此时,“参数”可选择当前流程收集的参数。

        image

      • 当取值来源为“模型识别”的参数时,由机器人通过自然语言交互的方式主动与用户对话,收集所需参数信息并填充至 API 请求中。

        配置项

        说明

        基础配置

        参数名

        当前需要收集的参数字段名称,用于标识该参数在请求中的含义。例如:Address、Phone、CarNumber。

        参数描述

        对参数含义和填写要求进行说明,帮助模型理解应收集什么信息,以及信息应满足什么业务标准。例如:需要用户提供详细收货地址,至少包含省、市、区、街道等信息。

        参数收集方式

        支持常规收集方式与互动式收集方式。常规参数方式适合一次性从用户输入中识别参数;互动式收集方式适合参数缺失、不完整或需要追问确认的场景,包含手机号、车牌号、地址三种信息的收集。

        高级配置

        最多询问次数

        设置机器人针对同一参数最多可追问的次数。超过该次数后,系统不再继续追问,进入兜底处理。

        超过最多询问次数后,自动将参数值设置为

        当用户多次未提供有效信息时,系统自动填入的默认值。可配置为空值、默认值、固定文案或业务指定值,用于保障流程继续执行。

        • 常规收集方式

          配置项

          说明

          询问方式

          支持 Prompt 和固定话术两种方式,用于配置机器人在参数缺失、参数不完整或参数需要确认时,如何向用户发起追问。

          询问话术

          当参数缺失或识别不完整时,机器人用于向用户提问的文案。

          收集规则

          定义参数收集的判断标准,包括必填要求、格式要求、信息完整度要求、是否允许模糊值等。机器人会根据规则判断用户回答是否满足收集条件。

          选择指令

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

          参数二次确认

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

          image

        • 互动式收集方式

          配置项

          说明

          截图

          手机号

          手机号收集用于识别和补齐用户手机号。当用户只提供部分号码、分多次输入号码,或表达中夹杂无关内容时,机器人会继续追问剩余信息,并在收集完整后进行确认。

          image

          车牌号

          车牌号收集用于识别车辆牌照信息。当用户只提供车牌主体、缺少省份简称,或机器人判断车牌信息不完整时,会主动询问缺失部分,并在获得完整车牌后进行确认。

          image

          地址

          地址收集用于帮助机器人在自然对话中主动收集、补全和确认用户地址信息。当用户只提供了模糊地址、不完整地址,或地址不满足业务要求时,机器人会继续追问,直到获得符合规则的地址结果。地址校验有两种方式通过高德地图API或者您自己自定义API。

          说明

          高德API可参考《高德地图Web服务API》;

          自定义API的方式可参考《互动参数收集-地址-自定义API》。

          image

          image

          image

  • 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