RunBookBrainmap - 书籍脑图

妙读生成书籍脑图。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
aimiaobi:RunBookBrainmapget
*全部资源
*

请求语法

POST /miaodu/stream/runBookBrainmap HTTP/1.1

请求参数

名称类型必填描述示例值
WorkspaceIdstring

阿里云百炼业务空间唯一标识:获取业务空间 ID(Workspace ID)

llm-hx72jf15gqyobvd9
SessionIdstring

会话 ID。

3f7045e099474ba28ceca1b4eb6d6e21
DocIdstring

文档 ID

12345
Promptstring

附加要求提示词

按英文输出
CleanCacheboolean

是否清理掉之前的缓存

true
NodeNumberinteger

第二级有几个节点

3
WordNumberinteger

节点文字的个数

20

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

3f7045e099474ba28ceca1b4eb6d6e21
Headerobject

响应头

ErrorCodestring

错误码

Success
ErrorMessagestring

错误信息

success
Eventstring

事件类型

task-failed
EventInfostring

事件描述

模型生成事件
SessionIdstring

会话 ID

3cd10828-0e42-471c-8f1a-931cde20b035
TaskIdstring

任务 ID

3f7045e099474ba28ceca1b4eb6d6e21
TraceIdstring

全链路 ID

0bc1409b17210096103458421ec62e
Payloadobject

响应体

Outputobject

输出内容对象

Contentstring

脑图内容

{"xxxx":"xxx"}
Usageobject

token 消耗

InputTokenslong

输入 Token 数量

100
OutputTokenslong

输出 Token 数量

100
TotalTokenslong

总 oken 数量

200

示例

正常返回示例

JSON格式

{
  "RequestId": "3f7045e099474ba28ceca1b4eb6d6e21",
  "Header": {
    "ErrorCode": "Success",
    "ErrorMessage": "success",
    "Event": "task-failed",
    "EventInfo": "模型生成事件",
    "SessionId": "3cd10828-0e42-471c-8f1a-931cde20b035",
    "TaskId": "3f7045e099474ba28ceca1b4eb6d6e21",
    "TraceId": "0bc1409b17210096103458421ec62e"
  },
  "Payload": {
    "Output": {
      "Content": {
        "xxxx": "xxx"
      }
    },
    "Usage": {
      "InputTokens": 100,
      "OutputTokens": 100,
      "TotalTokens": 200
    }
  }
}

错误码

HTTP status code错误码错误信息描述
403NoPermissionYou are not authorized to perform this action.请检查workspaceId的赋值

访问错误中心查看更多错误码。