Device
Indicates the information of the business user's device
Used by actions: ImageModeration.
| Name | Type | Required | Description |
|---|---|---|---|
| Ip | String | No | This field indicates the IP address of the business user's device and supports recording both IPv4 and IPv6 addresses. It needs to be used together with the IpType parameter. |
| Mac | String | No | This field indicates the MAC address of the business user, which makes it easier to identify and manage devices. Its format and value are the same as those of a standard MAC address. |
| TokenId | String | No | In beta test. Stay tuned. |
| DeviceId | String | No | In beta test. Stay tuned. |
| IMEI | String | No | This field indicates the international mobile equipment identity (IMEI) number of the business user's device, which can be used to identify each mobile communication device such as mobile phone for easier device identification and management. Note: the format is 15–17 digits. |
| IDFA | String | No | For iOS devices: this field indicates the identifier for advertisers (IDFA) of the business user, which is provided by Apple to identify the user and contains a hexadecimal string of 32 digits and letters. Note: as iOS 14 has been updated by Apple to allow users to manually enable or disable IDFA since 2021, the validity of this string may be reduced. |
| IDFV | String | No | For iOS devices: this field indicates the identifier for vendors (IDFV) of the business user, which is provided by Apple to identify the app vendor and contains a hexadecimal string of 32 digits and letters. It can be used to uniquely identify a device. |
| IpType | Integer | No | This field indicates the type of the recorded IP address. Valid values: 0 (IPv4 address), 1 (IPv6 address). It needs to be used together with the IpType parameter. |
LabelDetailItem
Returns the details of the subtag hit by the categorization model
Used by actions: ImageModeration.
| Name | Type | Description |
|---|---|---|
| Id | Integer | This field is used to return the ID of the recognized object for easier recognition and distinction. Note: this field may return null, indicating that no valid values can be obtained. |
| Name | String | This field is used to return the hit subtag name. Note: this field may return null, indicating that no valid values can be obtained. |
| Score | Integer | This field is used to return the hit score of the subtag. Value range: 0–100; for example, Porn-SexBehavior 99 indicates that the hit score of the Porn-SexBehavior tag for the recognized content is 99. Note: this field may return null, indicating that no valid values can be obtained. |
LabelResult
Hit result of the categorization model
Used by actions: ImageModeration.
| Name | Type | Description |
|---|---|---|
| Scene | String | This field is used to return the scenario result recognized by the model, such as advertising, pornographic, and harmful. |
| Suggestion | String | This field is used to return the operation suggestion for the current maliciousness tag. When you get the determination result, the returned value indicates the operation suggested by the system. We recommend you handle different types of violations and suggestions according to your business needs. Returned values: Block, Review, Pass. |
| Label | String | This field is used to return the maliciousness tag in the detection result. Returned values: Normal: normal; Porn: pornographic; Abuse: abusive; Ad: advertising; Custom: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content. |
| SubLabel | String | This field is used to return the detection result for a subtag under the maliciousness tag, such as Porn-SexBehavior. |
| Score | Integer | Confidence score of the under the current label. Value range: 0 (the lowest confidence) to 100 (the highest confidence). For example, Porn 99 indicates that the image is highly likely to be pornographic, while Porn 0 indicates that the image is not pornographic. |
| Details | Array of LabelDetailItem | This field is used to return the details of the subtag hit by the categorization model, such as number, hit tag name, and score. Note: this field may return null, indicating that no valid values can be obtained. |
LibDetail
Returns the details of the custom library/blocklist/allowlist
Used by actions: ImageModeration.
| Name | Type | Description |
|---|---|---|
| Id | Integer | This field is used to return the ID of the recognized object for easier recognition and distinction. |
| LibId | String | This field is valid only when Label is Custom (custom keyword). It is used to return the ID of the custom library for easier custom library management and configuration. |
| LibName | String | This field is valid only when Label is Custom (custom keyword). It is used to return the name of the custom library for easier custom library management and configuration.Note: this field may return null, indicating that no valid values can be obtained. |
| ImageId | String | This field is used to return the ID of the recognized image object for easier file management. |
| Label | String | This field is used to return the maliciousness tag in the detection result. Returned values: Normal: normal; Porn: pornographic; Abuse: abusive; Ad: advertising; Custom: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content. |
| Tag | String | This field is used to return other custom tags to meet the needs in your customized scenarios. It can be skipped if you have no custom needs. Note: this field may return null, indicating that no valid values can be obtained. |
| Score | Integer | This field is used to return the hit score of the model. Value range: 0–100; for example, Porn 99 indicates that the hit score of the porn tag for the recognized content is 99. |
LibResult
Returns the detailed result of the comparison with the blocklist/allowlist
Used by actions: ImageModeration.
| Name | Type | Description |
|---|---|---|
| Scene | String | This field indicates the scenario recognition result of the model. Default value: Similar. |
| Suggestion | String | This field is used to return the operation suggestion. When you get the determination result, the returned value indicates the operation suggested by the system. We recommend you handle different types of violations and suggestions according to your business needs. Returned values: Block, Review, Pass. |
| Label | String | This field is used to return the maliciousness tag in the detection result. Returned values: Normal: normal; Porn: pornographic; Abuse: abusive; Ad: advertising; Custom: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content. |
| SubLabel | String | This field is used to return the detection result for a subtag under the maliciousness tag, such as Porn-SexBehavior. Note: this field may return null, indicating that no valid values can be obtained. |
| Score | Integer | This field is used to return the recognition score of the image search model. Value range: 0–100. It indicates the score for the similarity between the moderated image and the samples in the library. A higher score indicates that the content is more likely to hit a sample in the library of similar images. |
| Details | Array of LibDetail | This field is used to return the detailed result of the comparison with the blocklist/allowlist, such as number, library name, and maliciousness tag. For more information on the returned value, see the description of the LibDetail data structure. Note: this field may return null, indicating that no valid values can be obtained. |
Location
Coordinate
Used by actions: ImageModeration.
| Name | Type | Description |
|---|---|---|
| X | Float | This parameter is used to return the pixel position of the abscissa (X) of the top-left corner of the detection frame. It can be combined with other parameters to uniquely determine the size and position of the detection frame. |
| Y | Float | This parameter is used to return the pixel position of the ordinate of the top-left corner (Y) of the detection frame. It can be combined with other parameters to uniquely determine the size and position of the detection frame. |
| Width | Float | This parameter is used to return the width of the detection frame (the length starting from the top-left corner and extending to the right on the X axis). It can be combined with other parameters to uniquely determine the size and position of the detection frame. |
| Height | Float | This parameter is used to return the height of the detection frame (the length starting from the top-left corner and extending down the Y axis). It can be combined with other parameters to uniquely determine the size and position of the detection frame. |
| Rotate | Float | This parameter is used to return the rotation angle of the detection frame. Valid values: 0–360 (degrees), and the direction is counterclockwise rotation. This parameter can be combined with the X and Y coordinate parameters to uniquely determine the specific position of the detection frame. |
ObjectDetail
Object detection result details. When the detection scenario is an object, advertising logo, or QR code, it represents the tag name, tag value, tag score, and position information of the model detection frame.
Used by actions: ImageModeration.
| Name | Type | Description |
|---|---|---|
| Id | Integer | This parameter is used to return the ID of the recognized object for easier recognition and distinction. |
| Name | String | This parameter is used to return the hit object tag. |
| Value | String | This parameter is used to return the value or content of the object tag; for example, when the tag is QR code (QrCode), this field will be the URL of the recognized QR code. |
| Score | Integer | This parameter is used to return the hit score of the object tag. Valid values: 0–100; for example, QrCode 99 indicates that it is highly likely that the recognized content will hit the QR code tag. |
| Location | Location | This field is used to return the coordinate position (X and Y coordinates of the top-left corner, length, width, and rotation angle) of the object detection frame for quick location of the object information. |
| SubLabel | String | This parameter is used to return the hit object subtag. |
ObjectResult
Returns object detection result details
Used by actions: ImageModeration.
| Name | Type | Description |
|---|---|---|
| Scene | String | This field is used to return the recognized object scenario result, such as QR code, logo, and image OCR. |
| Suggestion | String | This field is used to return the operation suggestion for the current maliciousness tag. When you get the determination result, the returned value indicates the operation suggested by the system. We recommend you handle different types of violations and suggestions according to your business needs. Returned values: Block, Review, Pass. |
| Label | String | This field is used to return the maliciousness tag in the detection result, which represents the moderation result suggested by the model. We recommend you handle different types of violations and suggestions according to your business needs. Returned values: Normal: normal; Porn: pornographic; Abuse: abusive; Ad: advertising; Custom: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content. |
| SubLabel | String | This field is used to return the detection result for a subtag under the current maliciousness tag, such as Porn-SexBehavior. |
| Score | Integer | This field is used to return the hit score of a subtag under the current maliciousness tag. Value range: 0–100; for example, Porn-SexBehavior 99 indicates that the hit score of the Porn-SexBehavior tag for the recognized content is 99. |
| Names | Array of String | This field is used to return the name of the recognized object. Note: this field may return null, indicating that no valid values can be obtained. |
| Details | Array of ObjectDetail | This field is used to return the details of the recognized object, such as number, hit tag name, and position coordinates. For more information on the returned value, see the description of the ObjectDetail data structure. Note: this field may return null, indicating that no valid values can be obtained. |
OcrResult
Returns OCR detection result details
Used by actions: ImageModeration.
| Name | Type | Description |
|---|---|---|
| Scene | String | This field indicates the recognition scenario. Default value: OCR (image OCR). |
| Suggestion | String | This field is used to return the operation suggestion for the maliciousness tag with the highest priority. When you get the determination result, the returned value indicates the operation suggested by the system. We recommend you handle different types of violations and suggestions according to your business needs. Returned values: Block, Review, Pass. |
| Label | String | This field is used to return the maliciousness tag with the highest priority in the OCR detection result, which represents the moderation result suggested by the model. We recommend you handle different types of violations and suggestions according to your business needs. Returned values: Normal: normal; Porn: pornographic; Abuse: abusive; Ad: advertising; Custom: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content. |
| SubLabel | String | This field is used to return the detection result for a subtag under the current tag (Label), such as Porn-SexBehavior. |
| Score | Integer | This field is used to return the confidence under the current tag (Label). Value range: 0 (the lowest confidence)–100 (the highest confidence), where a higher value indicates that the text is more likely to fall into the category of the current returned tag; for example, Porn 99 indicates that the text is highly likely to be pornographic, while Porn 0 indicates that the text is not pornographic. |
| Details | Array of OcrTextDetail | This field is used to return the details of the OCR recognition result, such as text content, tag, and recognition frame position. Note: this field may return null, indicating that no valid values can be obtained. |
| Text | String | This field is used to return the text information recognized by OCR. |
OcrTextDetail
This field is used to return the OCR text result details. More text in the image may increase the time it takes the API to return the result.
Used by actions: ImageModeration.
| Name | Type | Description |
|---|---|---|
| Text | String | This field is used to return the text content recognized by OCR. Note: OCR can recognize text of up to 5,000 bytes. |
| Label | String | This field is used to return the maliciousness tag in the detection result. Returned values: Normal: normal; Porn: pornographic; Abuse: abusive; Ad: advertising; Custom: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content. |
| LibId | String | This field is valid only when Label is Custom (custom keyword). It is used to return the ID of the custom library for easier custom library management and configuration. |
| LibName | String | This field is valid only when Label is Custom (custom keyword). It is used to return the name of the custom library for easier custom library management and configuration. |
| Keywords | Array of String | This parameter is used to return the hit keyword under the current tag (label). |
| Score | Integer | This parameter is used to return the model hit score of the current maliciousness tag. Value range: 0–100, where a higher value indicates that the current scenario agrees more with the scenario represented by the maliciousness tag. |
| Location | Location | This parameter is used to return the position (X and Y coordinates of the top-left corner, length, width, and rotation angle) of the OCR detection frame in the image for quick location of the recognized text. |
| Rate | Integer | This parameter is used to return the confidence of the text OCR result. Valid values: 0 (the lowest confidence)–100 (the highest confidence), where a higher value indicates that it is more likely that the image contains the recognized text; for example, Hello 99 indicates that it is highly likely that the text in the OCR recognition frame is "Hello". |
| SubLabel | String | This field is used to return the maliciousness subtag that corresponds to the detection result. |
RecognitionResult
Label of the identification moderation result
Used by actions: ImageModeration.
| Name | Type | Description |
|---|---|---|
| Label | String | Value: SceneNote: This field may return null, indicating that no valid values can be obtained. |
| Tags | Array of RecognitionTag | Hit tags under the LabelNote: This field may return null, indicating that no valid values can be obtained. |
RecognitionTag
Recognition tag information
Used by actions: ImageModeration.
| Name | Type | Description |
|---|---|---|
| Name | String | Tag name Note: This field may return null, indicating that no valid values can be obtained. |
| Score | Integer | Confidence score. Value: 1 to 100. Note: This field may return null, indicating that no valid values can be obtained. |
| Location | Location | Location information. It returns 0 if there is not location information. Note: This field may return null, indicating that no valid values can be obtained. |
User
Indicates the information of the business user's account
Used by actions: ImageModeration.
| Name | Type | Required | Description |
|---|---|---|---|
| UserId | String | No | This field indicates the business user ID. After it is specified, the system can optimize the moderation result according to the violation history to facilitate determination when a suspicious violation risk exists. |
| Nickname | String | No | This field indicates the nickname of the business user's account. |
| AccountType | String | No | This field indicates the account type of the business user ID. This field can be used together with the ID parameter (UserId) to uniquely identify the account. |
| Gender | Integer | No | This field indicates the gender of the business user's account. Valid values: 0 (default value): unknown; 1 (male); 2 (female). |
| Age | Integer | No | This field indicates the age of the business user's account. Valid values: integers between 0 (default value, which indicates unknown) and custom age limit. |
| Level | Integer | No | This field indicates the level of the business user's account. Valid values: 0 (default value): unknown; 1: low level; 2: medium level; 3: high level. Currently, the level is not customizable. |
| Phone | String | No | This field indicates the mobile number of the business user's account. It supports recording mobile numbers across the world. Note: you need to use a consistent mobile number format, such as area code format (086/+86). |
| Desc | String | No | This field indicates the profile of the business user. It can contain up to 5,000 letters and special symbols. |
| HeadUrl | String | No | This field indicates the access URL of the business user's profile photo in PNG, JPG, JPEG, BMP, GIF, or WEBP format. Note: the profile photo cannot exceed 5 MB in size. A resolution of 256x256 or higher is recommended. The image download time should be limited to 3 seconds; otherwise, a download timeout will be returned. |
Yes
No
Was this page helpful?