AddAuditTerms
Add a custom term to the audit dictionary.
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:AddAuditTerms | create | *All Resource
| None | None |
Request syntax
POST HTTP/1.1
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| WorkspaceId | string | Yes | Unique identifier of the Alibaba Cloud Model Studio workspace. To get this ID, see Workspace ID. | llm-xx |
| Keyword | string | No | Keyword | 龘 |
| SuggestWord | string | No | Suggested word | 龘(dá) |
| TermsDesc | string | No | Audit basis | 龙行龘龘出自四库本《玉篇》23龙部第8字,文字释义为群龙腾飞的样子,昂扬而热烈。 |
| ExceptionWord | array | No | Exception phrase | |
string | No | Exception phrase | 例外语句 | |
| TermsName | string | No | Name of the dictionary. Optional. If not specified, defaults to Default. | Default |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | Response schema | ||
| RequestId | string | ID of the request | F2F366D6-E9FE-1006-BB70-2C650896AAB5 |
| Success | boolean | Whether the request succeeded | true |
| Code | string | Status code | DataNotExists |
| Message | string | Error message | success |
| HttpStatusCode | integer | HTTP status code | 200 |
| Data | boolean | Business data (whether the update succeeded). This field is deprecated. Use DataV1 to get the primary key ID instead. | true |
| DataV1 | object | ID of the added dictionary term | 返回添加的实体信息 |
| Id | integer | ID | 562fe4163a59d7bcb44bfdde4e3d5046 |
Examples
Success response
JSON format
{
"RequestId": "F2F366D6-E9FE-1006-BB70-2C650896AAB5",
"Success": true,
"Code": "DataNotExists",
"Message": "success",
"HttpStatusCode": 200,
"Data": true,
"DataV1": {
"Id": 0
}
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.