GetSmartAuditResult
Queries the result of an automated review.
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:GetSmartAuditResult | get | *All Resource
| None | None |
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| WorkspaceId | string | No | The workspace ID. | llm-xx |
| TaskId | string | No | The task ID. | 3f7045e099474ba28ceca1b4eb6d6e21 |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | The response schema. | ||
| RequestId | string | The request ID. | xxxxx |
| Success | boolean | Indicates whether the request was successful. | true |
| Code | string | The error code. | DataNotExists |
| Message | string | The error message. | 错误消息 |
| HttpStatusCode | integer | The HTTP status code. | 400 |
| Data | object | The review result. | |
| Status | string | The task execution status. Valid values: PENDING, RUNNING, SUCCESSED, SUSPENDED, FAILED, and CANCELLED. | SUCCESSED |
| ErrorItemDetails | array<object> | The list of review error details. | |
object | |||
| Context | string | The original text segment. | 原文片段 |
| MajorCodeDesc | string | The description of the primary error. | 内容准确性 |
| ErrorWord | string | The incorrect word. | ”xxx“ |
| MajorCode | string | The primary error code. | ContentAccuracy |
| RightWord | string | The suggested correction. | “xxx” |
| Reason | string | The error description. | 中文双引号应成对正确使用,先左双引号,后右双引号 |
| Url | string | In an image review scenario, this is the public URL of the image that triggered the review. | |
| Offset | integer | The offset index of the incorrect word in the full text. | 0 |
| CheckId | string | The unique ID of the review item. | 审核项唯一标识。 |
| SubClassCode | string | The sub-error code. | PunctuationError |
| ErrorLevel | integer | The error level. 1: critical, 2: warning, 3: notice, 4: suggestion. | 2 |
| SubClassDesc | string | The description of the sub-error. | 标点符号错误 |
| ContextOffset | integer | The offset index of the incorrect word within the context. | 0 |
| ErrorMessage | string | If the final status is not SUCCESSED, read this error message to identify the fault. | 审核被取消 |
Examples
Success response
JSON format
{
"RequestId": "xxxxx",
"Success": true,
"Code": "DataNotExists",
"Message": "错误消息",
"HttpStatusCode": 400,
"Data": {
"Status": "SUCCESSED",
"ErrorItemDetails": [
{
"Context": "原文片段",
"MajorCodeDesc": "内容准确性",
"ErrorWord": "”xxx“",
"MajorCode": "ContentAccuracy",
"RightWord": "“xxx”",
"Reason": "中文双引号应成对正确使用,先左双引号,后右双引号",
"Url": "http://www.example.com/xxxx.jpg",
"Offset": 0,
"CheckId": "审核项唯一标识。\n\n",
"SubClassCode": "PunctuationError",
"ErrorLevel": 2,
"SubClassDesc": "标点符号错误\n",
"ContextOffset": 0
}
],
"ErrorMessage": "审核被取消"
}
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.