获取人物样本列表

最近更新时间:2019-05-09 19:16:38

1. 接口描述

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

该接口用于查询人物样本信息,支持根据人物 ID、名称、标签,分页查询。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribePersonSamples
Version String 公共参数,本接口取值:2018-07-17
Region String 公共参数,本接口不需要传递此参数。
Type String 拉取的人物类型,可选值:
  • UserDefine:用户自定义人物库;
  • Default:系统默认人物库。


  • 默认值:UserDefine,拉取用户自定义人物库人物。
    说明:如果是拉取系统默认人物库,只能使用人物名字或者人物 ID + 人物名字的方式进行拉取,且人脸图片只返回一张。
    PersonIds.N Array of String 人物 ID,数组长度限制:100。
    Names.N Array of String 人物名称,数组长度限制:20。
    Tags.N Array of String 人物标签,数组长度限制:20。
    Offset Integer 分页偏移量,默认值:0。
    Limit Integer 返回记录条数,默认值:100,最大值:100。
    SubAppId Integer 点播子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的记录总数。
    PersonSet Array of AiSamplePerson 人物信息。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取人物样本列表

    输入示例

    https://vod.tencentcloudapi.com/?Action=DescribePersonSamples
    &PersonIds.0=10569
    &Names.0=张三
    &Tags.0=明星
    &Offset=0
    &Limit=20
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "TotalCount": 1,
        "PersonSet": [
          {
            "PersonId": "10569",
            "Name": "张三",
            "Description": "华语影视男演员、导演、制片人",
            "FaceInfoSet": [
              {
                "FaceId": "10024",
                "Url": "http://1256768367.vod2.myqcloud.com/8b0dd2b5vodcq1256768367/4d27b39f5285890783754292994/face.jpeg"
              }
            ],
            "TagSet": [
              "美国",
              "明星"
            ],
            "CreateTime": "2018-10-01T10:00:00Z",
            "UpdateTime": "2018-10-01T10:00:00Z"
          }
        ],
        "RequestId": "7d80775f-fb6d-4204-9540-1876f0d1c5a9"
      }
    }

    5. 开发者资源

    API Explorer

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidParameterValue 参数取值错误。