RunBookBrainmap

Updated at:

Miaodu generates mind maps of books.

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 Action element 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 Resource element of the policy.
    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
  • 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:RunBookBrainmap

get

*All Resource

*

NoneNone

Request syntax

POST /miaodu/stream/runBookBrainmap HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

WorkspaceId

string

Yes

The unique identifier for the Model Studio workspace. For more information, see Workspace ID.

llm-hx72jf15gqyobvd9

SessionId

string

Yes

The session ID.

3f7045e099474ba28ceca1b4eb6d6e21

DocId

string

Yes

The document ID.

12345

Prompt

string

No

A prompt with additional instructions.

按英文输出

CleanCache

boolean

No

Specifies whether to clear the cache. The default is false.

true

NodeNumber

integer

No

The number of nodes on the second level of the mind map.

3

WordNumber

integer

No

The number of words per node.

20

Response elements

Element

Type

Description

Example

object

The response schema.

RequestId

string

The request ID.

3f7045e099474ba28ceca1b4eb6d6e21

Header

object

The response header.

ErrorCode

string

The error code.

Success

ErrorMessage

string

The error message.

success

Event

string

The event type.

task-failed

EventInfo

string

The event description.

模型生成事件

SessionId

string

The session ID.

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

TaskId

string

The task ID.

3f7045e099474ba28ceca1b4eb6d6e21

TraceId

string

The trace ID.

0bc1409b17210096103458421ec62e

Payload

object

The response payload.

Output

object

The generated output.

Content

string

The mind map content.

{"xxxx":"xxx"}

Usage

object

Details about token usage.

InputTokens

integer

The input token count.

100

OutputTokens

integer

The output token count.

100

TotalTokens

integer

The total token count.

200

Examples

Success response

JSON format

{
  "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
    }
  }
}

Error codes

HTTP status code

Error code

Error message

Description

403NoPermissionYou 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.