DescribeBizTypeTextLib-AI Guardrails(AI Guardrails)-阿里云帮助中心

Associates text libraries with a business scenario.

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.

Test

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

yundun-greenweb:DescribeBizTypeTextLib

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BizTypeName	string	Yes	The business scenario.	default
ResourceType	string	Yes	The resource type.	TEXT
Scene	string	Yes	The moderation scenario.	antispam

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****
Black	object	The blacklist library information.
Selected	array<object>	The selected list.
	object	The selected list.
Code	string	The encoding of the term library.	314317
Name	string	The name of the term library.	黑样本库
All	array<object>	The list of all blacklist libraries.
	object	The list of all blacklist libraries.
Code	string	Lexicon encoding.	314317
Name	string	Lexicon name.	黑样本库
Review	object	The suspicious sample library information.
Selected	array<object>	The selected list.
	object	The selected list.
Code	string	The encoding of the term library.	3143127
Name	string	The name of the term library.	疑似样本库
All	array<object>	The list of all suspicious sample libraries.
	object	The list of all suspicious sample libraries.
Code	string	The encoding of the term library.	3143127
Name	string	The name of the term library.	疑似样本库
Ignore	object	The list of ignored sample libraries.
Selected	array<object>	The selected list.
	object	The selected list.
Code	string	Lexicon encoding.	3343223
Name	string	Lexicon name.	忽略样本库
All	array<object>	The list of all ignored sample libraries.
	object	The list of all ignored sample libraries.
Code	string	Lexicon encoding.	3343223
Name	string	Lexicon name.	忽略样本库
White	object	The whitelist sample library information.
Selected	array<object>	The selected list.
	object	The selected list.
Code	string	Lexicon encoding.	65467
Name	string	Lexicon name.	白样本库
All	array<object>	The list of all whitelist sample libraries.
	object	The list of all whitelist sample libraries.
Code	string	Lexicon encoding.	65467
Name	string	Lexicon name.	白样本库

Examples

Success response

JSON format

{
  "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****",
  "Black": {
    "Selected": [
      {
        "Code": "314317",
        "Name": "黑样本库"
      }
    ],
    "All": [
      {
        "Code": "314317",
        "Name": "黑样本库"
      }
    ]
  },
  "Review": {
    "Selected": [
      {
        "Code": "3143127",
        "Name": "疑似样本库"
      }
    ],
    "All": [
      {
        "Code": "3143127",
        "Name": "疑似样本库"
      }
    ]
  },
  "Ignore": {
    "Selected": [
      {
        "Code": "3343223",
        "Name": "忽略样本库"
      }
    ],
    "All": [
      {
        "Code": "3343223",
        "Name": "忽略样本库"
      }
    ]
  },
  "White": {
    "Selected": [
      {
        "Code": "65467",
        "Name": "白样本库"
      }
    ],
    "All": [
      {
        "Code": "65467",
        "Name": "白样本库"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.