HTTP 请求

特点

可重复添加
手动配置
触发执行
核中核模块

介绍

HTTP 模块会向对应的地址发送一个 HTTP 请求，实际操作与 Postman 和 ApiFox 这类直流工具使用差不多。

Params 为路径请求参数，GET 请求中用的居多。
Body 为请求体，POST/PUT 请求中用的居多。
Headers 为请求头，用于传递一些特殊的信息。
自定义变量中可以接收前方节点的输出作为变量
3 种数据中均可以通过 {{}} 来引用变量。
URL 也可以通过 {{}} 来引用变量。
变量来自于 全局变量、系统变量、前方节点输出

参数结构

系统变量说明

你可以将鼠标放置在 请求参数 旁边的问号中，里面会提示你可用的变量。

appId: 应用的 ID
chatId: 当前对话的 ID，测试模式下不存在。
responseChatItemId: 当前对话中，响应的消息 ID，测试模式下不存在。
variables: 当前对话的全局变量。
cTime: 当前时间。
histories: 历史记录（默认最多取 10 条，无法修改长度）

Params, Headers

不多描述，使用方法和 Postman, ApiFox 基本一致。

可通过 {{key}} 来引入变量。例如：

key	value
appId	`{{appId}}`
Authorization	Bearer `{{token}}`

Body

只有特定请求类型下会生效。

可以写一个 自定义的 Json，并通过 {{key}} 来引入变量。例如：

{
  "string": "字符串",
  "number": 123,
  "boolean": true,
  "array": [1, 2, 3],
  "obj": {
    "name": "FastGPT",
    "url": "https://fastgpt.io"
  }
}

注意，在 Body 中，你如果引用 字符串，则需要加上 ""，例如："{{string}}"。

{
  "string": "{{string}}",
  "token": "Bearer {{string}}",
  "number": {{number}},
  "boolean": {{boolean}},
  "array": [{{number}}, "{{string}}"],
  "array2": {{array}},
  "object": {{obj}}
}

{
  "string": "字符串",
  "token": "Bearer 字符串",
  "number": 123,
  "boolean": true,
  "array": [123, "字符串"],
  "array2": [1, 2, 3],
  "object": {
    "name": "FastGPT",
    "url": "https://fastgpt.io"
  }
}

如何获取返回值

从图中可以看出，FastGPT 可以添加多个返回值，这个返回值并不代表接口的返回值，而是代表 如何解析接口返回值，可以通过 JSON path 的语法，来 提取 接口响应的值。

语法可以参考: https://github.com/JSONPath-Plus/JSONPath?tab=readme-ov-file

{
  "message": "测试",
  "data": {
    "user": {
      "name": "xxx",
      "age": 12
    },
    "list": [
      {
        "name": "xxx",
        "age": 50
      },
      [{ "test": 22 }]
    ],
    "psw": "xxx"
  }
}

{
  "$.message": "测试",
  "$.data.user": { "name": "xxx", "age": 12 },
  "$.data.user.name": "xxx",
  "$.data.user.age": 12,
  "$.data.list": [{ "name": "xxx", "age": 50 }, [{ "test": 22 }]],
  "$.data.list[0]": { "name": "xxx", "age": 50 },
  "$.data.list[0].name": "xxx",
  "$.data.list[0].age": 50,
  "$.data.list[1]": [{ "test": 22 }],
  "$.data.list[1][0]": { "test": 22 },
  "$.data.list[1][0].test": 22,
  "$.data.psw": "xxx"
}

你可以配置对应的 key 来从 FastGPT 转化后的格式 获取需要的值，该规则遵守 JS 的对象取值规则。例如：

获取 message 的内容，那么你可以配置 message 的 key 为 message，这样就可以获取到 message 的内容。
获取 user的name，则 key 可以为：data.user.name。
获取 list 中第二个元素，则 key 可以为：data.list[1]，然后输出类型选择字符串，则获自动获取到 [ { "test": 22 } ] 的 json 字符串。

自动格式化输出

FastGPT v4.6.8 后，加入了出参格式化功能，主要以 json 格式化成 字符串 为主。如果你的输出类型选择了 字符串，则会将 HTTP 对应 key 的值，转成 json 字符串进行输出。因此，未来你可以直接从 HTTP 接口输出内容至 文本加工 中，然后拼接适当的提示词，最终输入给 AI对话。

HTTP 模块非常强大，你可以对接一些公开的 API，来提高编排的功能。

HTTP 对接业务服务示例

下面是一个 POST 请求服务示例：

type RequestType = {
  appId: string;
  appointment: string;
  action: 'post' | 'delete' | 'put' | 'get';
};

export async function handleAppointmentRequest(body: RequestType) {
  try {
    const { appId, appointment, action } = body;

    const parseBody = JSON.parse(appointment);
    if (action === 'get') {
      return await getRecord(appId, parseBody);
    }
    if (action === 'post') {
      return await createRecord(appId, parseBody);
    }
    if (action === 'put') {
      return await putRecord(appId, parseBody);
    }
    if (action === 'delete') {
      return await removeRecord(appId, parseBody);
    }

    return {
      response: '异常'
    };
  } catch (err) {
    return {
      response: '异常'
    };
  }
}

作用

通过 HTTP 模块你可以无限扩展，比如：

操作数据库
调用外部数据源
执行联网搜索
发送邮箱
……

本页导航