RunDocBrainmap
Generate a three-level, multilingual mind map from an article or a book, with control over the number of second-level nodes and the word count of leaf nodes.
Try it now
Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.
RAM authorization
The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:
-
Action: The actions can be used in the
Actionelement of RAM permission policy statements to grant permissions to perform the operation. -
API: The API that you can call to perform the action.
-
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
-
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the
Resourceelement of the policy. - For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the
Resourceelement of the policy.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the
-
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
-
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.
Action | Access level | Resource type | Condition key | Dependent action |
|---|---|---|---|---|
aimiaobi:RunDocBrainmap | get | *All Resource
| None | None |
Request syntax
POST /miaodu/stream/runDocBrainmap HTTP/1.1
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| WorkspaceId | string | Yes | The ID of the Model Studio workspace. For more information, see How to use a workspace. | llm-xxx |
| SessionId | string | Yes | The session ID. | 3f7045e099474ba28ceca1b4eb6d6e21 |
| DocId | string | Yes | The document ID. | 12345 |
| Prompt | string | No | A custom prompt to guide the mind map generation. | 请按英文输出 |
| CleanCache | boolean | No | Indicates whether to clear the previous cache. | true |
| NodeNumber | integer | No | The number of nodes to generate at the second level of the mind map. | 3 |
| WordNumber | integer | No | The maximum number of words in each node. | 20 |
| referenceContent | string | No | The source content for generating the mind map. This parameter takes precedence over | 要生成脑图的内容 |
| ModelName | string | No | The name of the model to use. | quanmiao-max、quanmiao-plus |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | Response schema. | ||
| Header | object | Response header. | |
| ErrorCode | string | Error code. | success |
| ErrorMessage | string | Error message. | success |
| Event | string | Event type. | task-failed |
| EventInfo | string | Event description. | 模型生成事件 |
| SessionId | string | Session ID. | 07181f55-2311-48af-8048-132a77dee020 |
| TaskId | string | Task ID. | 161816 |
| TraceId | string | Trace ID. | 6427cdf4-2ffe-4d05-b0ef-c4adceea90f4 |
| Payload | object | Response payload. | |
| Output | object | Output data. | |
| Content | string | Mind map content in JSON format. | {"xxxx":"xxx"} |
| Usage | object | Token usage statistics. | |
| InputTokens | integer | Number of input tokens. | 65 |
| OutputTokens | integer | Number of output tokens. | 100 |
| TotalTokens | integer | Total number of tokens. | 165 |
| RequestId | string | Request ID. | 1813ceee-7fe5-41b4-87e5-982a4d18cca5 |
Examples
Success response
JSON format
{
"Header": {
"ErrorCode": "success",
"ErrorMessage": "success",
"Event": "task-failed",
"EventInfo": "模型生成事件",
"SessionId": "07181f55-2311-48af-8048-132a77dee020",
"TaskId": "161816",
"TraceId": "6427cdf4-2ffe-4d05-b0ef-c4adceea90f4"
},
"Payload": {
"Output": {
"Content": "{\"xxxx\":\"xxx\"}"
},
"Usage": {
"InputTokens": 65,
"OutputTokens": 100,
"TotalTokens": 165
}
},
"RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5"
}
Error codes
HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 403 | NoPermission | You are not authorized to perform this action. | Please check the workspaceId assignment |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.