有奖:语音产品征文挑战赛火热进行中> HOT

简介

本文档提供关于图片搜索接口的相关 API 概览以及 SDK 示例代码。
注意:
COS Javascript SDK 版本需要大于等于 v1.3.2。
API
操作描述
该接口用于检索图片。

图片搜索接口

功能说明

该接口用于检索图片。

使用示例

function getSearchImage() {
// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/11459
const config = {
// 需要替换成您自己的存储桶信息
Bucket: 'examplebucket-1250000000', // 存储桶,必须字段
Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing
};
cos.request(
{
Bucket: config.Bucket,
Region: config.Region,
Method: 'GET', // 固定值,必须
Key: 'ci/goods.jpeg', // 对象文件名,必须,例如:folder/document.jpg
Query: {
'ci-process': 'ImageSearch',
action: 'SearchImage',
// 出参 Score 中,只有超过 MatchThreshold 值的结果才会返回。默认为0;是否必传:否
MatchThreshold: 0,
// 起始序号,默认值为0;是否必传:否
Offset: 0,
// 返回数量,默认值为10,最大值为100;是否必传:否
Limit: 0,
// 针对入库时提交的 Tags 信息进行条件过滤。支持>、>=、<、<=、=、!=,多个条件之间支持 AND 和 OR 进行连接;是否必传:否
Filter: '',
},
},
function (err, data) {
if (err) {
// 处理请求失败
console.log(err);
} else {
// 处理请求成功
console.log(data);
}
}
);
}
getSearchImage();

参数说明

cos.request 方法参数说明:
参数名称
参数描述
类型
是否必填
Bucket
存储桶的名称,命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式
String
Region
存储桶所在地域,枚举值请参见 地域和访问域名
String
Method
固定值:GET
String
Key
对象文件名,必须,例如:folder/document.jpg
String
Query
其他请求参数
Container
Query 参数说明:
参数名称
参数描述
类型
是否必填
ci-process
固定值:ImageSearch。
String
action
固定值:SearchImage。
String
MatchThreshold
出参 Score 中,只有超过 MatchThreshold 值的结果才会返回。默认为0。
Integer
Offset
起始序号,默认值为0。
Integer
Limit
返回数量,默认值为10,最大值为100。
Integer
Filter
针对入库时提交的 Tags 信息进行条件过滤。
支持>、>=、<、<=、=、!=,多个条件之间支持 AND 和 OR 进行连接。
String

回调函数说明

function(err, data) { ... }
参数名称
参数描述
类型
err
请求发生错误时返回的对象,包括网络错误和业务错误。如果请求成功则为空,更多详情请参见 错误码
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
data
请求成功时返回的对象,如果请求发生错误,则为空
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
- Response
响应结果 详情请参见 图片搜索接口
Object

相关链接