数据万象
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 数据万象 > API 文档 > AI 内容识别 > 以图搜图 > 图片搜索接口

图片搜索接口

最近更新时间：2024-04-09 15:54:35

我的收藏

本页目录：

功能描述

该接口用于检索图片。

授权说明

通过子账号使用时，需要授予ci:SearchImage权限，详情请参见 数据万象 action。

服务开通

使用该功能需提前开通数据万象，并绑定存储桶。详情请参见 绑定存储桶。
使用该功能需提前通过控制台或接口开通 AI 内容识别服务 。详情请参见 开通 AI 内容识别服务。

使用限制

使用该接口时，请先确认相关限制条件。详情请参见 使用限制。


请求

请求示例

GET /<ObjectKey>?ci-process=ImageSearch&action=SearchImage&MatchThreshold=&Offset= HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml

<body>
说明
Authorization: Auth String，详情请参见 请求签名 文档。

请求参数

参数的具体内容如下：
节点名称（关键字）
描述
类型
是否必选
ObjectKey
对象文件名，例如：folder/document.jpg。
String
是
MatchThreshold
出参 Score 中，只有超过 MatchThreshold 值的结果才会返回。默认为0
Int
否
Offset
起始序号，默认值为0
Int
否
Limit
返回数量，默认值为10，最大值为100
Int
否
Filter
针对入库时提交的 Tags 信息进行条件过滤。支持>、>=、<、<=、=、!=，多个条件之间支持 AND 和 OR 进行连接
String
否

请求头

此接口仅使用公共请求头部，详情请参见 公共请求头部 文档。

请求体

该请求无请求体。

响应

响应头

此接口仅返回公共响应头部，详情请参见 公共响应头部 文档。

响应体

该响应体返回为 application/xml 数据，包含完整节点数据的内容展示如下：
<Response>
    <Count>2</Count>
    <ImageInfos>
        <EntityId>apple</EntityId>
        <PicName>ObjectKey1</PicName>
        <Score>99</Score>
        <CustomContent>XXX</CustomContent>
        <Tags>{"key1":"value1","key2":"value2"}</Tags>
    </ImageInfos>
    <ImageInfos>
        <EntityId>apple</EntityId>
        <PicName>ObjectKey2</PicName>
        <Score>90</Score>
        <CustomContent>XXX</CustomContent>
        <Tags>{"key1":"value1","key2":"value2"}</Tags>
    </ImageInfos>
</Response>
具体的数据内容如下：
节点名称（关键字）
父节点
描述
类型
Response
无
保存结果的容器
Container
Response 节点的内容：
节点名称（关键字）
父节点
描述
类型
RequestId
Response
请求的唯一 ID
String
Count
Response
数量
Int
ImageInfos
Response
图片信息
Container
ImageInfos 节点为数组，其中每一项内容：
节点名称（关键字）
父节点
描述
类型
EntityId
ImageInfos
物品 ID
String
CustomContent
ImageInfos
图片自定义的内容
String
Tags
ImageInfos
自定义标签信息，最多不超过10个，json 字符串，格式为 key:value （例 key1>=1 key1>='aa' ）对
String
PicName
ImageInfos
图片名称
String
Score
ImageInfos
相似度
Int

错误码

此接口遵循统一的错误响应和错误码，详情请参见 错误码 文档。

实际案例

请求

GET /<ObjectKey>?ci-process=ImageSearch&action=SearchImage&MatchThreshold=10&Offset=2 HTTP/1.1
Authorization: q-sign-algorithm=sha1&q-ak=AKID8A0fBVtYFrNm02oY1g1JQQF0c3JO****&q-sign-time=1558699190;1558706390&q-key-time=1558699190;1558706390&q-header-list=date;host&q-url-param-list=&q-signature=89fa1f6a56c34e460f3db4d65f928eaf034a****
Host: examplebucket-1250000000.cos.ap-beijing.myqcloud.com
Content-Length: 0
Content-Type: application/xml

响应

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 150
Connection: keep-alive
Date: Thu, 15 Jun 2017 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****

<Response>
    <Count>2</Count>
    <ImageInfos>
        <EntityId>apple</EntityId>
        <PicName>ObjectKey</PicName>
        <Score>99</Score>
        <CustomContent>XXX</CustomContent>
        <Tags>{"key1":"value1","key2":"value2"}</Tags>
    </ImageInfos>
    <ImageInfos>
        <EntityId>apple</EntityId>
        <PicName>ObjectKey2</PicName>
        <Score>90</Score>
        <CustomContent>XXX</CustomContent>
        <Tags>{"key1":"value1","key2":"value2"}</Tags>
    </ImageInfos>
</Response>

中国站