本文档介绍添加图片数据AddImage的语法及示例。

功能描述

AddImage可以为指定数据库添加图片数据。

说明 每个数据库最多可以添加5万张图片。

前提条件

请确保您已开通视觉搜索服务,若未开通服务请立即开通

输入限制

  • 图片格式:JPG、JPEG、PNG。
  • 图片大小:输入图片大小不超过2M。
  • 图片分辨率:大于128×128像素,小于1024×1024像素。
  • URL地址不能包含中文字符。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String AddImage

要执行的操作。取值:AddImage。

DbName String default

数据库名称。支持小写字母、数字、下划线组合,长度2~64。

EntityId String 001

实体ID,可以作为数据分组的ID。支持小写字母、数字、下划线的组合,长度1~64。

ExtraData String 风景

自定义数据。支持字母、数据、标点符号、汉字。长度0~512。

ImageUrl String https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/imgsearch/003.png

图片URL地址。当前仅支持上海地域的OSS链接,如何生成URL请参见生成URL

返回数据

名称 类型 示例值 描述
Data Struct

返回的结果数据内容。

DataId String 1585903814940000

数据ID。

RequestId String 4DC6BB62-06D1-4242-939A-4AC500662E33

请求ID。

示例

请求示例

http(s)://imgsearch.cn-shanghai.aliyuncs.com/?Action=AddImage
&DataId=1
&DbName=default
&EntityId=001
&ExtraData=风景
&ImageUrl=https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/imgsearch/003.png
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>4DC6BB62-06D1-4242-939A-4AC500662E33</RequestId>
<Data>
    <DataId>1585903814940000</DataId>
</Data>

JSON 格式

{
	"RequestId": "4DC6BB62-06D1-4242-939A-4AC500662E33",
	"Data": {
		"DataId": "1585903814940000"
	}
}

错误码

关于添加图片数据的错误码,详情请参见常见错误码

SDK参考

阿里云视觉AI能力支持使用SDK调用,具体可参见SDK总览下载安装。

安全声明

  • 请确保上传的图片或文件来源符合相应的法律法规。
  • 通过体验调试上传的临时文件有效期为1小时,在24小时后会被系统自动清理删除。