图像识别创建图片库-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： tiia.tencentcloudapi.com 。

本接口用于创建一个空的图片库，图片库主要用于存储在创建图片时提取的图片特征数据，如果图片库已存在则返回错误。不同的图片库类型对应不同的图像搜索服务类型，根据输入参数GroupType区分。

服务类型	GroupType	功能描述
通用图像搜索	4	通用图像搜索1.0版。在自建图片库中搜索相同原图或相似图片集，并给出相似度打分，可支持裁剪、翻转、调色、加水印等二次编辑后的图片搜索。适用于图片版权保护、原图查询等场景。
商品图像搜索	8	商品图像搜索3.0升级版（推荐）。在自建图库中搜索同款或相似商品，并给出相似度打分。对于服饰类商品可支持识别服饰类别、属性等信息。适用于商品分类、检索、推荐等电商场景。
	7	商品图像搜索2.0版。功能和3.0升级版类似。
	5	商品图像搜索1.0版。功能和3.0升级版类似。
图案花纹搜索	6	图案花纹搜索1.0版。在自建图库中搜索相似的图案、logo、纹理等图像元素或主体，并给出相似度打分。

可前往图像搜索产品文档中查看更多产品信息。

默认接口请求频率限制：1次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateGroup。
Version	是	String	公共参数，本接口取值：2019-05-29。
Region	是	String	公共参数，详见产品支持的地域列表。
GroupId	是	String	图库ID，不可重复，仅支持字母、数字和下划线。图库数量单个用户上限为30。示例值：test_group
GroupName	是	String	图库名称描述。示例值：test_name
MaxCapacity	是	Integer	图片库可容纳的最大图片特征条数，一张图片对应一条图片特征数据，不支持修改。单个图片库容量最大可达亿级，达到容量限制后继续创建图片将会报错。注意，包月计费下支持绑定的最小库容量为500万。示例值：123
Brief	否	String	图库简介。示例值：test_brief
MaxQps	否	Integer	访问限制默认为10qps，如需扩容请联系在线客服申请。示例值：10
GroupType	否	Integer	图库类型，用于决定图像搜索的服务类型和算法版本，默认为4。 GroupType不支持修改，若不确定适用的服务类型，建议先对不同类型分别小规模测试后再开始正式使用。参数取值： 4：通用图像搜索1.0版。 8：商品图像搜索3.0升级版。 7：商品图像搜索2.0版。 5：商品图像搜索1.0版。 6：图案花纹搜索1.0版。 1 - 3：通用图像搜索旧版，不推荐使用。示例值：1

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 调用成功示例

调用成功示例

输入示例

POST / HTTP/1.1
Host: tiia.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateGroup
<公共请求参数>

{
    "Brief": "brief_test",
    "GroupName": "name_test",
    "MaxQps": "123",
    "MaxCapacity": "123",
    "GroupId": "test_1"
}

输出示例

{
    "Response": {
        "RequestId": "7ba53193-90af-4440-b706-b3d3a0657982"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure.InvalidAuthorization	认证失败。
FailedOperation.GroupCountExceeded	图库数量超出限制。
FailedOperation.InnerError	内部错误。
FailedOperation.ParameterEmpty	参数为空。
FailedOperation.RequestError	后端服务请求失败。
FailedOperation.RequestTimeout	后端服务超时。
FailedOperation.RpcFail	RPC请求失败，一般为算法微服务故障。
FailedOperation.UnKnowError	内部错误。
FailedOperation.Unknown	未知错误。
InvalidParameter.InvalidParameter	参数取值错误。
InvalidParameterValue.BriefTooLong	图库简介过长。
InvalidParameterValue.ImageGroupIdAlreadyExist	图库ID已存在。
InvalidParameterValue.ImageGroupIdIllegal	图库ID不合法。
InvalidParameterValue.ImageGroupIdNotExist	图库ID不存在。
InvalidParameterValue.ImageGroupIdTooLong	图库ID超出长度限制。
InvalidParameterValue.ImageGroupNameEmpty	图库名称为空。
InvalidParameterValue.ImageGroupNameTooLong	图库名称超出长度限制。
InvalidParameterValue.InvalidParameterValueLimit	参数值错误。
InvalidParameterValue.LimitExceed	返回数量不在合法范围内。
ResourceUnavailable.InArrears	账号已欠费。
ResourceUnavailable.NotExist	计费状态未知，请确认是否已在控制台开通服务。

创建图片库

本页目录：