Submits a custom analysis task to analyze hot topic perspectives.
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:SubmitCustomTopicSelectionPerspectiveAnalysisTask | create | *All Resource
| None | None |
Request syntax
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| AgentKey | string | Yes | The unique identifier of the workspace. For more information, see AgentKey. | xxxxx_p_efm |
| Documents | array<object> | No | The list of documents to be analyzed. | |
object | No | |||
| Author | string | No | The author. | Author |
| Content | string | Yes | The content. | Article content |
| PubTime | string | No | The publication time. Format: YYYY-MM-dd HH:mm:ss | 2024-01-22 10:29:00 |
| Source | string | No | The source of the article. | Sina |
| Summary | string | No | The summary. | Article summary |
| Title | string | No | The title. | Article title |
| Url | string | No | The URL of the article. | |
| Topic | string | No | The name of the topic to be analyzed. | The topic name to be analyzed (at least one of documents or topic must be provided) |
| Prompt | string | Yes | The input prompt for custom perspectives. | The input prompt for custom perspectives |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | PlainResult | ||
| Code | string | The status code. | NoData |
| Data | object | The business data. | |
| TaskId | string | The unique ID of the task. | 3f7045e099474ba28ceca1b4eb6d6e21 |
| HttpStatusCode | integer | The HTTP status code. | 200 |
| Message | string | The error description. | success |
| RequestId | string | The unique ID of the request. | 1813ceee-7fe5-41b4-87e5-982a4d18cca5 |
| Success | boolean | Indicates whether the request was successful. `true` indicates success. `false` indicates failure. | true |
Examples
Success response
JSON format