# 华为图像搜索 华为图像搜索连接器基于华为云图像搜索ImageSearch集成开发，即以图搜图，华为云图像搜索基于深度学习与图像识别技术，利用特征向量化与搜索能力，帮助客户从指定图库中搜索相同及相似的图片。包含"实例管理"和"图片管理"等执行动作。 #### 连接参数 华为图像搜索连接器使用IAM认证，连接参数说明如[表1]所示。 表1连接参数说明 | 名称 | 必填 | 说明 | 示例值/默认值 | |:---|:---|:---|:---| | 连接名称 | 是 | 设置连接名称。 | 华为图像搜索的连接 | | 描述 | 否 | 对于连接的信息描述说明。 | description | | 租户名 | 是 | IAM用户所属账号信息。了解[账号与IAM用户的关系](https://support.huaweicloud.com/productdesc-iam/iam_01_0023.html#section2)。 | domain | | 用户名 | 是 | IAM用户名。 | name | | 密码 | 是 | IAM用户的登录密码。 | - | | 项目ID | 是 | 系统为用户自动生成的项目ID，单击"我的凭证 \> API凭证"，根据项目获取。 | e9993fc787\*\*\*\*\*\*\*\*\*\*\*\*a340f9c0f4 | | 站点 | 是 | 站点。 | iam.cn-north-4.myhuaweicloud.com | #### 创建实例 通过创建实例，实例中会生成图片索引库，用来存放图片特征。 - 输入参数 用户配置创建实例执行动作，相关参数说明如[表2]所示。 表2创建实例输入参数说明 | 参数 | 必填 | 说明 | |:---|:---|:---| | 实例名称 | 是 | 要创建的实例名称，仅支持小写字母（a-z）、数字，横杠和下划线。以字母开头，长度在16位以内。 | | 模型名称 | 是 | 模型名称，支持如下模型名称，有下拉框和输入框模式： - common-search：通用图片搜索，适用于图片库中搜索相似内容或类别的图片。 - image-recommend：版权图片推荐，适用于版权摄影图片库中查找并推荐相同或相似版权图片。 - image-copyright：图片版权，适用于从海量图片库中快速识别侵权盗用图片。 | | 描述 | 否 | 图片描述。 | | 图片规格 | 否 | 实例的图片数量规格。默认为30000000（单位：张），当前仅支持默认规格。缺省值：30000000。 | | 图片标签 | 否 | 图片自定义标签，每个实例最多支持10个标签，自定义标签不支持英文字母大写。 | - 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表3]。 表3创建实例输出参数说明 | 参数 | 说明 | |:---|:---| | 模型名称 | 模型展示名或领域名称。 | | 描述 | 描述。 | | 注册时间 | 注册时间。 | | 过期时间 | 过期时间，-1表示永不过期。 | | 规格 | 实例的图片数量规格，默认为30000000（单位：张）。 | | 自定义标签 | 图片自定义标签。 | | 实例状态 | 实例的状态，有以下状态信息： - NORMAL：正常 - ARREARAGE：欠费 - CREATION：创建中 - CREATION_FAILED：创建失败 - DELETING：删除中 - DELETING_FAILED：删除失败 - ABNORMAL：异常 | | 实例名称 | 实例名称。 | | 错误码 | 调用失败时的错误码，调用成功时无此字段。 | | 错误信息 | 调用失败时的错误信息，调用成功时无此字段。 | #### 添加图片 将图片导入图片索引库，该图片可以是同一区域OBS桶内的图片或请求消息体里的图片，只有导入图片索引库的图片方可被搜索到。 - 输入参数 用户配置添加图片执行动作，相关参数说明如[表4]所示。 表4添加图片输入参数说明 | 参数 | 必填 | 说明 | |:---|:---|:---| | 实例名称 | 是 | 要创建的实例名称。 | | 上传图片 | 否 | 图片文件Base64编码字符串，仅支持JPEG/JPG/PNG/BMP格式，图片最小边不小于100px，最大边不超过2048px。 | | 图片ID | 否 | 图片ID，用于在实例模型中查找图片的身份标识。 | | 图片标签 | 否 | 图片自定义标签。格式为key：value对，所有图片的key总数最多不超过10个，但是每个key对应的value不限制个数，例如：key为动物，对应的value可以是猫、狗、鸟等多个。 | - 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表5]。 表5添加图片输出参数说明 | 参数 | 说明 | |:---|:---| | 调用结果 | 调用成功时表示调用结果， 调用失败时无此字段。 | | 错误码 | 调用失败时的错误码，调用成功时无此字段。 | | 错误信息 | 调用失败时的错误信息，调用成功时无此字段。 | #### 搜索图片 从图片索引库中搜索相似图片。 - 输入参数 用户配置搜索图片执行动作，相关参数说明如[表6]所示。 表6搜索图片输入参数说明 | 参数 | 必填 | 说明 | |:---|:---|:---| | 实例名称 | 是 | 要创建的实例名称。 | | 上传图片 | 否 | 图片文件Base64编码字符串，仅支持JPEG/JPG/PNG/BMP格式，图片最小边不小于100px，最大边不超过2048px。该参数与path二选一，如果两个参数都存在，则以file为主。 | | 图片ID | 否 | 图片库中的图片索引ID。 | | 检索图像的数量 | 否 | 返回被检索图像的数量，取值为1\~100的整数，默认为10，缺省值：10。 | | 起始索引 | 否 | 偏移量，指定搜索结果返回起始位置，取值为大于或等于0的整数，默认为0。 | | 图片自定义标签 | 否 | 图片自定义标签，最多不超过10个，格式为key：value对。 | | 指定区域搜索 | 否 | 是否用图片中指定区域（参数box）进行搜索。默认为false，该参数目前仅对某些特定模型有效，其他模型暂不支持目标检测。 - true：用图片中指定区域（参数box）进行搜索。 - false：用全图进行搜索。缺省值：false。 | | x坐标 | 否 | 区域中x坐标的最小值，单位：像素。 | | y坐标 | 否 | 区域中y坐标的最小值，单位：像素。 | | 宽度 | 否 | 区域的宽度，单位：像素。 | | 高度 | 否 | 区域的高度，单位：像素。 | - 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表7]。 表7搜索图片输出参数说明 | 参数 | 说明 | |:---|:---| | 结果总数 | 搜索结果总数。 | | 结果详情 | 搜索结果详情。 | | 图片路径 | 被搜索图片的路径。 | | 图片相似度 | 查询图片和被搜索图片的相似度，值越接近1表示越相似。 | | 标签名称和标签内容 | 自定义的标签名称和标签内容。 | | 错误码 | 调用失败时的错误码，调用成功时无此字段。 | | 错误信息 | 调用失败时的错误信息，调用成功时无此字段。 | #### 查询图片 通过图片路径查询索引库中对应图片是否存在。 - 输入参数 用户配置查询图片执行动作，相关参数说明如[表8]所示。 表8查询图片输入参数说明 | 参数 | 必填 | 说明 | |:---|:---|:---| | 实例名称 | 是 | 要创建的实例名称。 | | 图片ID | 否 | 图片库中的图片索引ID。 | - 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表9]。 表9查询图片输出参数说明 | 参数 | 说明 | |:---|:---| | 调用结果 | 调用成功时表示调用结果。 调用失败时无此字段。 | | 错误码 | 调用失败时的错误码，调用成功时无此字段。 | | 错误信息 | 调用失败时的错误信息，调用成功时无此字段。 | #### 删除图片 通过图片路径删除索引库中对应图片。 - 输入参数 用户配置删除图片执行动作，相关参数说明如[表10]所示。 表10删除图片输入参数说明 | 参数 | 必填 | 说明 | |:---|:---|:---| | 实例名称 | 是 | 要创建的实例名称。 | | 图片ID | 否 | 图片库中的图片索引ID。 | - 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表11]。 表11删除图片输出参数说明 | 参数 | 说明 | |:---|:---| | 调用结果 | 调用成功时表示调用结果。 调用失败时无此字段。 | | 错误码 | 调用失败时的错误码，调用成功时无此字段。 | | 错误信息 | 调用失败时的错误信息，调用成功时无此字段。 | #### 修改图片信息 修改图像索引库中已存在的图片信息。 - 输入参数 用户配置修改图片信息执行动作，相关参数说明如[表12]所示。 表12修改图片信息输入参数说明 | 参数 | 必填 | 说明 | |:---|:---|:---| | 实例名称 | 是 | 要创建的实例名称。 | | 图片ID | 是 | 图片库中的图片索引ID。 | | 图片标签 | 否 | 自定义标签，格式为key:value对，其中：标签名（key值）须存在于实例中，标签内容（value值）为自定义标签值。 | - 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表13]。 表13修改图片信息输出参数说明 | 参数 | 说明 | |:---|:---| | 调用结果 | 调用成功时表示调用结果。 调用失败时无此字段。 | | 错误码 | 调用失败时的错误码，调用成功时无此字段。 | | 错误信息 | 调用失败时的错误信息，调用成功时无此字段 | #### 删除实例 修改图像索引库中已存在的图片信息。 - 输入参数 用户配置删除实例执行动作，相关参数说明如[表14]所示。 表14删除实例输入参数说明 | 参数 | 必填 | 说明 | |:---|:---|:---| | 实例名称 | 是 | 要创建的实例名称。 | - 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表15]。 表15删除实例输出参数说明 | 参数 | 说明 | |:---|:---| | 调用结果 | 调用成功时表示调用结果， 调用失败时无此字段。 | | 错误码 | 调用失败时的错误码，调用成功时无此字段。 | | 错误信息 | 调用失败时的错误信息，调用成功时无此字段 | #### 查询用户实例信息 查看用户指定实例详细信息。 - 输入参数 用户配置查询用户实例信息执行动作，相关参数说明如[表16]所示。 表16查询用户实例信息输入参数说明 | 参数 | 必填 | 说明 | |:---|:---|:---| | 实例名称 | 是 | 要创建的实例名称。 | - 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考[表17]。 表17查询用户实例信息输出参数说明 | 参数 | 说明 | |:---|:---| | 模型名称 | 模型展示名或领域名称。 | | 描述 | 描述。 | | 注册时间 | 注册时间。 | | 过期时间 | 过期时间，-1表示永不过期。 | | 规格 | 实例的图片数量规格，默认为：30,000,000（单位：张）。 | | 自定义标签 | 图片自定义标签。 | | 实例状态 | 实例的状态，有以下状态信息： - NORMAL：正常 - ARREARAGE：欠费 - CREATION：创建中 - CREATION_FAILED：创建失败 - DELETING：删除中 - DELETING_FAILED：删除失败 - ABNORMAL：异常 | | 实例名称 | 实例名称。 | | 错误码 | 调用失败时的错误码，调用成功时无此字段。 | | 错误信息 | 调用失败时的错误信息，调用成功时无此字段。 |