tencent cloud

对象存储

动态与公告
产品动态
产品公告
产品简介
产品概述
功能概览
应用场景
产品优势
基本概念
地域和访问域名
规格与限制
产品计费
计费概述
计费方式
计费项
免费额度
计费示例
查看和下载账单
欠费说明
常见问题
快速入门
控制台快速入门
COSBrowser 快速入门
用户指南
创建请求
存储桶
对象
数据管理
批量处理
全球加速
监控与告警
运维中心
数据处理
内容审核
智能工具箱
数据工作流
应用集成
工具指南
工具概览
环境安装与配置
COSBrowser 工具
COSCLI 工具
COSCMD 工具
COS Migration 工具
FTP Server 工具
Hadoop 工具
COSDistCp 工具
HDFS TO COS 工具
GooseFS-Lite 工具
在线辅助工具
自助诊断工具
实践教程
概览
访问控制与权限管理
性能优化
使用 AWS S3 SDK 访问 COS
数据容灾备份
域名管理实践
图片处理实践
COS 音视频播放器实践
工作流实践
数据直传
内容审核实践
数据安全
数据校验
大数据实践
COS 成本优化解决方案
在第三方应用中使用 COS
迁移指南
本地数据迁移至 COS
第三方云存储数据迁移至 COS
以 URL 作为源地址的数据迁移至 COS
COS 之间数据迁移
Hadoop 文件系统与 COS 之间的数据迁移
数据湖存储
云原生数据湖
元数据加速
数据加速器 GooseFS
数据处理
数据处理概述
图片处理
媒体处理
内容审核
文件处理
文档处理
故障处理
获取 RequestId 操作指引
通过外网上传文件至 COS 缓慢
访问 COS 时返回403错误码
资源访问异常
POST Object 常见异常
API 文档
简介
公共请求头部
公共响应头部
错误码
请求签名
操作列表
Service 接口
Bucket 接口
Object 接口
批量处理接口
数据处理接口
任务与工作流
内容审核接口
云查毒接口
SDK 文档
SDK 概览
准备工作
Android SDK
C SDK
C++ SDK
.NET(C#) SDK
Flutter SDK
Go SDK
iOS SDK
Java SDK
JavaScript SDK
Node.js SDK
PHP SDK
Python SDK
React Native SDK
小程序 SDK
错误码
鸿蒙(Harmony) SDK
终端 SDK 质量优化
安全与合规
数据容灾
数据安全
访问管理
常见问题
热门问题
一般性问题
计费计量问题
域名合规问题
存储桶配置问题
域名和 CDN 问题
文件操作问题
日志监控问题
权限管理问题
数据处理问题
数据安全问题
预签名 URL 问题
SDK 类问题
工具类问题
API 类问题
服务协议
Service Level Agreement
隐私政策
数据处理和安全协议
联系我们
词汇表

以图搜图

PDF
聚焦模式
字号
最后更新时间: 2024-01-19 15:41:29

简介

本文档提供关于以图搜图的 API 概览和 SDK 示例代码。
API
操作描述
该接口用于开通 Bucket 搜图功能
该接口用于添加图库图片
该接口用于检索图库中的图片
该接口用于删除图库图片

开通以图搜图

功能说明

该接口用于开通 Bucket 搜图功能。

方法原型

boolean openImageSearch(OpenImageSearchRequest imageSearchRequest);

请求示例

//1.创建任务请求对象
OpenImageSearchRequest request = new OpenImageSearchRequest();
//2.添加请求参数 参数详情请见api接口文档
request.setBucketName("demobucket-123456789");
request.setMaxCapacity("100");
request.setMaxQps("10");
//3.调用接口,获取任务响应对象
boolean response = client.openImageSearch(request);

参数说明

Request 中的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
是否必选
bucketName
Request
Bucket 的命名规则为 BucketName-APPID,详情请参见 存储桶概述
String
maxCapacity
Request
图库容量限制
String
MaxQps
Request
图库容量限制
String

返回结果说明

成功:成功则返回 true。
失败:发生错误(例如 Bucket 不存在),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理

添加图库图片

功能说明

将图片资源添加至图库。

方法原型

boolean addGalleryImages(ImageSearchRequest imageSearchRequest);

请求示例

//1.创建任务请求对象
ImageSearchRequest request = new ImageSearchRequest();
//2.添加请求参数 参数详情请见api接口文档
request.setBucketName("demobucket-123456789");
request.setObjectKey("1.png");
request.setEntityId("mark1");
//3.调用接口,获取任务响应对象
boolean response = client.addGalleryImages(request);

参数说明

Request 中的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
是否必选
bucketName
Request
Bucket 的命名规则为 BucketName-APPID,详情请参见 存储桶概述
String
objectKey
Request
图片文件在 bucket 中的位置
String
entityId
Request
物品 ID,最多支持64个字符。若 EntityId 已存在,则对其追加图片
String
customContent
Request
用户自定义的内容,最多支持4096个字符,查询时原样带回
String
tags
Request
图片自定义标签,最多不超过10个,json 字符串,格式为 key:value 对
String

返回结果说明

成功:成功则返回 true。
失败:发生错误(例如 Bucket 不存在),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理

图片搜索接口

功能说明

检索图库中的图片。

方法原型

ImageSearchResponse searchGalleryImages(ImageSearchRequest imageSearchRequest);

请求示例

//1.创建任务请求对象
ImageSearchRequest request = new ImageSearchRequest();
//2.添加请求参数 参数详情请见api接口文档
request.setBucketName("demobucket-123456789");
request.setObjectKey("1.png");
//3.调用接口,获取任务响应对象
ImageSearchResponse response = client.searchGalleryImages(request);

参数说明

Request 中的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
是否必选
bucketName
Request
Bucket 的命名规则为 BucketName-APPID,详情请参见 存储桶概述
String
objectKey
Request
图片文件在 bucket 中的位置
String
matchThreshold
Request
出参 Score 中,只有超过 MatchThreshold 值的结果才会返回。默认为0
String
Offset
Request
起始序号,默认值为0
String
limit
Request
返回数量,默认值为10,最大值为100
String
filter
Request
针对入库时提交的 Tags 信息进行条件过滤。支持>、>=、<、<=、=、!=,多个条件之间支持 AND 和 OR 进行连接
String

返回结果说明

成功:成功则返回 ImageSearchResponse 响应对象。
失败:发生错误(例如 Bucket 不存在),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理

删除图库图片

功能说明

将图片资源移出图库。

方法原型

boolean deleteGalleryImages(ImageSearchRequest imageSearchRequest);

请求示例

//1.创建任务请求对象
ImageSearchRequest request = new ImageSearchRequest();
//2.添加请求参数 参数详情请见api接口文档
request.setBucketName("demobucket-123456789");
request.setObjectKey("1.png");
request.setEntityId("mark");
//3.调用接口,获取任务响应对象
boolean response = client.deleteGalleryImages(request);

参数说明

Request 中的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
是否必选
bucketName
Request
Bucket 的命名规则为 BucketName-APPID,详情请参见 存储桶概述
String
objectKey
Request
图片文件在 bucket 中的位置
String
entityId
Request
物品 ID
String

返回结果说明

成功:成功则返回 true。
失败:发生错误(例如 Bucket 不存在),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