流程编排 API 调用节点说明

本文档主要介绍API调用节点的使用。

节点界面

image

节点说明

API调用节点允许您的AI应用使用HTTP/HTTPS协议与外部服务进行通信,以便与外部数据和功能进行集成和交互。

配置页面image

配置说明

API节点目前支持最常用的HTTP协议方法:GETPOST。URL地址需要附带HTTPHTTPS协议头。API节点允许配置输入参数,并支持动态传入请求头,如上图所示。

请注意,API节点不支持application/x-www-form-urlencoded类型的POST请求。建议您使用工作流应用来完成该任务。

输入变量的方法

(1)手工输入

根据变量类型的不同,从相应的结果中获取,形如${bizVars.abc},如果输入不在${}内,会被识别为常量。

(2)联想提示

在界面输入/,会弹出提示,直接选中变量即可,选中后与手工输入一样。

image

结果获取方法

为了减少您的配置工作,API节点不需要定义输出参数的格式。具体取值方式如下,假设当前节点的IDApi_xxx

  • JSON对象返回值:

    当返回的数据是一个JSON对象(例如:{"a":1,"b":"cc"}),后续节点可以通过表达式${svcVars.Api_xxx.response.a}获取其中的字段a

  • JSON数组返回值:

    如果返回的数据是一个JSON数组(例如:[{"a":1},{"a":3,"b":"cc"}]),后续节点可以使用${svcVars.Api_xxx.response.list[0].a}获取第一条数据中的字段a。如果需要获取所有数据中的字段a,则使用${svcVars.Api_xxx.response.list.a}。(list是默认的一级键值)

  • JSON返回值:

    对于非JSON格式的返回值(例如:"这个问题怎么样"),后续节点可以通过${svcVars.Api_xxx.response.text}获取完整的数据。(text是默认的一级键值)

通过这些方式,您可以方便地从不同类型的返回值中提取所需信息。