You need to enable JavaScript to run this app.
导航

敏感词校验接口

最近更新时间2024.01.11 10:56:25

首次发布时间2024.01.11 10:56:25

本文档介绍内容洞察平台对订阅敏感词校验接口的调用方式。

概述

内容洞察提供了敏感词预览接口用于检测关键词是否命中敏感词,每天每个账号限制1万次请求,第二天零点会直接刷新配额。要求如下:

  1. 每个请求限制词个数<=100,若超过100,会返回报错

  2. 每个词的长度不能超过10。若有超过10的词,将不能检测这个词,并且把这个词放入invalid_words列表返回,其他长度不超过10的词还会检测

返回所有命中的敏感词(hit_words),以列表形式展示。命中的词将不能配置在以上接口的任务词中,否则将无法任务创建成功。

请求接口

基本信息

名称内容
接口地址/openapi/biz_sub/sensitive_words_check
请求方式GET
是否需要鉴权

请求参数

Header请求参数

字段类型是否必填说明
X-Insight-Biz-Namestring业务名称 -> 即火山账号ID
X-Insight-Access-TokenstringAPI访问凭证access_token
Content-Typestring'application/json'

Body请求参数

字段类型是否必填说明
wordslist词的列表

返回参数

字段类型说明
statusint0为成功
messagestring返回错误信息
datahit_wordslist返回命中的敏感词
invalid_wordslist不能检测的词, 该接口仅支持长度10以内的关键词检测

调用示例

请求示例

REQ:
GET  /openapi/biz_sub/sensitive_words_check

header:
X-Insight-Biz-Name: $biz_name
X-Insight-Access-Token: $token
Content-Type: 'application/json'

Body:
{
    "words": ["测试", "火山", "台湾", "xxx我很敏感xxx", "测试这个词超过长度10不能检测"]
}

返回示例

RESP:
{
    "status": 0,
    "message": "succeed",
    "data": {
        "hit_words": ["xxx我很敏感xxx"], // 若无命中则返回空list
        "invalid_words": ["测试这个词超过长度10不能检测"] // 不能检测的词, 该接口仅支持长度10以内的关键词检测
    }
}