API插件的新建步骤。

概述

在流程管理中配置各个节点时,其中涉及相关API的调取,可以在API插件页面进行配置和管理。

功能入口

机器人空间,在技能管理>API插件,可以进入API管理页面,如下图所示。

image

功能介绍

新建API插件

  1. 点击新建API,打开新建API弹窗。

  • 服务名称:需要遵守变量名规范,包括单词+下划线和连续单词大写字母间隔两种方式,如 get_weather,注意只能使用英文。

  • 服务描述:主要描述清楚API的功能,可以包含少量出入参的信息,如根据XX查询XX,查询天气等,如果对API有一些特殊要求也可以写到服务描述,如 XX 和 XX参数都是非必选,但是必须要有一个。

  • 超长提示:主要描述清楚API的功能,可以包含少量出入参的信息,如根据XX查询XX,查询天气等,如果对API有一些特殊要求也可以写到服务描述,如 XX 和 XX参数两个均为非必选,但是必须要有一个。image.png

  • API配置

    • 接口配置:API调用的链接和token信息,都可以定义在API配置中。

    • 入参

      • 参数:跟上述参数名规范一样,按照变量名规范来定义,仅支持英文;

      • 类型:文本内容选择string,Number表示数字、Boolean表示true or false的布尔值;

      • 取值来源:包括模型识别和随路参数,其中随路参数不会传输给模型去识别;

      • 是否必填:当前参数是否为必填参数,建议一个API至少包含一个必填参数,对于选填参数,机器人不会主动询问,但是有表达对应内容时也会识别;

      • 参数解释:类似于上述参数说明,包括中文名、格式化描述和示例三部分。

    • 出参

      • Mock值:在没有真实的URL去请求时,可以通过该字段设置API的固定返回,注意该部分需要在对话调试窗打开开关,一旦打开则优先级高于URL请求。

      image.png

  1. 点击确定,即可创建成功。image

编辑/删除API插件

image