文本内容安全ScanText的语法及示例_视觉智能开放平台(VIAPI)-阿里云帮助中心

功能描述

文本内容安全结合行为、内容，采用多维度、多模型、多检测手段，识别文本中的敏感信息，规避敏感人物姓名、敏感事件描述、敏感言论等内容风险。

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

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

说明

在同时检测多个Task的情况下，将按照Task的个数进行累计计费。
您可以进入在线咨询获取在线人工帮助。
阿里云视觉智能开放平台视觉AI能力API接入、接口使用或问题咨询等，请通过钉钉群（23109592）加入阿里云视觉智能开放平台咨询群联系我们。

接入指引

1. 注册阿里云账号：打开阿里云官网，在阿里云官网右上角，单击立即注册，按照操作提示完成账号注册。

2. 开通能力：请确保您已开通内容审核服务，若未开通服务请立即开通。

3. 创建AccessKey：请确保您已创建AccessKey，如果您使用的是子账号AccessKey，您需要给子账号赋予AliyunVIAPIFullAccess权限，具体操作，请参见RAM授权。

4. 在线调试（可选）：您可以通过OpenAPI Explorer在线调试能力，查看完整的调用示例代码及SDK依赖信息，也可以下载完整的工程。

5. 开发接入步骤：

在SDK总览中选择您要接入使用的SDK语言。
在对应语言的SDK文档中找到AI类目为内容审核（imageaudit）的SDK包进行安装。
参考文档中提供的示例代码进行适当修改后调用。

6. 示例代码：该能力常用语言的示例代码，请参见文本内容安全示例代码。

7. 客户端直接调用：该能力常用的客户端调用方式包括以下几种。

限制说明

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

计费说明

关于文本内容安全的计费方式及报价，请参见计费介绍。

说明下方调试接口为付费接口，如需免费体验调试请前往体验中心，对应体验入口如下表所示。

能力	体验中心
文字垃圾内容识别	免费调试入口
文字广告内容识别	免费调试入口
文字敏感内容识别	免费调试入口
文字暴恐内容识别	免费调试入口
文字辱骂内容识别	免费调试入口
文字鉴黄内容识别	免费调试入口
文字灌水内容识别	免费调试入口
文字违禁内容识别	免费调试入口

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ScanText	系统规定参数。取值：ScanText。
Tasks.N.Content	String	是	维修管道，联系weixin	指定检测的对象，JSON数组中的每个元素是一个文字检测任务结构体。说明 N个Task会折算为N次调用进行计费。算法识别效果问题请通过钉钉群（23109592）加入阿里云视觉智能开放平台咨询群联系我们。
Labels.N.Label	String	是	ad	指定文本检测的应用场景，可选值包括： spam：文字垃圾内容识别 politics：文字敏感内容识别 abuse：文字辱骂内容识别 terrorism：文字暴恐内容识别 porn：文字鉴黄内容识别 flood：文字灌水内容识别 contraband：文字违禁内容识别 ad：文字广告内容识别

返回数据

名称	类型	示例值	描述
RequestId	String	C7CD87E3-57A5-4E2F-8A44-809F3554692C	请求ID。
Data	Object		返回的结果数据内容。
Elements	Array of Element		检测结果的各个子元素。
TaskId	String	txt6Vh5Fv0DAFy5hgdVRt3pqf-1s82jj	任务ID。
Results	Array of Result		检测结果。如果返回为空，表示系统识别命中了其他Label，扩大Label重新发起请求。
Suggestion	String	block	建议您执行的操作，取值包括： pass：文本正常。 review：需要人工审核。 block：文本违规，可以直接删除或者做限制处理。
Label	String	ad	检测结果的分类。
Rate	Float	99.91	结果为该分类的概率，取值范围为`[0.00-100.00]`。值越高，表示越有可能属于该分类。
Details	Array of Detail		文本的检测结果。
Label	String	ad	命中风险文本的分类。
Contexts	Array of Context		命中该风险的信息。
Context	String	联系weixin	检测文本命中的风险内容。

SDK参考

阿里云视觉AI内容审核类目下的文本内容安全能力推荐使用SDK调用，支持多种编程语言，调用时请选择AI类目为内容审核（imageaudit）的SDK包，文件参数通过SDK调用可支持本地文件及任意URL，具体可参见SDK总览。

示例代码

该能力常用语言的示例代码，请参见文本内容安全示例代码。

示例

请求示例

http(s)://imageaudit.cn-shanghai.aliyuncs.com/?Action=ScanText      //更多关于访问域名（Endpoint）信息，请参见：https://help.aliyun.com/document_detail/143103.html
&Tasks=[{"Content":"维修管道，联系weixin"}]
&Labels=[{"Label":"ad"}]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ScanTextResponse>
    <RequestId>4FCBCC61-6264-56DE-9CF3-44C014F63B75</RequestId>
    <Data>
        <Elements>
            <TaskId>txt4OFqbn2s4WQ6kVA$dQGn9X-1vvHuZ</TaskId>
            <Results>
                <Suggestion>block</Suggestion>
                <Details>
                    <Label>ad</Label>
                    <Contexts>
                        <Context>联系weixin </Context>
                    </Contexts>
                </Details>
                <Rate>99.91</Rate>
                <Label>ad</Label>
            </Results>
        </Elements>
    </Data>
</ScanTextResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "4FCBCC61-6264-56DE-9CF3-44C014F63B75",
  "Data" : {
    "Elements" : {
      "TaskId" : "txt4OFqbn2s4WQ6kVA$dQGn9X-1vvHuZ",
      "Results" : {
        "Suggestion" : "block",
        "Details" : {
          "Label" : "ad",
          "Contexts" : {
            "Context" : "联系weixin"
          }
        },
        "Rate" : 99.91,
        "Label" : "ad"
      }
    }
  }
}

错误码

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

安全声明

请确保上传的图片或文件来源符合相应的法律法规。
通过体验调试上传的临时文件有效期为1小时，在24小时后会被系统自动清理删除。