查询文字样本库

最近更新时间:2019-07-24 15:15:37

1. 接口描述

接口请求域名: cms.tencentcloudapi.com 。

支持批量查询文字样本库

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTextSample
Version String 公共参数,本接口取值:2019-03-21
Region String 公共参数,详见产品支持的 地域列表
Filters.N Array of Filter 支持通过标签值进行筛选
Limit Integer 数量限制,默认为20,最大值为100
Offset Integer 偏移量,默认为0
OrderDirection String 升序(asc)还是降序(desc),默认:desc
OrderField String 按某个字段排序,目前仅支持CreatedAt排序

3. 输出参数

参数名称 类型 描述
TextSampleSet Array of TextSample 符合要求的样本的信息
TotalCount Integer 符合要求的样本的数量
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询文字样本库

查询白库

输入示例

https://cms.tencentcloudapi.com/?Action=DescribeTextSampleInstances
&Offset=0
&Limit=20
&OrderField=CreatedAt
&OrderDirection=desc
&Filters.0.Name=Label
&Filters.0.Value=1
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "c1935701-668a-4e0f-9f25-7e88a5f3f7af",
    "TotalCount": 10,
    "TextSampleSet": [
      {
        "Label": 1,
        "EvilType": 20002,
        "Content": "太子党",
        "Code": 0,
        "Status": 1,
        "CreatedAt": "2019-05-28 17:40:01"
      },
      {
        "Label": 1,
        "EvilType": 20002,
        "Content": "赵家党",
        "Code": 0,
        "Status": 1,
        "CreatedAt": "2019-05-28 17:40:01"
      }
    ]
  },
  "retcode": 0,
  "retmsg": "success"
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误