DetailResults
Details of results returned by text moderation
Used by actions: TextModeration.
| Name | Type | Description |
|---|---|---|
| Label | String | Result of the moderation. Normal: normal content; Porn: pornographic content; Abuse: abusive content; Ad: advertising content; Custom: custom violating content |
| Suggestion | String | Recommended follow-up action. Block: block it automatically; Review: review the content again in human; Pass: passNote: This field may return null, indicating that no valid value can be found. |
| Keywords | Array of String | Returns the information of keywords hit in the text. When no value is returned and Score is not empty, it means the Label is determined by the semantic-based detection model.Note: This field may return null, indicating that no valid values can be obtained. |
| Score | Integer | This field indicates the convincing level of the Label, ranging from 0 (lowest) to 100 (highest). Note: This field may return null, indicating that no valid value can be found. |
| LibType | Integer | It indicates the library type corresponding with the keyword. Valid values: 1 (blocklist/allowlist library) and 2 (custom keyword library). If no custom keyword library is configured, the default value is 1.Note: This field may return null, indicating that no valid value can be found. |
| LibId | String | This field is **only valid when Label is Custom. It returns the custom library ID to facilitate the library management and configuration.Note: This field may return null, indicating that no valid value can be found. |
| LibName | String | This field is **only valid when Label is Custom (custom keyword). It returns the custom library name to facilitate the library management and configuration.<br/>Note: This field may return null`, indicating that no valid value can be found. |
| SubLabel | String | The field returns the second-level labels under the current label. Note: This field may return null, indicating that no valid value can be found. |
| Tags | Array of Tag | Returns the keywords, label, sub-label and the score. Note: This field may return null, indicating that no valid values can be obtained. |
Device
This field indicates the device information of the service subscriber
Used by actions: TextModeration.
| Name | Type | Required | Description |
|---|---|---|---|
| IP | String | No | This field indicates the IP address of the device used by the service subscriber. Note: Currently, only IPv4 addresses can be recorded. |
| Mac | String | No | This field indicates the MAC address used by the service subscriber to facilitate device identification and management. Its format and value are consistent with those of the standard MAC address. |
| TokenId | String | No | * In beta test. Available soon.* |
| DeviceId | String | No | * In beta test. Available soon.* |
| IMEI | String | No | This field represents the IMEI (International Mobile Equipment Identity) number of the device used by the service subscriber. IMEI can be used to identify each independent mobile communication device, such as a mobile phone, which is convenient for device identification and management. Note: IMEI is formatted with 15 to 17 numbers only. |
| IDFA | String | No | Dedicated for iOS device. This field indicates the IDFA (Identifier for Advertising) corresponding to the service subscriber. IDFA, a string of hexadecimal 32 characters including numbers and letters, is provided by Apple Inc. to identify the user. Note: Since the iOS14 update in 2021, Apple Inc. has allowed users to manually activate or deactivate IDFA, so the validity of the string identifier may be reduced. |
| IDFV | String | No | Dedicated for iOS device. This field indicates the IDFV (Identifier for Vendor) corresponding to the service subscriber. IDFV, a string of hexadecimal 32 characters including numbers and letters, is provided by Apple Inc. to identify the vendor. IDFV can also be used as a unique device identifier. |
RiskDetails
Account risk detection results
Used by actions: TextModeration.
| Name | Type | Description |
|---|---|---|
| Label | String | This field returns the risk categories after account information detection. Valid values: RiskAccount (the account is at risk), RiskIP (the IP address is at risk), and RiskIMEI (the mobile device identifier is at risk). |
| Level | Integer | This field returns the risk levels after account information detection. Valid values: 1 (suspected to be at risk) and 2 (malicious risk). |
Tag
Returns the keywords, label, sub-label and the score.
Used by actions: TextModeration.
| Name | Type | Description |
|---|---|---|
| Keyword | String | Returns the hit keywords. Note: This field may return null, indicating that no valid values can be obtained. |
| SubLabel | String | Returns the sub-tags. Note: This field may return null, indicating that no valid values can be obtained. |
| Score | Integer | Returns the score for the sub-label Note: This field may return null, indicating that no valid values can be obtained. |
User
This field indicates the account-related information of the service subscriber
Used by actions: TextModeration.
| Name | Type | Required | Description |
|---|---|---|---|
| UserId | String | No | This field indicates the service subscriber ID. This ID can be used to optimize the moderation result judgment based on the account's violation records, which is helpful for auxiliary judgment when there is a risk of suspected violations. |
| Nickname | String | No | This field indicates the account nickname information of the service subscriber. |
| AccountType | Integer | No | This field indicates the account type corresponding to the service subscriber ID. Use this field and the account ID (UserId) together to determine a unique account. |
| Gender | Integer | No | This field indicates the gender information of the service subscriber's account. Values: 0 (default value, indicating the gender is unknown), 1 (male) and 2 (female). |
| Age | Integer | No | This field indicates the age information of the service subscriber's account. Values: Integers between 0 (default value, indicating that the age is unknown) and the number of (custom maximum age). |
| Level | Integer | No | This field indicates the level information of the service subscriber's account. Values: 0 (default value, indicating that the level is unknown), 1 (lower level), 2 (medium level) and 3 (higher level). Currently, custom levels are not supported. |
| Phone | String | No | This field indicates the mobile phone number information of the service subscriber's account. The mobile phone numbers in various regions of the world can be recorded. Note: Please keep the format of mobile phone number uniform. For example, uniformly use the area code format (086/+86), etc. |
| HeadUrl | String | No | This field indicates the URL of the service subscriber's profile photos formatted with .png, .jpg, .jpeg, .bmp, .gif and .webp. Note: Up to 5 MB is supported, and the minimum resolution is 256 x 256. When it takes more than 3 seconds to download, the "download timeout" is returned. |
| Desc | String | No | This field indicates the profile information of service subscribers. It can contain up to 5,000 characters, including Chinese characters, letters and special symbols. |
| RoomId | String | No | Room ID of the group chat. |
| ReceiverId | String | No | Receiver ID. |
| SendTime | Integer | No | Generation time of the message, in ms. |
Yes
No
Was this page helpful?