TextModerationPlus文本审核API参考-内容安全-阿里云

文本审核增强版升级PLUS服务，面向大语言模型的输入指令和生成文字分别提供审核服务，特定的模型输入指令支持检索标准回答，同时开放审核标签的开启和关闭功能。

接口说明

请确保在使用该接口前，已开通内容安全增强版服务且充分了解文本审核增强 PLUS 版产品的收费方式和价格。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-greenweb:TextModerationPlus

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Service	string	否	审核服务类型枚举值： chat_detection_pro : 私聊互动内容检测_专业版 llm_response_moderation : 大语言模型生成文字检测 llm_query_moderation : 大语言模型输入文字检测 aigc_moderation_byllm : AIGC 场景文本审核大模型服务 nickname_detection_pro : 用户昵称检测_专业版 comment_detection_pro : 公聊评论内容检测_专业版 ugc_moderation_byllm : UGC 场景文本审核大模型服务 ad_compliance_detection_pro : 广告法合规检测_专业版	ugc_moderation_byllm
ServiceParameters	string	否	审核服务需要的参数集。JSON 字符串格式	{ "content": "测试内容" }

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****
Code	integer	返回码。返回 200 代表成功。	200
Message	string	错误信息	OK
Data	object	审核结果数据。
Result	array<object>	结果
	array<object>	返回集合。
Label	string	标签	porn
Confidence	number	置信分值，0 到 100 分，保留到小数点后 2 位。	81.22
RiskWords	string	命中风险关键词	XXX
CustomizedHit	array<object>	自定义关键词命中
	object	自定义命中
LibName	string	库名称	测试词库
KeyWords	string	命中的关键词，逗号分隔	xxx
Description	string	标签描述	未检测出风险
RiskPositions	array<object>	风险词位置信息。
	object	风险词位置信息。
RiskWord	string	违规关键词。	词A
StartPos	integer	敏感词的开始位置。	4
EndPos	integer	敏感词的结束位置。	6
Advice	array<object>	建议
	object	代答内容
Answer	string	回答	XXX
HitLabel	string	命中标签	XXX
HitLibName	string	命中库名称	XXX
Score	number	分数。	1
RiskLevel	string	风险等级	high
DataId	string	检测对象对应的数据 ID。说明如果在检测请求参数中传入了 dataId，则此处返回对应的 dataId。	text1234
SensitiveResult	array<object>	敏感数据检测结果
	object	敏感数据检测结果
Label	string	标签。	1234
SensitiveLevel	string	敏感等级	S1
SensitiveData	array	敏感数据列表
	string	敏感数据	上海
Description	string	描述	省份
AttackResult	array<object>	提示词攻击检测结果
	object	提示词攻击检测结果
Label	string	标签	safe
Confidence	number	置信分	0
AttackLevel	string	攻击等级	none
Description	string	描述	safe
SensitiveLevel	string	敏感等级	S0
AttackLevel	string	攻击等级	none
ManualTaskId	string	人审任务 ID	xxxxx-xxxxx
DetectedLanguage	string	识别语种	en
TranslatedContent	string	翻译后内容	hello
AccountId	string	客户入参 AccountId	123456789
Ext	object	文本辅助参考信息。
LlmContent	object	大模型输出内容
OutputText	string	输出内容。	正常。文本中无风险内容。

示例

正常返回示例

JSON格式

{
  "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****",
  "Code": 200,
  "Message": "OK",
  "Data": {
    "Result": [
      {
        "Label": "porn",
        "Confidence": 81.22,
        "RiskWords": "XXX",
        "CustomizedHit": [
          {
            "LibName": "测试词库",
            "KeyWords": "xxx"
          }
        ],
        "Description": "未检测出风险",
        "RiskPositions": [
          {
            "RiskWord": "词A",
            "StartPos": 4,
            "EndPos": 6
          }
        ]
      }
    ],
    "Advice": [
      {
        "Answer": "XXX",
        "HitLabel": "XXX",
        "HitLibName": "XXX"
      }
    ],
    "Score": 1,
    "RiskLevel": "high",
    "DataId": "text1234",
    "SensitiveResult": [
      {
        "Label": "1234",
        "SensitiveLevel": "S1",
        "SensitiveData": [
          "上海"
        ],
        "Description": "省份"
      }
    ],
    "AttackResult": [
      {
        "Label": "safe",
        "Confidence": 0,
        "AttackLevel": "none",
        "Description": "safe"
      }
    ],
    "SensitiveLevel": "S0",
    "AttackLevel": "none",
    "ManualTaskId": "xxxxx-xxxxx",
    "DetectedLanguage": "en",
    "TranslatedContent": "hello",
    "AccountId": "123456789",
    "Ext": {
      "LlmContent": {
        "OutputText": "正常。文本中无风险内容。"
      }
    }
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。