Data returned by the ImAudit operation

更新时间:
复制 MD 格式

This topic describes the data returned by ImAudit.

Data returned for image moderation

ParameterTypeExampleDescription
codeInteger200The returned HTTP status code.
msgStringOKThe message that is returned for the request.
dataIdStringuuid-1234-1234-1234The ID of the moderated object.
Note If you specify the dataId parameter in the request, the dataId parameter is returned in the response.
taskIdStringimg4wlJcb7p4wH4lAP3111111-123456The ID of the moderation task.
urlStringhttp://xxx.xxx.xxx/xxx.jpgThe URL of the moderation object.
extrasJSONObject{"hitLibInfo":[{"context":"Haokan","libCode":"2144002","libName":"Text pattern library a"}]}Additional information about the image. If the scene parameter is ad, the extras parameter can return the following content:

hitLibInfo: the information about the custom text library that the detected text in the moderated image hits. The value of this parameter is an array. For more information about the structure, see hitLibInfo.

resultsJSONArrayThe returned results. If the call is successful, the returned results contain one or more elements. Each element is a structure. For more information about the structure, see result.
Table 2 result
ParameterTypeExampleDescription
sceneStringpornThe image detection scenario. Valid values:
  • porn: pornography
  • terrorism: terrorist content
  • ad: ad violation
  • qrcode: QR code
  • live: undesirable scene
  • logo: logo
labelStringsexyThe category of the detection results. Valid values vary based on the specified moderation scenario.
  • If the scene parameter is porn, the valid values are:
    • normal: no pornographic content
    • sexy: lewd or obscene content
    • porn: pornographic content
  • If the scene parameter is terrorism, the valid values are:
    • normal: no terrorist content
    • bloody: bloody content
    • explosion: explosions and smoke
    • outfit: special costume
    • logo: special logo
    • weapon: weapon
    • politics: political content
    • violence: violence
    • crowd: crowd
    • parade: parade
    • carcrash: car accident
    • flag: flag
    • location: landmark
    • others: other content
  • If the scene parameter is ad, the valid values are:
    • normal: no ad content
    • ad: other ads
    • politics: political content in text
    • porn: pornographic content in text
    • abuse: abuse in text
    • terrorism: terrorist content in text
    • contraband: prohibited content in text
    • spam: junk content in text
    • npx: illegal ad
    • qrcode: QR code
    • programCode: mini program code
  • If the scene parameter is qrcode, the valid values are:
    • normal: no QR code content
    • qrcode: QR code
    • programCode: mini program code
  • If the scene parameter is live, the valid values are:
    • normal: no live content
    • meaningless: no content in the image, such as black or white screen
    • PIP: picture-in-picture
    • smoking: smoking
    • drivelive: live streaming in a running vehicle
  • If the parameter is logo, the valid values are:
    • normal: no logo content
    • TV: controlled logo
    • trademark: trademark
sublabelStringpornIf the scene parameter is set to porn or terrorism, the subcategory of the moderation result can be returned.
suggestionStringblockThe suggested course of action. Valid values:
  • pass: The moderation object does not require further actions.
  • review: The moderation object contains suspected violations and requires human review.
  • block: The moderation object contains violations. We recommend that you delete or block the object.
rateFloat91.54The score of the confidence level. Valid values: 0 to 100. A greater value indicates a higher confidence level. If a value of pass is returned for the suggestion parameter, a higher confidence level indicates a higher probability that the content is normal. If a value of review or block is returned for the suggestion parameter, a lower confidence level indicates a higher probability that the content contains violations.
Important This score is only for reference. We strongly recommend that you do not use this score in your business. We recommend that you use the values that are returned for the suggestion, label, and sublabel parameters to determine whether the content contains violations. The sublabel parameter is returned by some operations.
framesJSONArrayIf the temporary access URL of the image is too long, a truncated temporary access URL is returned for each frame. For more information about the structure, see frame.
hintWordsInfoJSONArrayThe information about the text that is detected in the moderated image. Detected text include ads or words that match high-risk words. For more information about the structure, see hintWordsInfo.
Note This parameter is applicable only to ad violation detection.
Example:
"hintWordsInfo":[{"context":"Sensitive words"}]
qrcodeDataStringArray{"http://example.com/01ZZOliO"}The information about content hidden behind QR codes in the moderated image.
Note This parameter is applicable only to QR code detection.
qrcodeLocationsJSONArrayThe coordinate information about the detected QR code in the moderated image. For more information about the structure, see qrcodeLocation.
programCodeDataJSONArrayThe coordinate information about the detected mini program code in the moderated image. For more information about the structure, see programCodeData.
Note This parameter is applicable only to mini program code detection. Make sure that mini program code detection is enabled.
logoDataJSONArrayThe information about the detected logo in the moderated image. For more information about the structure, see logoData.
Note This parameter is applicable only to logo detection.
sfaceDataJSONArrayThe information about the detected terrorist content in the moderated image. For more information about the structure, see sfaceData.
Note This parameter is applicable only to terrorist content detection.
ocrDataStringArrayThe information about the detected complete text in the moderated image.
Table 3 frame
ParameterTypeExampleDescription
rateFloat89.85The score of the confidence level. Valid values: 0 to 100. A higher confidence level indicates higher reliability of the moderation result. We recommend that you do not use this score in your business.
urlStringhttp://example.com/test-01.jpgThe temporary access URL of the truncated frame. The URL is valid for 5 minutes.
Table 4 programCodeData
ParameterTypeExampleDescription
xFloat11.0The distance between the upper-left corner of the mini program code area and the y-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixels.
yFloat0.0The distance between the upper-left corner of the mini program code area and the x-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixels.
wFloat402.0The width of the mini program code area. Unit: pixels.
hFloat413.0The height of the mini program code area. Unit: pixels.
Table 5 logoData
ParameterTypeExampleDescription
typeStringTVThe type of the detected logo. For example, a value of TV indicates the logo of a TV station.
nameStringHunan TVThe name of the detected logo.
xFloat140The distance between the upper-left corner of the logo area and the y-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixels.
yFloat68The distance between the upper-left corner of the logo area and the x-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixels.
wFloat106The width of the logo area. Unit: pixels.
hFloat106The height of the logo area. Unit: pixels.
Table 6 sfaceData
ParameterTypeExampleDescription
xFloat49The distance between the upper-left corner of the face area and the y-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixels.
yFloat39The distance between the upper-left corner of the face area and the x-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixels.
wFloat47The width of the face area. Unit: pixels.
hFloat121The height of the face area. Unit: pixels.
facesJSONArray[{"id":"AliFace_0001234","name":"Hit name","rate":91.54}]The information about the recognized face. The array contains the following parameters:
  • name: the name of the recognized face. The value is a string.
  • rate: the score of the confidence level. The value is a float point number. Valid values: 0 to 100. A greater value indicates a higher confidence level for facial recognition.
  • id: the ID of the recognized face. The value is a string.
