文档版本 05 发布日期 2019-06-25 华为技术有限公司
版权所有 华为技术有限公司 2019 保留一切权利 非经本公司书面许可, 任何单位和个人不得擅自摘抄 复制本文档内容的部分或全部, 并不得以任何形式传播 商标声明 和其他华为商标均为华为技术有限公司的商标 本文档提及的其他所有商标或注册商标, 由各自的所有人拥有 注意 您购买的产品 服务或特性等应受华为公司商业合同和条款的约束, 本文档中描述的全部或部分产品 服务或特性可能不在您的购买或使用范围之内 除非合同另有约定, 华为公司对本文档内容不做任何明示或默示的声明或保证 由于产品版本升级或其他原因, 本文档内容会不定期进行更新 除非另有约定, 本文档仅作为使用指导, 本文档中的所有陈述 信息和建议不构成任何明示或暗示的担保 华为技术有限公司 地址 : 深圳市龙岗区坂田华为总部办公楼邮编 :518129 网址 : http://www.huawei.com 客户服务邮箱 : support@huawei.com 客户服务电话 : 4008302118 文档版本 05 (2019-06-25) 版权所有 华为技术有限公司 i
目录 目录 1 SDK 简介... 1 2 获取认证信息... 3 3 获取 SDK... 4 4 准备环境... 5 5 使用 SDK(Java)... 6 5.1 JAVA 开发环境配置... 6 5.2 IntelliJ IDEA 安装与 SDK 工程导入...6 5.3 配置 JAVA SDK 的 AK/SK... 8 5.4 创建实例示例... 8 5.5 添加图片示例... 8 5.6 搜索图片示例... 9 5.7 查询图片示例... 10 5.8 删除图片示例... 10 5.9 修改图片信息示例... 11 5.10 删除实例示例... 11 5.11 查询用户实例信息示例... 12 5.12 Token 认证方式使用 SDK... 12 A 修订记录... 13 文档版本 05 (2019-06-25) 版权所有 华为技术有限公司 ii
1 SDK 简介 1 SDK 简介 概述 (Image Search) 基于深度学习与图像识别技术, 结合不同应用业务和行业场景, 利用特征向量化与搜索能力, 帮助您从指定图库中搜索相同或相似的图片 服务以开放 API(Application Programming Interface, 应用程序编程接口 ) 的方式提供给用户, 用户通过实时访问和调用 API 获取结果, 帮助用户在图像库中进行相同或相似 SDK 概述 软件开发工具包 (Image Search Software Development Kit) 是对提供的 REST API 进行的封装, 以简化用户的开发工作 用户直接调用 SDK 提供的接口函数即可实现使用业务能力的目的 说明 服务提供的 SDK 暂不支持访问重试, 如果访问异常,SDK 会直接返回本次的请求结果, 所以需要客户端自行建立重试机制 接口与 API 对应关系 接口与 API 对应关系请参见表 1-1 表 1-1 接口与 API 对应关系 接口创建实例添加图片搜索图片查询图片 API POST /v1/{projectid}/service POST /v1/{projectid}/{instancename}/ image POST /v1/{projectid}/{instancename}/ image/search POST /v1/{projectid}/{instancename}/ image/check 文档版本 05 (2019-06-25) 版权所有 华为技术有限公司 1
1 SDK 简介 接口删除图片修改图片信息删除实例查询用户实例信息 API DELETE /v1/{projectid}/{instancename}/ image PUT /v1/{projectid}/{instancename}/ image DELETE /v1/{projectid}/service/ {instancename} GET /v1/{projectid}/service/ {instancename} 文档版本 05 (2019-06-25) 版权所有 华为技术有限公司 2
2 获取认证信息 2 获取认证信息 使用服务 API 需要进行认证, 有 Token 和 AK/SK 两种认证方式可选, 推荐使用 AK/SK 方式 步骤 1 注册并登录华为云管理控制台 鼠标移动至用户名处, 在下拉列表中单击 我的凭证 步骤 3 步骤 4 步骤 5 步骤 6 选择 管理访问密钥 页签, 点击 新增访问秘钥 按钮 输入当前用户的登录密码, 通过邮箱或者手机进行验证, 输入对应的验证码 单击 确定, 下载认证账号的 AK/SK, 请妥善保管 AK/SK 信息 修改 ImageSearchDemo.java 文件, 将信息替换成获取到的 AK/SK, 如图 1 修改 AK/SK 密钥所示 : 图 2-1 修改 AK/SK 密钥 文档版本 05 (2019-06-25) 版权所有 华为技术有限公司 3
3 获取 SDK 3 获取 SDK 下载 SDK 软件包和文档, 链接如下 :https://developer.huaweicloud.com/sdk? IMAGESEARCH 获取 Endpoint, 链接如下 : 地区和终端节点 文档版本 05 (2019-06-25) 版权所有 华为技术有限公司 4
4 准备环境 4 准备环境 在使用 SDK 时, 需要准备的环境请参见表 4-1 表 4-1 开发环境 准备项 操作系统 安装 JDK 说明 Windows 系统, 推荐 Windows 7 及以上版本 Java 开发环境的基本配置 版本要求 : 强烈推荐使用 1.8 版本 文档版本 05 (2019-06-25) 版权所有 华为技术有限公司 5
5 使用 SDK(Java) 5 使用 SDK(Java) 5.1 JAVA 开发环境配置 SDK 包要求 JDK 版本必须高于 JDK8, 如下操作以 win7 环境配置 JDK8 64 位为例, 若已经下载 JDK 并配置好环境请忽略本章节 步骤 1 下载 JDK 文件 :http://www.oracle.com/technetwork/java/javase/downloads/ index.html 下载完成后按照提示安装, 位置自选, 比如安装到本地 C:\Program Files\Java \jdk1.8.0_131 步骤 3 配置 Java 环境变量 : 右键 计算机 > 属性 > 高级系统设置 > 环境变量, 进行如下操作 : 新建系统变量 JAVA_HOME, 变量值为实际 JDK 安装位置 在 Path 中添加 %JAVA_HOME%\bin;%JAVA_HOME%\jre\bin ( 注意用英文分号分隔 ) 新建系统变量 CLASSPATH, 变量值为 %JAVA_HOME%\lib\dt.jar;%JAVA_HOME% \lib\tools.jar 步骤 4 打开命令行窗口, 输入 java -version, 显示如图 1 Java 版本信息表示配置成功 图 5-1 Java 版本信息 5.2 IntelliJ IDEA 安装与 SDK 工程导入 以 IntelliJ IDEA 工具为例给出 SDK 工程导入步骤, 如果使用其他 IDE 工具, 请参照处理 : 步骤 1 下载对应平台的 IntelliJ IDEA 版本 :http://www.jetbrains.com/idea/download/ #section=windows 文档版本 05 (2019-06-25) 版权所有 华为技术有限公司 6
5 使用 SDK(Java) 步骤 3 步骤 4 双击 exe 文件安装 IntelliJ IDEA 并打开 单击 File > New > Project from existing sources, 选择 SDK 所在目录下的 pom.xml 文件, 连续单击 Next, 然后单击 Finish 创建好工程 确保 File > Project structure > Project 中 SDK 版本为 Jdk1.8 工程目录, 如图 1 工程目录所示 : 图 5-2 工程目录 文档版本 05 (2019-06-25) 版权所有 华为技术有限公司 7
5 使用 SDK(Java) 5.3 配置 JAVA SDK 的 AK/SK 使用 AK/SK 认证方法, 只需要填写如图 1 使用方法红框中的 4 个变量, 通过如下方法实例化 ImageSearchService 对象, 调用其方法即可实现接口功能调用 图 5-3 使用方法 5.4 创建实例示例 调用 imagesearchservice.requestcreateservice 方法调用创建实例接口 对应 URI: POST /v1/{projectid}/service 步骤 1 根据业务需要, 修改相关配置项, 如图 1 创建实例所示 : 图 5-4 创建实例 运行 ImageSearchDemo.java 文件, 控制台输出图 2 创建实例成功所示内容则代码执行成功 图 5-5 创建实例成功 5.5 添加图片示例 添加图片途径 : 1. 调用 imagesearchservice.requestcreateindexbase64 方法添加图片 文档版本 05 (2019-06-25) 版权所有 华为技术有限公司 8
5 使用 SDK(Java) 2. 调用 imagesearchservice.requestcreateindexurl 方法添加 OBS 的图像 对应 URI:POST /v1/{projectid}/{instancename}/image 步骤 1 修改方法参数, 如图 1 添加图片所示. imagesearchservice.requestcreateindexbase64 中 path 填写文件所在路径 imagesearchservice.requestcreateindexurl 中 path 填写图像 URL( 当前仅支持 OBS 路径 ) 图 5-6 添加图片 运行 ImageSearchDemo.java 文件, 控制台输出如图 2 添加图片成功所示内容则代码执行成功 图 5-7 添加图片成功 5.6 搜索图片示例 搜索图片途径 : 1. 调用 imagesearchservice.requestsearchsimbase64 方法通过图片搜索 2. 调用 imagesearchservice.requestsearchsimurl 方法通过图像 URL ( 当前仅支持 OBS 图像的 URL) 搜索相似图片 3. 通过 imagesearchservice.requestsearchsimtags 通过 tag 搜索相似图片 对应 URI:POST /v1/{projectid}/{instancename}/image/search 步骤 1 修改方法参数, 如图 1 搜索图片所示 imagesearchservice.requestsearchsimbase64 中 file 填写本地 file 文件路径 imagesearchservice.requestsearchsimurl 中 path 填写图像的 URL( 当前仅支持 OBS 图像的 URL) 文档版本 05 (2019-06-25) 版权所有 华为技术有限公司 9
5 使用 SDK(Java) 图 5-8 搜索图片 运行 ImageSearchDemo.java 文件, 控制台输出如图 2 搜索图片完成所示内容则代码执行成功 图 5-9 搜索图片完成 5.7 查询图片示例 调用 imagesearchservice.requestimagecheck 方法查询图片是否存在 对应 URI:POST /v1/{projectid}/{instancename}/image/check 步骤 1 修改方法参数, 如图 1 查询图片所示,path 填写需要查询的图片 URL 图 5-10 查询图片 运行 ImageSearchDemo.java 文件, 控制台输出如图 2 查询图片完成所示内容则代码执行成功 图 5-11 查询图片完成 5.8 删除图片示例 调用 imagesearchservice.requestdeleteindex 方法删除图片 对应 URI:DELETE /v1/{projectid}/{instancename}/image 步骤 1 修改方法参数, 如图 1 删除图片所示,path 填写需要删除的图像 URL 文档版本 05 (2019-06-25) 版权所有 华为技术有限公司 10
5 使用 SDK(Java) 图 5-12 删除图片 运行 ImageSearchDemo.java 文件, 控制台输出如图 2 删除图片成功所示内容则代码执行成功 图 5-13 删除图片成功 5.9 修改图片信息示例 调用 imagesearchservice.requestupdatetags 方法修改图片 tag 信息 对应 URI:PUT /v1/{projectid}/{instancename}/image 步骤 1 修改方法参数, 如图 1 修改图片信息所示,createIndexTags 为需要修改的 tag 集合 图 5-14 修改图片信息 运行 ImageSearchDemo.java 文件, 控制台输出如图 2 修改图片信息成功所示内容则代码执行成功 图 5-15 修改图片信息成功 5.10 删除实例示例 调用 imagesearchservice.requestdeleteservice 方法删除实例 对应 URI:DELETE /v1/{projectid}/service/{instancename} 步骤 1 修改方法参数, 如图 1 删除实例所示 : 图 5-16 删除实例 文档版本 05 (2019-06-25) 版权所有 华为技术有限公司 11
5 使用 SDK(Java) 运行 ImageSearchDemo.java 文件, 控制台输出如图 2 删除实例成功所示内容则代码执行成功 : 图 5-17 删除实例成功 5.11 查询用户实例信息示例 调用 imagesearchservice.requestgetserviceinfo 方法查询用户实例信息 对应 URI:GET /v1/{projectid}/service/{instancename} 步骤 1 修改方法参数, 如图 1 查询用户实例信息所示 : 图 5-18 查询用户实例信息 运行 ImageSearchDemo.java 文件, 控制台输出如图 2 查询用户实例信息完成所示内容则代码执行成功 : 图 5-19 查询用户实例信息完成 5.12 Token 认证方式使用 SDK 通过 Token 方式使用 SDK, 只需要在 ImageSearchDemo.java 中修改如图 1 修改变量红框所示变量 : 图 5-20 修改变量 使用如图 2 实例化方法实例化 ImageSearchService 对象, 调用其方法即可实现接口功能调用, 接口调用与 AK/SK 调用方式相同 图 5-21 实例化 文档版本 05 (2019-06-25) 版权所有 华为技术有限公司 12
A 修订记录 A 修订记录 发布日期 修订记录 2019-06-25 第五次正式发布 优化 SDK 简介章节 优化获取认证信息章节 2018-12-11 第四次正式发布 2018-11-13 第三次正式发布 新增 准备环境章节 2018-10-18 第二次正式发布 修改 获取 SDK 章节, 增加 SDK 下载链接 Token 认证方式使用 SDK 章节 2018-10-16 第一次正式发布 文档版本 05 (2019-06-25) 版权所有 华为技术有限公司 13