本文提供了管理自定义图库相关的具体接口及参数,旨在帮助您通过API接口自主管理您的自定义相似图片库。自定义相似图片库可用于智能鉴黄、暴恐涉政识别、广告识别场景(暂不支持其它场景)。

  • 关于如何构造HTTP请求,请参考请求结构
  • 您也可以直接选用已构造好的HTTP请求,具体请参考SDK参考
说明 推荐您使用本文介绍的新版API,该版本经过全新设计更易使用;如果您使用旧版本SDK,您可以单击下载旧版本文档

API概述

调用API接口方式与云盾内容控制台上的自定义图库功能完全一致,具体包含以下API接口:
API 描述
DescribeImageLib 获取已添加的自定义图片库列表
CreateImageLib 创建自定义图库库
UpdateImageLib 更新自定义图片库的名称及适用的bizTypes参数
DeleteImageLib 上传自定义图片库
DescribeImageFromLib 获取自定义图片库中已添加的图片列表
DescribeUploadInfo 在向自定义图片库中添加图片时,获取上传图片临时凭证信息
UploadImageToLib 向自定义库中添加图片元信息
说明 添加图片前需要调用 DescribeUploadInfo接口获取上传凭证并上传图片。
DeleteImageFromLib 从自定义图片库中删除已添加的图片

相似图片库限制

  • 图片库名称最长不超过64个字符
  • 单个图片库最多支持添加10,000张图片
  • 图片库中图片大小不能超过50 MB,支持的图片格式:PNG、JPG、JPEG、BMP
  • 新增、删除图片样本后,需要3分钟左右的生效时间

获取图库列表

描述

业务接口DescribeImageLib

获取自定义图库列表。

请求参数

关于在请求中必须包含的公共请求参数,请参考公共参数

请求body是一个结构体,结构说明如下:
名称 类型 是否必需 描述
ServiceModule 字符串 服务模块名称,取值:
  • open_api:用于内容检测API功能的图库。
  • website:用于站点检测功能的图库。

返回参数

返回结果说明,参见返回结果

返回body中的Data字段是JSON数组,每一个元素包含如下字段:
名称 类型 是否必需 描述
Id 数字型 主键ID。
ModifiedTime 字符串 最近一次修改时间。
Name 字符串 图库名称。
Code 字符串 词库编码。
说明 在控制台中显示的词库编码,而在API接口中以主键ID标识图库。
ImageCount 字符串 图库中的图片数量。
Category 字符串 词库类型,取值:
  • BLACK:黑名单
  • WHITE:白名单
Source 字符串 图库来源,取值:
  • MANUAL:手动创建。
  • FEEDBACK:根据用户反馈的结果自动创建。
ServiceModule 字符串 服务模块名称,取值:
  • open_api:用于内容检测API功能的词库。
  • website:用于站点检测功能的词库。
Scene 字符串 图库使用场景,取值:
  • PORN:智能鉴黄
  • AD:广告识别
  • ILLEGAL:暴恐涉政识别
BizTypes 列表 设置页面的内容检测API的自定义图库位置显示的BizType。

示例

请求示例
{
  "ServiceModule": website
}
返回示例
{
  "requestId": "6CF2815C-C8C7-4A01-B52E-FF6E24F53492",
  "data": {
    "TotalCount": 5,
    "ImageLibList": [
      {
        "Name": "测试a",
        "Source": "MANUAL",
        "ImageCount": 191231231230,
        "BizTypes": [
          1,
          2,
          3
        ],
        "Category": "BLACK",
        "ServiceModule": "website",
        "Scene": "PORN",
        "ModifiedTime": "2018-03-19 10:45:44 +0800",
        "Id": 1279,
        "Code": "808003055"
      },
      {
        "Name": "棒棒哒",
        "Source": "MANUAL",
        "ImageCount": 0,
        "BizTypes": [],
        "Category": "BLACK",
        "ServiceModule": "website",
        "Scene": "PORN",
        "ModifiedTime": "2018-03-19 10:38:27 +0800",
        "Id": 1278,
        "Code": "808003054"
      },
      {
        "Name": "你好",
        "Source": "FEEDBACK",
        "ImageCount": 0,
        "BizTypes": [],
        "Category": "WHITE",
        "ServiceModule": "website",
        "Scene": "PORN",
        "ModifiedTime": "2018-03-15 09:33:15 +0800",
        "Id": 1271,
        "Code": "808003052"
      },
      {
        "Name": "测试123",
        "Source": "MANUAL",
        "ImageCount": 0,
        "BizTypes": [],
        "Category": "BLACK",
        "ServiceModule": "website",
        "Scene": "PORN",
        "ModifiedTime": "2018-03-15 09:31:57 +0800",
        "Id": 1270,
        "Code": "808003051"
      },
      {
        "Name": "aa你好",
        "Source": "MANUAL",
        "ImageCount": 0,
        "BizTypes": [],
        "Category": "BLACK",
        "ServiceModule": "website",
        "Scene": "PORN",
        "ModifiedTime": "2018-03-01 19:20:37 +0800",
        "Id": 1222,
        "Code": "808003043"
      }
    ]
  },
  "code": 200,
  "success": true
}

