Skip to main content

GetDocClusterTask

Retrieves the result of a content aggregation task.

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:GetDocClusterTask

get

*All Resource

*

NoneNone

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

AgentKey

string

Yes

The unique identifier of the workspace. For more information, see AgentKey.

xxxxx_p_efm

TaskId

string

Yes

The unique ID of the task.

This parameter is optional. The system automatically generates a task ID. If subsequent tasks use the same task ID, they are considered part of the same conversation group.

93771c8e1142467fb1aedf1763feba1e

Response elements

Element

Type

Description

Example

object

PlainResult

Code

string

The status code.

NoData

Data

object

The business data.

ErrorMessage

string

The error message.

Error message

Status

string

The status of the task. Valid values: PENDING (to be executed), RUNNING (executing), SUCCESSED (successful), SUSPENDED (paused), FAILED (failed), and CANCELED (canceled).

PENDING

Topics

array<object>

A list of clustering topics.

object

A hot spot event object.

DocIds

array

A list of document IDs for the clustering topic.

string

The document ID.

xxxxx

Summary

string

The summary of the clustering topic.

Summary of the clustering topic

Title

string

The name of the clustering topic.

Name of the clustering topic

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`: The request was successful. `false`: The request failed.

true

Examples

Success response JSON format
{
  "Code": "NoData",
  "Data": {
    "ErrorMessage": "Error message",
    "Status": "PENDING",
    "Topics": [
      {
        "DocIds": [
          "xxxxx"
        ],
        "Summary": "Summary of the clustering topic",
        "Title": "Name of the clustering topic"
      }
    ]
  },
  "HttpStatusCode": 200,
  "Message": "success",
  "RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.
Token Plan
Model Playground
  • 3D model generation
  • Audio generation
Fine-tuning
Model Compression
Statistics and Monitoring
Support