简介
图像检索功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。
本文档提供关于图像检索的相关 API 概览以及 SDK 示例代码。
注意:
API | 操作描述 |
图像检索 |
图像检索
功能说明
可通过输入自然语言或图片,基于语义对数据集内文件进行图像检索。
方法原型
public SearchImageResponse searchImage(SearchImageRequest customRequest)
请求示例
SearchImageRequest request = new SearchImageRequest();request.setAppId("1234567890");// 设置数据集名称,同一个账户下唯一。;是否必传:是request.setDatasetName("ImageSearch001");// 设置指定检索方式为图片或文本,pic 为图片检索,text 为文本检索,默认为 pic。;是否必传:否request.setMode("pic");// 设置资源标识字段,表示需要建立索引的文件地址(Mode 为 pic 时必选)。;是否必传:否request.setURI("cos://facesearch-1258726280/huge_base.jpg");// 设置返回相关图片的数量,默认值为10,最大值为100。;是否必传:否request.setLimit(10);// 设置出参 Score(相关图片匹配得分) 中,只有超过 MatchThreshold 值的结果才会返回。默认值为0,推荐值为80。;是否必传:否request.setMatchThreshold(1);SearchImageResponse response = client.searchImage(request);
参数说明
Request: 中的具体数据描述如下:
参数名称 | 描述 | 类型 | 是否必传 |
AppId | String | 是 | |
datasetName | 数据集名称,同一个账户下唯一。 | String | 是 |
mode | 指定检索方式为图片或文本,pic 为图片检索,text 为文本检索,默认为 pic。 | String | 否 |
uRI | 资源标识字段,表示需要建立索引的文件地址(Mode 为 pic 时必选)。 | String | 否 |
limit | 返回相关图片的数量,默认值为10,最大值为100。 | Integer | 否 |
text | 检索语句,检索方式为 text 时必填,最多支持60个字符 (Mode 为 text 时必选)。 | String | 否 |
matchThreshold | 限制返回图片的最低相关度分数,只有超过 MatchThreshold 值的图片才会返回。默认值为0,推荐值为80。
例如:设置 MatchThreshold 的值为80,则检索结果中仅会返回相关度分数大于等于80分的图片。 | Integer | 否 |
响应参数说明:
SearchImageResponse 中的具体数据描述如下:
参数名称 | 描述 | 类型 |
imageResult | 图像检索识别结果信息列表。 | Container Array |
requestId | 请求ID。 | String |
ImageResult 中的具体数据描述如下:
参数名称 | 描述 | 类型 |
uRI | 资源标识字段,表示需要建立索引的文件地址。 | String |
score | 图片相关度分数,分数越高表示与检索条件越相符。 | Integer |
返回结果说明
成功:返回 SearchImageResponse 对象响应信息。
失败:发生错误(如 Bucket 不存在),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理。