发起对话

请求简易应用和工作流

对话接口兼容GPT的接口!如果你的项目使用的是标准的GPT官方接口,可以直接通过修改BaseUrlAuthorization来访问 FastGpt 应用,不过需要注意下面几个规则:

请求

响应

交互节点响应

如果工作流中包含交互节点,依然是调用该 API 接口,需要设置detail=true,并可以从event=interactive的数据中获取交互节点的配置信息。如果是stream=false,则可以从 choice 中获取type=interactive的元素,获取交互节点的选择信息。

当你调用一个带交互节点的工作流时,如果工作流遇到了交互节点,那么会直接返回,你可以得到下面的信息:

交互节点继续运行

紧接着上一节,当你接收到交互节点信息后,可以根据这些数据进行 UI 渲染,引导用户输入或选择相关信息。然后需要再次发起对话,来继续工作流。调用的接口与仍是该接口,你需要按以下格式来发起请求:

请求插件

插件的接口与对话接口一致,仅请求参数略有区别,有以下规定:

  • 调用插件类型的应用时,接口默认为detail模式。
  • 无需传入 chatId,因为插件只能运行一轮。
  • 无需传入messages
  • 通过传递variables来代表插件的输入。
  • 通过获取pluginData来获取插件输出。

请求示例

  curl --location --request POST 'http://localhost:3000/api/v1/chat/completions' \
--header 'Authorization: Bearer test-xxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "stream": false,
    "chatId": "test",
    "variables": {
        "query":"你好" # 我的插件输入有一个参数,变量名叫 query
    }
}'
  

响应示例

对话 CRUD

重要字段

  • chatId - 指一个应用下,某一个对话窗口的 ID
  • dataId - 指一个对话窗口下,某一个对话记录的 ID

历史记录

获取某个应用历史记录

修改某个对话的标题

置顶 / 取消置顶

删除某个历史记录

清空所有历史记录

对话记录

指的是某个 chatId 下的对话记录操作。

获取单个对话初始化信息

获取对话记录列表

获取单个对话记录运行详情

删除对话记录

点赞 / 取消点赞

点踩 / 取消点踩

猜你想问