修改图库信息

描述

业务接口UpdateImageLib

修改图库的基本信息。

请求参数

关于在请求中必须包含的公共请求参数,请参考公共参数

请求body是一个结构体,结构说明如下:
名称 类型 是否必需 描述
Id 数字型 主键ID。
Name 字符串 图库名称。
Category 字符串 词库类型,取值:
  • BLACK:黑名单
  • WHITE:白名单
Scene 字符串 图库使用场景,取值:
  • PORN:智能鉴黄
  • AD:广告识别
  • ILLEGAL:暴恐涉政识别
BizTypes 列表 业务类型,在设置页面的内容检测API的自定义图库位置显示的BizType信息。对于站点检测,该字段根据Instance生成。

返回参数

返回结果说明,参见返回结果

示例

请求示例
{
  "Id": 2147,
  "Name": "test2sdkdk",
  "BizTypes": []
}
返回示例
{
  "requestId": "795D8871-4889-4C0F-A8B1-C7D2B990FF61",
  "code": 200
}

创建图库

描述

业务接口CreateImageLib

创建自定义相似图库。
说明 图库的数量限制与通过控制台创建的图库共享。

请求参数

关于在请求中必须包含的公共请求参数,请参考公共参数

请求body是一个结构体,结构说明如下:
名称 类型 是否必需 描述
Name 字符串 图库名称。
Category 字符串 词库类型,取值:
  • BLACK:黑名单
  • WHITE:白名单
ServiceModule 字符串 服务模块名称,取值:
  • open_api:用于内容检测API功能的词库。
  • website:用于站点检测功能的词库。
Scene 字符串 图库使用场景,取值:
  • PORN:智能鉴黄
  • AD:广告识别
  • ILLEGAL:暴恐涉政识别
BizTypes 列表 业务类型,在设置页面的内容检测API的自定义图库位置显示的BizType信息。对于站点检测,该字段根据Instance生成。

返回参数

返回结果说明,参见返回结果

示例

请求示例
{
  "Name": "test1sdkdk",
  "BizTypes": [],
  "Category": "BLACK",
  "ServiceModule": "open_api",
  "ResourceType": "TEXT",
  "Scene": "PORN"
}
返回示例
{
  "requestId": "795D8871-4889-4C0F-A8B1-C7D2B990FF61",
  "code": 200
}

删除图库

描述

业务接口DeleteImageLib

删除指定相似图库。
说明 图库删除后无法恢复,请谨慎操作。

请求参数

关于在请求中必须包含的公共请求参数,请参考公共参数

请求body是一个结构体,结构说明如下:
名称 类型 是否必需 描述
Id 数字型 图库主键ID。
说明 请注意不要错误地传入图库Code字段值。

返回参数

返回结果说明,参见返回结果

示例

请求示例
{
  "Id": 2147
}
返回示例
{
  "requestId": "795D8871-4889-4C0F-A8B1-C7D2B990FF61",
  "code": 200
}

查询图库中的图片

描述

业务接口DescribeImageFromLib

在指定图库中,以分页方式查询图片列表。

请求参数

关于在请求中必须包含的公共请求参数,请参考公共参数

