简介
图像检索功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。
本文档提供关于图像检索的相关 API 概览以及 SDK 示例代码。
注意:
COS Javascript SDK 版本需要大于等于 v1.8.1。
API | 操作描述 |
可通过输入自然语言或图片,基于语义对数据集内文件进行图像检索。 |
图像检索
功能说明
可通过输入自然语言或图片,基于语义对数据集内文件进行图像检索。
使用示例
function searchImage() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/11459const config = {// 需要替换成您自己的存储桶信息AppId: '1250000000', // AppId,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const key = 'datasetquery/imagesearch'; // 固定值const host = `${config.AppId}.ci.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;const body = JSON.stringify({// 自定义数据集名称,同一个账户下唯一。;是否必传:是DatasetName: 'test-dataset-imagesearch2',// 指定检索方式为图片或文本,pic 为图片检索,text 为文本检索,默认为 pic。;是否必传:否Mode: 'pic',// 资源标识字段,表示需要建立索引的文件地址(Mode 为 pic 时必选)。;是否必传:否URI: 'cos://examplebucket-1250000000/exampleImage',// 返回相关图片的数量,默认值为10,最大值为100。;是否必传:否Limit: 10,// 出参 Score(相关图片匹配得分) 中,只有超过 MatchThreshold 值的结果才会返回。默认值为0,推荐值为80。;是否必传:否MatchThreshold: 1,});cos.request({Method: 'POST', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须Body: body, // 请求体参数,必须Headers: {// 设置请求体为 json,固定值,必须'Content-Type': 'application/json',// 设置响应体为json,固定值,必须Accept: 'application/json',},},function (err, data) {if (err) {// 处理请求失败console.log(err.code, err.message);} else {// 处理请求成功console.log(data);}});}searchImage()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:POST | String | 是 |
Key | 固定值:datasetquery/imagesearch | String | 是 |
Url | 请求 url,固定值 | String | 是 |
Body | Object | 是 | |
ContentType | 设置请求体为 json,固定值 | String | 是 |
Accept | 设置响应体为 json,固定值 | String | 是 |
回调函数说明
function(err, data) { ... }
参数名称 | 参数描述 | 类型 |
err | 请求发生错误时返回的对象,包括网络错误和业务错误。如果请求成功则为空,更多详情请参见 错误码 | Object |
- statusCode | 请求返回的 HTTP 状态码,例如200、403、404等 | Number |
- headers | 请求返回的头部信息 | Object |
data | 请求成功时返回的对象,如果请求发生错误,则为空 | Object |
- statusCode | 请求返回的 HTTP 状态码,例如200、403、404等 | Number |
- headers | 请求返回的头部信息 | Object |
- ImageResult | Array | |
- RequestId | 请求 ID | String |