Generate an outline-style summary for multiple documents, videos, or URLs. The summary includes a consolidated overview and key points. This operation supports multiple input and output languages.
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:RunMultiDocIntroduction | get | *All Resource
| None | None |
Request syntax
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| WorkspaceId | string | Yes | Unique identifier of the Alibaba Cloud Model Studio workspace. To get this ID, see Get the workspace ID. | llm-2setzb9x4ewsd |
| DocIds | array | Yes | Array of document IDs. | |
string | No | Document ID. | 10022 | |
| SessionId | string | Yes | Session ID. | 75bf82fa-b71b-45d7-ae40-0b00e496cd9e |
| SummaryPrompt | string | No | Custom prompt for the summary. | Keep it concise |
| KeyPointPrompt | string | No | Custom prompt for key points. | Keep it concise |
| ModelName | string | No | Name of the custom model to use. | quanmiao-max、quanmiao-plus |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | Response schema. | ||
| RequestId | string | ID of the request. | 3f7045e099474ba28ceca1b4eb6d6e21 |
| Header | object | Response header. | |
| ErrorCode | string | Error code. | 200 |
| ErrorMessage | string | Error message. | Message does not exist. |
| Event | string | Server-sent event (SSE) type. | finished |
| EventInfo | string | Event description. | Model generation event |
| SessionId | string | Session ID. | 92e16ccb-92b6-4894-abbf-fc6e2929a0df |
| TaskId | string | Task ID. | b057f2fa-2277-477b-babf-cbc062307828 |
| TraceId | string | End-to-end trace ID. | 46e5c2b5-0877-4f09-bd91-ab0cf314e48b |
| Payload | object | Response body. | |
| Output | object | Output data. | |
| Summary | string | Outline-style summary. | Outline summary content |
| KeyPoints | array<object> | Key point information. | |
object | Key point information. | ||
| KeyPoint | string | Key point. | Key point information |
| Source | string | Source of the information. | Information source |
| Usage | object | Token usage. | |
| InputTokens | integer | Number of input tokens. | 65 |
| OutputTokens | integer | Number of output tokens. | 100 |
| TotalTokens | integer | Total number of tokens. | 165 |
Examples
Success response
JSON format
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 |