特点

  • 可重复添加
  • 有外部输入
  • 手动配置
  • 触发执行
  • 核中核模块

介绍

HTTP 模块会向对应的地址发送一个 POST/GET 请求，携带部分系统参数及自定义参数，并接收一个 JSON 响应值，字段也是自定义。

  • Params 为路径请求参数，GET请求中用的居多。
  • Body 为请求体，POST请求中用的居多。
  • Headers 为请求头，用于传递一些特殊的信息。
  • 3 种数据中均可以通过 {{}} 来引用变量。
  • 变量来自于全局变量、系统变量、局部传入

参数结构

系统变量说明

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

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

Params, Headers

不多描述，使用方法和Postman, ApiFox 基本一致，目前 Params 和 Headers 未提供语法提示，后续会加入。

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

keyvalue
appId{{appId}}
AuthorizationBearer {{token}}

Body

只有POST模式下会生效。

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

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

注意，在 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.in"
  }
}

如何获取返回值

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

  {
  "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 的对象取值规则。例如：

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

自动格式化输出

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

动态外部数据

在插件中的HTTP模块有一个属性叫动态外部数据，这个属性是与插件输入中，数据类型为动态外部数据的值搭配使用。

类似于文本加工模块，会有一个不确定长度，不确定key的用户输入，因此这部分数据会被动态外部数据接收，它们是一个对象。在 HTTP 模块中，你可以在Body中接收到一个key为DYNAMIC_INPUT_KEY的对象。

laf 对接 HTTP 示例

下面是在 Laf 编写的 POST 请求示例：

  import cloud from '@lafjs/cloud'
const db = cloud.database()

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

export default async function (ctx: FunctionContext) {
  try {
    // 从 body 中获取参数
    const { appId, appointment, action } = ctx.body as RequestType

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


    return {
      response: "异常"
    }
  } catch (err) {
    return {
      response: "异常"
    }
  }
}

作用

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

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

相关示例

编辑此页面