数据万象图像检索-API 文档-文档中心-腾讯云

功能描述
支持输入自然语言文本或者图片，在指定数据集中检索出符合输入的文本语义或图片内容相似的图片。
费用说明
有关图像检索的费用，请参见 智能检索费用。
授权说明
授权策略中 action 设置为 ci:DatasetImageSearch，详情请参见 数据万象 action。
限制说明
返回相关图片数量最大为100。
请求
请求示例
POST /datasetquery/imagesearch HTTP/1.1
Host: <AppId>.ci.<Region>.myqcloud.com
Authorization: Auth String
Content-Length: xxx
Content-Type: application/json
Accept: application/json
说明：
Authorization: Auth String（详情请参见 请求签名 文档）。
通过子账号使用时，需要授予相关的权限，详情请参见 授权粒度详情 文档。
请求头
此接口仅使用公共请求头部，详情请参见 公共请求头部 文档。
请求体
{
    "DatasetName": "ImageSearch001",
    "Mode": "pic",
    "URI": "cos://facesearch-1258726280/huge_base.jpg",
    "Limit": 10,
    "MatchThreshold": 1
}
请求参数
参数名称
描述
类型
是否必选
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
否
响应
响应头
此接口仅返回公共响应头部，详情请参见 公共响应头部 文档。
响应体
{
    "ImageResult": [{
        "URI": "cos://facesearch-1258726280/huge_base.jpg",
        "Score": 99
    }],
    "RequestId": "NjYwYzEwYjhfNGQ2ODk0MGJfMjcwNl82"
}
响应包体具体数据内容如下：
参数名称
类型
描述
ImageResult
Container Array
图像检索识别结果信息列表。
RequestId
String
请求 ID。
ImageResult 节点内容：
参数名称
类型
描述
URI
String
资源标识字段，表示需要建立索引的文件地址。
Score
Integer
图片相关度分数，分数越高表示与检索条件越相符。

参数名称	描述	类型	是否必选
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	否

图像检索

本页目录：

功能描述

费用说明

授权说明

限制说明

请求

请求示例

请求头

请求体

请求参数

响应

响应头

响应体