文本违规检测
文本违规检测用于检测文本是否违规,帮助用户提高审核效率,降低安全风险。本文介绍如何使用文本违规检测功能。
前提条件
已通过智能媒体管理控制台创建项目。具体操作,请参见创建项目。
说明
- 您也可以调用API接口创建项目。具体操作,请参见CreateProject - 创建项目。
- 您可以调用ListProjects - 列出所有项目信息的列表接口列出指定地域下已创建的所有项目信息。
使用方法
调用DetectTextAnomaly - 文本合规检测接口检测文本是否包含违规信息。
如下以IMM项目名称为test-project,文本内容为待检测文本为例,介绍文本的违规检测过程。
请求示例
{
"ProjectName": "test-project",
"Content": "待检测文本"
}
返回示例
{
"Suggestion": "pass",
"RequestId": "FE85471D-28CD-0CA0-988B-2BB139725D04"
}
说明
Suggestion为block
表示文本中包含违规内容,Suggestion为pass
表示文本中没有违规内容。
示例代码
以Python SDK为例,文本违规检测的完整示例代码如下。
# -*- coding: utf-8 -*-
import os
from alibabacloud_imm20200930.client import Client as imm20200930Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_imm20200930 import models as imm_20200930_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient
class Sample:
def __init__(self):
pass
@staticmethod
def create_client(
access_key_id: str,
access_key_secret: str,
) -> imm20200930Client:
"""
使用AccessKey ID&AccessKey Secret初始化账号Client。
@param access_key_id:
@param access_key_secret:
@return: Client
@throws Exception
"""
config = open_api_models.Config(
access_key_id=access_key_id,
access_key_secret=access_key_secret,
)
# 填写访问的域名。
config.endpoint = f'imm.cn-beijing.aliyuncs.com'
return imm20200930Client(config)
@staticmethod
def main() -> None:
# 阿里云账号AccessKey拥有所有API的访问权限,建议您使用RAM用户进行API访问或日常运维。
# 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下所有资源的安全。
# 本示例通过从环境变量中读取AccessKey,来实现API访问的身份验证。如何配置环境变量,请参见https://help.aliyun.com/document_detail/2361894.html。
imm_access_key_id = os.getenv("AccessKeyId")
imm_access_key_secret = os.getenv("AccessKeySecret")
# 初始化IMM客户端。
client = Sample.create_client(imm_access_key_id, imm_access_key_secret)
# 填写项目名称。
project_name = 'test-project'
# 填写待检测文本内容。
content = '待检测文本'
# 构造文本违规检测请求。
detect_text_anomaly_request = imm_20200930_models.DetectTextAnomalyRequest(
project_name=project_name,
content=content
)
runtime = util_models.RuntimeOptions()
try:
# 发起请求,打印API的返回值。
res = client.detect_text_anomaly_with_options(detect_text_anomaly_request, runtime)
print(res.body.to_map())
except Exception as error:
# 如有需要,请打印错误信息。
UtilClient.assert_as_string(error.message)
print(error.message)
if __name__ == '__main__':
Sample.main()