本文档为您介绍文本内容安全ScanText的语法及示例。

功能描述

ScanText结合行为、内容,采用多维度、多模型、多检测手段,识别文本中的垃圾内容,规避色情、广告、灌水、渉政、辱骂等内容风险。

支持检测的场景包括:文字垃圾内容识别、文字广告内容识别、文字涉政内容识别、文字暴恐内容识别、文字辱骂内容识别、文字鉴黄内容识别、文字灌水内容识别、文字违禁内容识别。

在提交检测任务时,您需要指定Labels参数,并且支持组合使用,即可对同一段文字进行多种风险检测。如果接口返回结果为空,表示未检测到Labels中的风险点。

说明 在同时检测多个Label的情况下,将按照每个场景的文本检测数量×每个场景的单价进行累计计费。

前提条件

请确保您已开通内容安全服务,详情请参见服务开通

限制说明

该接口每次可以检测的文本字符数最大为10000。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ScanText

要执行的操作。取值:ScanText。

Labels.N.Label String abuse

指定图片检测的应用场景,可选值包括:

  • spam:文字垃圾内容识别
  • politics:文字涉政内容识别
  • abuse:文字辱骂内容识别
  • terrorism:文字涉恐内容识别
  • porn:文字鉴黄内容识别
  • flood:文字灌水内容识别
  • contraband:文字违禁内容识别
  • ad:文字广告内容识别
说明 支持多场景(Labels)一起检测,例如对一段文字同时进行鉴黄和涉恐识别,此时也会按照两个场景计费。
Tasks.N.Content String 某某是傻逼

指定检测的对象,JSON数组中的每个元素是一个文字检测任务结构体。

返回数据

名称 类型 示例值 描述
Data Struct

返回的结果数据内容。

Elements Array

检测结果的各个子元素。

Results Array

单张图片的检测结果。

Details Array

图片的检测结果。

Contexts Array

命中该风险的信息。

Context String 是傻逼

检测文本命中的风险内容。

Label String abuse

命中风险文本的分类。

Label String abuse

检测结果的分类。

Rate Float 99.91

结果为该分类的概率,取值范围为[0.00-100.00]。值越高,表示越有可能属于该分类。

Suggestion String block

建议您执行的操作,取值包括:

  • pass:文本正常。
  • review:需要人工审核。
  • block:文本违规,可以直接删除或者做限制处理。
TaskId String txt6Vh5Fv0DAFy5hgdVRt3pqf-1s82jj

任务ID。

RequestId String 918A119D-752A-4F07-A1CC-550BA21F5FCA

请求ID。

示例

请求示例

http(s)://imageaudit.cn-shanghai.aliyuncs.com/?Action=ScanText
&Labels.1.Label=abuse
&Tasks.1.Content=某某是傻逼
&<公共请求参数>

正常返回示例

XML 格式

<Data>
    <Elements>
        <TaskId>txt31rJ2il1rhZ5gA1JZgtz2Z-1s9$k0</TaskId>
        <Results>
            <Details>
                <Contexts>
                    <Context>是傻逼</Context>
                </Contexts>
                <Label>abuse</Label>
            </Details>
            <Suggestion>block</Suggestion>
            <Label>abuse</Label>
            <Rate>99.91</Rate>
        </Results>
    </Elements>
</Data>
<RequestId>C7CD87E3-57A5-4E2F-8A44-809F3554692C</RequestId>

JSON 格式

{
	"Data": {
		"Elements": [{
			"TaskId": "txt31rJ2il1rhZ5gA1JZgtz2Z-1s9$k0",
			"Results": [{
				"Details": [{
					"Contexts": [{
						"Context": "是傻逼"
					}],
					"Label": "abuse"
				}],
				"Suggestion": "block",
				"Label": "abuse",
				"Rate": 99.91
			}]
		}]
	},
	"RequestId": "C7CD87E3-57A5-4E2F-8A44-809F3554692C"
}

错误码

关于文本内容安全的错误码,详情请参见常见错误码

SDK参考

单击SDK简介查看SDK信息。