接口调用

创思无界2024-11-07 12:30:52

接口描述

本接口用于提交文本内容进行智能审核任务。使用前往登录控制台,并调整好对应的业务配置。

接口功能说明:

该接口为收费接口,计费方式敬请参见,文本内容安全定价。

接口调用说明:

  • 文本内容大小支持:文本原文长度不能超过 unicode 编码长度 10000 个字符;
  • 文本审核语言支持:目前支持中文、英文、阿拉伯数字的检测;
  • 默认接口请求频率限制:1000 次/秒,超过该频率限制则接口会报错。

请求地址

https://chuangsi.model.svipc.cn
  • 接口请求地址
/api/content/safety

请求方式

POST

请求头

参考公共请求参数部分即可

输入参数

在 HTTP Body 中,采用 Json 格式,具体参数如下:

{
  "content": "要检测的文本内容",
  "strategyKey": "597231130126757"
}
  • 请求参数说明:
    参数名称必选类型说明
    contentString要检测的文本内容
    strategyKeyString登录控制台在左侧 策略管理->策略列表中查看

输出参数

  • 输出参数示例
点击查看
{
  "requestId": 654585178447941,
  "strategyKey": "597231130126757",
  "message": "调用成功",
  "code": 0,
  "score": 0,
  "suggestion": "pass",
  "details": [
    {
      "labelName": "涉政",
      "labelKey": "Politics",
      "score": 0,
      "suggestion": "pass",
      "modelScore": 0,
      "keywords": [],
      "hitInfo": []
    },
    {
      "labelName": "违法",
      "labelKey": "Illegal",
      "score": 0,
      "suggestion": "pass",
      "modelScore": 0,
      "keywords": [],
      "hitInfo": []
    },
    {
      "labelName": "色情",
      "labelKey": "Porn",
      "score": 0,
      "suggestion": "pass",
      "modelScore": 0,
      "keywords": [],
      "hitInfo": []
    },
    {
      "labelName": "价值观",
      "labelKey": "Value",
      "score": 0,
      "suggestion": "pass",
      "modelScore": 0,
      "keywords": [],
      "hitInfo": []
    },
    {
      "labelName": "暴恐",
      "labelKey": "Terrorism",
      "score": 0,
      "suggestion": "pass",
      "modelScore": 0,
      "keywords": [],
      "hitInfo": []
    },
    {
      "labelName": "广告",
      "labelKey": "Advertisement",
      "score": 0,
      "suggestion": "pass",
      "modelScore": 0,
      "keywords": [],
      "hitInfo": []
    },
    {
      "labelName": "辱骂",
      "labelKey": "Abuse",
      "score": 0,
      "suggestion": "pass",
      "modelScore": 0,
      "keywords": [],
      "hitInfo": []
    },
    {
      "labelName": "低俗",
      "labelKey": "Vulgar",
      "suggestion": "pass",
      "keywords": [],
      "hitInfo": []
    },
    {
      "labelName": "谣言标题党",
      "labelKey": "rumor",
      "score": 0,
      "suggestion": "pass",
      "modelScore": 0,
      "keywords": [],
      "hitInfo": []
    }
  ]
}
  • 输出参数说明:

    参数名称类型说明
    requestIdInteger唯一请求 ID,由服务端生成,每次请求都会返回
    strategyKeyString策略标识。 登录控制台在左侧 策略管理->策略列表中查看
    codeInteger接口调用结果码,0 表示成功,非 0 表示失败
    messageString接口调用结果
    labelKeyString该字段用于返回检测结果(details)中所对应的优先级最高的恶意标签,表示模型推荐的审核结果,建议您按照业务所需,对不同违规类型与建议值进行处理。
    注意:此字段可能返回 null,表示取不到有效值。
    返回值:Normal:正常,Porn:色情,Abuse:谩骂,Advertisement:广告;以及其他令人反感、不安全或不适宜的内容类型
    示例值:Abuse
    labelNameString标签中文名称。注意:此字段可能返回 null,表示取不到有效值。
    scoreInteger该字段用于返回当前标签(Label)下的置信度,取值范围:0(置信度最低)-100(置信度最高 ),越高代表输入内容越有可能属于当前返回的标签;如:色情 99,则表明该文本非常有可能属于色情内容;色情 0,则表明该文本不属于色情内容
    示例值:99
    suggestionString该字段用于返回后续操作建议。当您获取到判定结果后,返回值表示系统推荐的后续操作;建议您按照业务所需,对不同违规类型与建议值进行处理。返回值:block:建议屏蔽,review :建议人工复审,pass:建议通过
    示例值:block
    hitInfoObject命中信息,如果没有命中则为空。用于表示当前结果的命中详情
    detailsArray返回风险库审核的详细结果,返回值信息可参阅对应数据结构(detail)的详细描述
  • details 参数说明:

    参数名称类型说明
    labelKeyString该字段用于返回检测结果(details)中所对应的优先级最高的恶意标签,表示模型推荐的审核结果,建议您按照业务所需,对不同违规类型与建议值进行处理。
    注意:此字段可能返回 null,表示取不到有效值。
    返回值:Normal:正常,Porn:色情,Abuse:谩骂,Advertisement:广告;以及其他令人反感、不安全或不适宜的内容类型
    示例值:Abuse
    labelNameString标签中文名称。注意:此字段可能返回 null,表示取不到有效值。
    scoreInteger该字段用于返回当前标签(Label)下的置信度,取值范围:0(置信度最低)-100(置信度最高 ),越高代表输入内容越有可能属于当前返回的标签;如:色情 99,则表明该文本非常有可能属于色情内容;色情 0,则表明该文本不属于色情内容
    示例值:99
    suggestionString该字段用于返回后续操作建议。当您获取到判定结果后,返回值表示系统推荐的后续操作;建议您按照业务所需,对不同违规类型与建议值进行处理。返回值:block:建议屏蔽,review :建议人工复审,pass:建议通过
    示例值:block
    keywordsArray该字段用于返回命中标签(label)的敏感词或关键词。注意:该字段可能返回 null,表示取不到有效值。
    hitInfoObject命中信息,如果没有命中则为空。用于表示当前结果的命中详情
  • hitInfo 参数说明:

    参数名称类型说明
    typeString命中类型,返回值 keyword:关键词,model:模型
    infoArray命中信息,如果 type 为 keyword ,该字段的值为命中的关键词列表。如果 type 为 model ,该字段的值为命中的模型分

最后更新时间 2025/1/24 18:29:16