请求body是一个结构体,结构说明如下:
名称 类型 是否必需 描述
ImageLibId 数字型 图库主键ID。
TotalCount 数字型 返回图片数。
CurrentPage 字符串 返回的当前分页。
PageSize 数字串 返回的分页大小,即每个分页显示的图片数量。

返回参数

返回结果说明,参见返回结果
名称 类型 是否必需 描述
TotalCount 数字型 返回图片数。
CurrentPage 字符串 返回的当前分页。
PageSize 数字串 返回的分页大小,即每个分页显示的图片数量。
ImageFromLibList JSON数组 图片列表,具体结构描述见ImageFromLibList
表 1. ImageFromLibList
名称 类型 是否必需 描述
Id 数字型 图片主键ID。
Image 字符串 图片URL地址。
Thumbnail 数字型 图片的缩略图URL地址。

示例

请求示例
{
  "ImageLibId": "2147"
}
返回示例
{
  "code": 200,
  "requestId": "73133169-C2FC-4A42-82FC-9C197BC5DCDE",
  "data": {
    "TotalCount": 12,
    "PageSize": 10,
    "CurrentPage": 1,
    "ImageFromLibList": [
      {
        "Id": 0,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1PDhjXrSYBuNjSspfXXcZCpXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1PDhjXrSYBuNjSspfXXcZCpXa-130-130.jpg"
      },
      {
        "Id": 1,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1ndhiXCCWBuNjy0FhXXb6EVXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1ndhiXCCWBuNjy0FhXXb6EVXa-130-130.jpg"
      },
      {
        "Id": 2,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1h0hiXCCWBuNjy0FhXXb6EVXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1h0hiXCCWBuNjy0FhXXb6EVXa-130-130.jpg"
      },
      {
        "Id": 3,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1PDhjXrSYBuNjSspfXXcZCpXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1PDhjXrSYBuNjSspfXXcZCpXa-130-130.jpg"
      },
      {
        "Id": 4,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1ndhiXCCWBuNjy0FhXXb6EVXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1ndhiXCCWBuNjy0FhXXb6EVXa-130-130.jpg"
      },
      {
        "Id": 5,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1h0hiXCCWBuNjy0FhXXb6EVXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1h0hiXCCWBuNjy0FhXXb6EVXa-130-130.jpg"
      },
      {
        "Id": 6,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1PDhjXrSYBuNjSspfXXcZCpXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1PDhjXrSYBuNjSspfXXcZCpXa-130-130.jpg"
      },
      {
        "Id": 7,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1ndhiXCCWBuNjy0FhXXb6EVXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1ndhiXCCWBuNjy0FhXXb6EVXa-130-130.jpg"
      },
      {
        "Id": 8,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1h0hiXCCWBuNjy0FhXXb6EVXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1h0hiXCCWBuNjy0FhXXb6EVXa-130-130.jpg"
      },
      {
        "Id": 9,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1PDhjXrSYBuNjSspfXXcZCpXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1PDhjXrSYBuNjSspfXXcZCpXa-130-130.jpg"
      },
      {
        "Id": 10,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1ndhiXCCWBuNjy0FhXXb6EVXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1ndhiXCCWBuNjy0FhXXb6EVXa-130-130.jpg"
      },
      {
        "Id": 11,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1h0hiXCCWBuNjy0FhXXb6EVXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1h0hiXCCWBuNjy0FhXXb6EVXa-130-130.jpg"
      },
      {
        "Id": 12,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1PDhjXrSYBuNjSspfXXcZCpXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1PDhjXrSYBuNjSspfXXcZCpXa-130-130.jpg"
      },
      {
        "Id": 13,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1ndhiXCCWBuNjy0FhXXb6EVXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1ndhiXCCWBuNjy0FhXXb6EVXa-130-130.jpg"
      },
      {
        "Id": 14,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1h0hiXCCWBuNjy0FhXXb6EVXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1h0hiXCCWBuNjy0FhXXb6EVXa-130-130.jpg"
      },
      {
        "Id": 15,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1PDhjXrSYBuNjSspfXXcZCpXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1PDhjXrSYBuNjSspfXXcZCpXa-130-130.jpg"
      },
      {
        "Id": 16,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1ndhiXCCWBuNjy0FhXXb6EVXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1ndhiXCCWBuNjy0FhXXb6EVXa-130-130.jpg"
      },
      {
        "Id": 17,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1h0hiXCCWBuNjy0FhXXb6EVXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1h0hiXCCWBuNjy0FhXXb6EVXa-130-130.jpg"
      },
      {
        "Id": 18,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1PDhjXrSYBuNjSspfXXcZCpXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1PDhjXrSYBuNjSspfXXcZCpXa-130-130.jpg"
      },
      {
        "Id": 19,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1ndhiXCCWBuNjy0FhXXb6EVXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1ndhiXCCWBuNjy0FhXXb6EVXa-130-130.jpg"
      },
      {
        "Id": 20,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1h0hiXCCWBuNjy0FhXXb6EVXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1h0hiXCCWBuNjy0FhXXb6EVXa-130-130.jpg"
      },
      {
        "Id": 21,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1PDhjXrSYBuNjSspfXXcZCpXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1PDhjXrSYBuNjSspfXXcZCpXa-130-130.jpg"
      },
      {
        "Id": 22,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1ndhiXCCWBuNjy0FhXXb6EVXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1ndhiXCCWBuNjy0FhXXb6EVXa-130-130.jpg"
      },
      {
        "Id": 23,
        "Image": "https://gw.alicdn.com/bao/uploaded/TB1h0hiXCCWBuNjy0FhXXb6EVXa-130-130.jpg",
        "Thumbnail": "https://gw.alicdn.com/bao/uploaded/TB1h0hiXCCWBuNjy0FhXXb6EVXa-130-130.jpg"
      }
    ]
  }
}