Table 7 hitLibInfo
ParameterTypeExampleDescription
contextStringThe custom text that the detected text hits.
libCodeString123456The code of the library that contains the custom text hit by the detected text.
libNameStringabcThe name of the library that contains the custom text hit by the detected text.
Table 8 HintWordsInfo
ParameterTypeExampleDescription
contextStringThe label of the text that is detected.
Table 9 qrcodeLocation
ParameterTypeExampleDescription
xFloat11.0The distance between the upper-left corner of the QR code area and the y-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixels.
yFloat0.0The distance between the upper-left corner of the QR code area and the x-axis, with the upper-left corner of the image being the coordinate origin. Unit: pixels.
wFloat402.0The width of the QR code area. Unit: pixels.
hFloat413.0The height of the QR code area. Unit: pixels.
qrcodeStringhttp://xxxThe URL in the detected QR code.

Data returned for text moderation

ParameterTypeExampleDescription
codeInteger200The returned HTTP status code. For more information, see Error codes.
msgStringOKThe message that is returned for the request.
dataIdStringcfd33235-71a4-468b-8137-a5ffe323****The sequence number of the text.
taskIdStringtxt6HB8NQoEbU@5fosnj2xVEM-1t****The ID of the moderation task.
contentStringWe are a micro-lending company that provides same-day unsecured loans with secure, fast, convenient, and door-to-door services when you apply for a loan on your mobile phone. The content of the moderated text that you specify in the moderation request.
filteredContentStringWe are a **** company that provides same-day *** loans with secure, fast, convenient, and **** services when you apply for a loan on your mobile phone. The text that is returned if the original text hits terms in the custom term library, with the terms being replaced with asterisks (*).
resultsJSONArrayThe returned results. If the HTTP status code 200 is returned, the array in the returned results contains one or more elements. Each element is a structure. For more information about the structure, see result.
Table 2 result
ParameterTypeExampleDescription
sceneStringantispamThe moderation scenario.
suggestionStringblockThe suggested course of action. Valid values:
  • pass: The text is normal.
  • review: The text requires human review.
  • block: The text contains violations and can be deleted or blocked.
labelStringpornThe category of the moderation result. Valid values:
  • normal: normal content
  • spam: junk content
  • ad: ad
  • politics: political content
  • terrorism: terrorist content
  • abuse: abuse content
  • porn: pornographic content
  • flood: excessive junk content
  • contraband: prohibited content
  • meaningless: meaningless content
  • customized: custom content, such as a custom keyword
rateFloat99.91The score of the confidence level. Valid values: 0 to 100. A greater value indicates a higher confidence level. If a value of pass is returned for the suggestion parameter, a higher confidence level indicates a higher probability that the content is normal. If a value of review or block is returned for the suggestion parameter, a lower confidence level indicates a higher probability that the content contains violations.
Important This score is only for reference. We strongly recommend that you do not use this score in your business. We recommend that you use the values that are returned for the suggestion, label, and sublabel parameters to determine whether the content contains violations. The sublabel parameter is returned by some operations.
extrasJSONObject{"userId":"xxx"}The additional information. This is an extended parameter.
detailsJSONArrayThe details of the risky content that the moderated text hits. A text entry can hit multiple pieces of risky content. For more information about the structure of each piece of risky content, see detail.
Table 3 details
ParameterTypeExampleDescription
labelStringpornThe category of the risky content that the moderated text hits. Valid values:
  • spam: junk content
  • ad: ad
  • politics: political content
  • terrorism: terrorist content
  • abuse: abuse content
  • porn: pornographic content
  • flood: excessive junk content
  • contraband: prohibited content
  • meaningless: meaningless content
  • customized: custom content, such as a custom keyword
contextsJSONArrayThe context information of the risky content that the moderated text hits. For more information about the structure, see context.
Table 4 context
ParameterTypeExampleDescription
contextStringdoor-to-doorThe term that the moderated text hits. If the text hits a term, the term is returned. If the text hits the algorithmic model, this parameter is not returned.
positionsJSONArray{"startPos":1, "endPos":10}The position of the term that the moderated text hits in the original text.
libNameStringName of your custom text libraryThe name of the custom text library. This parameter is returned if the moderated text hits a term in the custom text library.
libCodeString123456The code of the custom text library. This parameter is returned if the moderated text hits a term in the custom text library.
ruleTypeStringipThe behavior rule. This parameter is returned if the moderated text hits the behavior rule. Valid values:
  • user_id
  • ip
  • umid
  • content
  • similar_content
  • imei
  • imsi