功能介绍
将图片导入图片索引库,该图片可以是同一区域OBS桶内的图片或请求消息体里的图 片,只有导入图片索引库的图片方可被搜索到。
说明
添加或搜索的图片存储在OBS的桶中时,需要对OBS的桶授权。在图像搜索服务管理控制台“实 例管理”页面,单击实例操作列的“离线导入”,进入“离线导入”页面。选择存放数据的OBS 桶,单击“授权”按钮,字体显示为灰色即完成OBS授权访问。
调试
您可以在API Explorer中调试该接口。
URI
POST /v1/{project_id}/{instance_name}/image 表4-6 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 用户的project_id 登陆华为云 ->
用户中心 -> 我的凭证 -> api凭 证 即可查看对应区域的项目 ID。
instance_nam
e 是 String 实例名称。
请求参数
表4-7 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。
通过调用IAM服务获取用户 Token接口获取(响应消息头中 X-Subject-Token的值)。
图像搜索API 参考 4 API
表4-8 请求 Body 参数
参数 是否必选 参数类型 描述
file 否 String 图片文件Base64编码字符串,
仅支持JPEG/JPG/PNG/BMP格 式,图片最小边不小于100px,
最大边不超过2048px。
path 是 String 图片的URL路径,作为图片库中
索引图片的ID,是必选参数。
说明
● 当file字段不为空时,图片从file 获取,path作为图片索引ID使 用;当file字段不存在或者为空 时,图片需要通过下载获取,
此时path作为下载图片的地址
(当前仅支持从华为云图像搜 索服务所在区域的OBS下载图 片),同时,path也作为图片 索引ID。
tags 否 Object 图片自定义标签。格式为key:
value对,所有图片的key总数最 多不超过10个,但是每个key对 应的value不限制个数,例如:
key为动物,对应的value可以是 猫、狗、鸟等多个。
标签名(key)添加方式:
● 登录管理控制台,单击“创 建实例”,自定义标签名。
● 登录管理控制台,在“实例 管理”页签,单击实例名 称,进入“基础信息”页添 加自定义标签。
响应参数
状态码: 200
表4-9 响应 Body 参数
参数 参数类型 描述
result String 调用成功时表示调用结果。 调用失败时无此字 段。
状态码: 400
图像搜索API 参考 4 API
表4-10 响应 Body 参数
参数 参数类型 描述
error_code String 调用失败时的错误码,具体请参见错误码。
调用成功时无此字段。
error_msg String 调用失败时的错误信息。
调用成功时无此字段。
请求示例
● 方式一:使用图片的BASE64编码
POST https://{endpoint}/v1/{project_id}/{instance_name}/image { "path" : "/../image.jpg",
"file" : "/9j/4AAQSkZJRgABAgEASABIAAD/
4RFZRXhpZgAATU0AKgAAAAgABwESAAMAAAABAAEAAAEaAAUAAAABAAAAYgEbAAUAAAABAAAA..."
}
● 方式二:使用图片的url
POST https://{endpoint}/v1/{project_id}/{instance_name}/image { "path" : "https://bucketName.obs.myhuaweicloud.com/image/test1.jpg"
}
● 方式三:使用图片的BASE64编码和标签
POST https://{endpoint}/v1/{project_id}/{instance_name}/image { "file" : "/9j/4AAQSkZJRgABAgEASABIAAD/
4RFZRXhpZgAATU0AKgAAAAgABwESAAMAAAABAAEAAAEaAAUAAAABAAAAYgEbAAUAAAABAAAA...", "tags" : {
"test-tags" : "test-image"
}}
● 方式四:使用图片的url和标签
POST https://{endpoint}/v1/{project_id}/{instance_name}/image
{ "path" : "https://bucketName.obs.myhuaweicloud.com/image/test1.jpg", "tags" : {
"test-tags" : "test-image"
}}
响应示例
状态码: 200 成功响应示例
{ "result" : "Success"
}
状态码: 400 失败响应示例
图像搜索API 参考 4 API
{ "error_code" : "IS.0003",
"error_msg" : "Arguments of path can not be null."
}
状态码
状态码 描述
200 成功响应示例 400 失败响应示例
错误码
请参见错误码。