删除图片

描述

业务接口DeleteImageFromLib

删除图库中的指定图片,支持批量删除。
说明 图片删除后无法恢复,请谨慎操作。

请求参数

关于在请求中必须包含的公共请求参数,请参考公共参数

请求body是一个结构体,结构说明如下:
名称 类型 是否必需 描述
Ids 列表型 图片ID列表。
ImageLibId 字符串 图库主键ID。

返回参数

返回结果说明,参见返回结果

示例

请求示例
{
  "Id": [1,2],
  "ImageLibId": 2147
}
返回示例
{
  "requestId": "795D8871-4889-4C0F-A8B1-C7D2B990FF61",
  "code": 200
}

获取图片上传签名

描述

业务接口DescribeUploadInfo

如果您需要通过API接口向图库中添加图片,需要先通过该接口获取上传图片的签名,再调用上传图片接口上传图片。

请求参数

关于在请求中必须包含的公共请求参数,请参考公共参数

请求body是一个结构体,结构说明如下:
名称 类型 是否必需 描述
Biz 字符串 获取自定义图库图片上传签名,传入customImageLib

返回参数

返回结果说明,参见返回结果
名称 类型 是否必需 描述
Accessid 字符串 AccessID。
Policy 字符串 策略。
Signature 字符串 签名。
Folder 字符串 对应的OSS目录地址,即对象前缀。
Host 字符串 服务端点地址。
Expire 字符串 失效时间,单位为秒。

示例

请求示例
{
  "Biz": "customImageLib"
}
返回示例
{
  "code": "200",
  "data": {
    "Policy": "asdfadklfakldf",
    "Expire": 1232323,
    "Accessid": "blalbal...",
    "Signature": "signature",
    "Host": "cn-shanghai.oss.aliyun.com",
    "Folder": "/folder/1733344274274674"
  },
  : "requestId"795D8871-4889-4C0F-A8B1-C761: "@guid",
  "successResponse": true
}

上传图片

描述

业务接口UploadImageToLib

如果您需要通过该接口向指定图库中添加图片,需要先通过获取上传接口获取上传图片的签名,再调用该接口上传图片。

请求参数

关于在请求中必须包含的公共请求参数,请参考公共参数

请求body是一个结构体,结构说明如下:
名称 类型 是否必需 描述
ImageLibId 数字型 图库主键ID。
Images 列表 图片列表,列表中的每一个元素为图片的OSS访问地址。

返回参数

返回结果说明,参见返回结果

示例

请求示例
{
  "ImageLibId": "2147",
  "Images": [xxx,xxx]
}
返回示例
{
  "requestId": "795D8871-4889-4C0F-A8B1-C7D2B990FF61",
  "code": 200
}