本文提供了获取已添加的自定义文本库列表的具体接口及参数,旨在帮助您通过API接口自主管理您的文本库。您通过API接口管理的文本库可用于文本反垃圾检测,该方式与云盾内容控制台上的自定义文本库功能完全一致。
描述
业务接口:DescribeKeywordLib
获取自定义文本库列表。
请求参数
关于在请求中必须包含的公共请求参数,请参见公共参数。
请求body是一个结构体,结构说明如下:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
ServiceModule | 字符串 | 是 | 服务模块名称,取值:
|
返回参数
返回结果说明,参见返回结果。
返回body中的Data字段是JSON数组,每一个元素包含如下字段:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
Id | 数字型 | 是 | 主键ID。 |
ModifiedTime | 字符串 | 是 | 最近一次修改时间。 |
Name | 字符串 | 是 | 文本库名称。 |
Code | 字符串 | 是 | 文本库编码。
说明 在控制台中显示的文本库编码,而在API接口中以主键ID标识文本库。
|
Count | 字符串 | 是 | 文本库中的样本数量。 |
Category | 字符串 | 是 | 文本库类型,取值:
|
Source | 字符串 | 是 | 文本库来源。
说明 目前取值均为MANUAL,即手动方式添加。
|
ServiceModule | 字符串 | 是 | 服务模块名称,取值:
|
BizTypes | 列表 | 否 | 在设置页面的内容检测API的自定义文本库位置显示的BizType。 |
ResourceType | 字符串 | 是 | 文本库类型,取值:
|
LibType | 字符串 | 是 | 各应用场景中的文本库类型,取值:
|
MatchMode | 字符串 | 否 | 匹配类型。取值:
|
Enable | 布尔型 | 否 | 是否启用文本库,true表示启用,false表示停用。 |
示例
请求示例
{
"ServiceModule": open_api
}
返回示例
{
"requestId": "795D8871-4889-4C0F-A8B1-C7D2B990FF61",
"data": {
"TotalCount": 11,
"KeywordLibList": [
{
"Name": "test1sdkdk",
"Source": "MANUAL",
"BizTypes": [],
"Category": "BLACK",
"ServiceModule": "open_api",
"Count": 3,
"ResourceType": "TEXT",
"Id": 2147,
"ModifiedTime": "2018-09-04 14:17:56 +0800",
"Code": "710001",
"LibType": "textKeyword",
"MatchMode":"fuzzy",
"Enable":"true"
},
{
"Name": "语音测试",
"Source": "MANUAL",
"BizTypes": [],
"Category": "BLACK",
"ServiceModule": "open_api",
"Count": 3,
"ResourceType": "VOICE",
"Id": 2693,
"ModifiedTime": "2018-09-03 17:11:04 +0800",
"Code": "932001",
"LibType": "voiceText",
"MatchMode":"fuzzy",
"Enable":"true"
}
]
},
"code": 200,
"success": true
}
在文档使用中是否遇到以下问题
更多建议
匿名提交