← 返回首页
POST /api/ai/chatGPTWithAction

带动作的 AI 对话

源文件 (GitHub)
需要认证 需要管理员

接口描述

向配置好的 AI 服务发送消息,并可以指定对一组块(通过 ID)执行特定的动作(如总结、润色、翻译等)。

具体的动作(`action`)类型可能取决于思源笔记的版本和配置。常见的动作可能包括:

请求参数

参数名 类型 必选 描述
ids string[] 要进行操作的块 ID 列表。
action string 要执行的动作类型(如 `summarize`, `polish`, `ask` 等)。
msg string 可选的附加消息。例如,在执行 `ask` 动作时,这里是具体的问题。

返回值

返回 AI 的处理结果或回复内容。

参数名 类型 描述
codenumber返回码,0表示成功
msgstring返回信息
dataanyAI 处理后的结果。具体类型取决于 `action`。可能是文本字符串(如总结、润色、翻译结果),也可能是其他结构。

总结两个块:

{
  "ids": [
    "20230101090000-xxxxxxxx",
    "20230101090100-yyyyyyyy"
  ],
  "action": "summarize",
  "msg": ""
}

基于一个块提问:

{
  "ids": [
    "20230101090200-zzzzzzzz"
  ],
  "action": "ask",
  "msg": "请解释这个块中的关键概念。"
}

成功总结:

{
  "code": 0,
  "msg": "",
  "data": "这两个块主要讨论了AI在自然语言处理中的应用及其未来发展方向。"
}

错误示例 (例如动作类型不支持):

{
  "code": -1,
  "msg": "Unsupported action type: invalidAction",
  "data": null
}

注意:这是一个社区维护的文档,可能与官方最新版本存在差异。

如果您觉得本文档有帮助,可以考虑赞助支持:爱发电