API插件

更新时间:2024-12-11 02:02:36

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

新建API插件

  1. 进入机器人空间业务空间,选择知识库>API插件,单击新建API,打开新建API弹窗。

    说明
    • 业务空间:业务空间可以理解为管理机器人的地方,业务空间包含了许多的机器人。

    • 机器人空间:机器人空间是指进入到具体某一个机器人的操作空间中。

    • 业务空间API插件列表包含所有已经创建的插件,而机器人空间下的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

  2. 单击确定,即可创建成功。image

流程API插件

  1. 进入机器人空间,选择知识库>API插件>流程API插件image

  2. 流程API插件是指流程中使用的API插件,是在机器人空间或者业务空间已经创建好的API插件,当某一个流程中节点使用API插件保存后,流程API插件列表就会展示出来。

    image

  • 本页导读 (1)
  • 新建API插件
  • 流程API插件
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等