# 物体识别 API 文档

# 接口说明

物体识别,采用全球领先的通用物体检测算法,有效检测图像中的动物、交通工具、生活家具等2万多种生活常见物体。
该能力是通过HTTP API的方式给开发者提供一个通用的接口,适用于一次性交互数据传输的AI服务场景,块式传输。相较于SDK,API具有轻量、跨语言的特点,不过请注意该接口使用的HTTP API协议不支持跨域。

# 接口Demo

示例demo请点击 这里 下载。
目前仅提供部分开发语言的demo,其他语言请参照下方接口文档进行开发。
也欢迎热心的开发者到 讯飞开放平台社区 分享你们的demo。

# 接口要求

集成物体识别API时,需按照以下要求。

内容 说明
请求协议 http
请求地址 http://tupapi.xfyun.cn/v1/currency
注:服务器IP不固定,为保证您的接口稳定,请勿通过指定IP的方式调用接口,使用域名方式调用
请求方式 POST
接口鉴权 签名机制,见授权认证
字符编码 UTF-8
响应格式 统一采用JSON格式
开发语言 任意,只要可以向讯飞云服务发起HTTP请求的均可
适用范围 任意操作系统,但因不支持跨域不适用于浏览器,请在后端调用接口
图片格式 .png、.jpg、.jpeg、.bmp、.tif
图片大小 大小不超过800k

# 接口调用流程

注: 调用接口前需配置IP白名单,IP白名单规则请参照 IP白名单

  1. 通过接口密钥基于MD5计算签名,将签名以及其他参数放在Http Request Header中,详见下方 请求头
  2. 将图片数据放在Http Request Body中,以POST表单的形式提交,详见下方 请求体
  3. 向服务器端发送Http请求后,接收服务器端的返回结果,返回结果详见各接口的详细说明。

接口地址示例:

	POST http://tupapi.xfyun.cn/v1/currency

# 白名单

在调用该业务接口时,授权认证通过后,服务端会检查调用方IP是否在讯飞开放平台配置的IP白名单中,对于没有配置到白名单中的IP发来的请求,服务端会拒绝服务。
注:

  • IP白名单,在 控制台-我的应用-相应服务的应用管理卡片上 编辑,保存后五分钟左右生效;
  • 不同Appid的不同服务都需要分别设置IP白名单;
  • 每个IP白名单最多可设置5个IP,IP为外网IP,请勿设置局域网IP;
  • 如果服务器返回结果如下所示(illegal client_ip),则表示由于未配置IP白名单或配置有误,服务端拒绝服务。解决办法请参考 IP白名单问题汇总
{
    "code":"10105",
    "desc":"illegal access|illegal client_ip",
    "data":"",
    "sid":"xxxxxx"
}

# 接口请求参数

# 请求头

Http Request Header 中配置以下参数。

# 授权认证

以下参数用于授权认证:

参数 格式 说明 必须
X-Appid string 讯飞开放平台注册申请应用的应用ID(appid)
X-CurTime string 当前UTC时间戳
从1970年1月1日0点0 分0 秒开始到现在的秒数
X-Param string 相关参数JSON串经Base64编码后的字符串,详见业务参数
X-CheckSum string 令牌,计算方法:MD5(APIKey + X-CurTime + X-Param),三个值拼接的字符串,进行MD5哈希计算(32位小写)

注:

  • APIKey:接口密钥,在讯飞开放平台控制台添加相应服务后即可获取,调用方注意保管,如泄露,可到控制台提交工单联系技术人员重置;
  • X-CheckSum 有效期:出于安全性考虑,每个 X-CheckSum 的有效期为 5 分钟(用 X-CurTime 计算),同时 X-CurTime 要与标准时间同步,否则时间相差太大,服务端会直接认为 X-CurTime 无效;
  • BASE64 编码采用 MIME 格式,字符包括大小写字母各26个,加上10个数字,和加号 + ,斜杠 / ,一共64个字符。

*X-CheckSum *生成示例:

String APIKey="abcd1234"; 
String X-CurTime="1502607694";
String X-Param="eyAiYXVmIjogImF1ZGlvL0wxNjtyYXR...";
String X-CheckSum=MD5(apiKey + X-CurTime + X-Param);

# 业务参数

X-Param 为各配置参数组成的 JSON 串经 BASE64 编码之后的字符串,原始 JSON 串各字段说明如下:

参数 类型 必填 说明 备注
image_url string 图片下载链接 采用请求头设置image_url参数传入图片时填此参数
image_name string 图片名称 image_url方式和Body传图片方式都需要设置图片名称,例如:img.jpg

注意:图片数据可以通过两种方式上传,第一种在请求头设置image_url参数,第二种将图片二进制数据写入请求体中。若同时设置,以第一种为准。

X-Param生成示例:

	原始JSON串:
	{
	    "image_name": "img.jpg",
		"image_url":""
	}
	BASE64编码(即X-Param):
	eyJlbmdpbmVfdHlwZSI6InNtczE2ayIsImF1ZSI6InJhdyJ9

# 请求体

以POST表单的形式提交以下参数:

将图片的二进制数据写入 Http Request Body 中

# 接口返回参数

返回值为 json 串,各字段如下:

JSON字段 类型 说明
code string 结果码(具体见SDK&API错误码查询)
data array 识别结果
desc string 错误描述,会话成功为success
sid string 会话ID,用来唯一标识本次会话,如会话报错无法解决,可以通过工单提供 sid 给讯飞技术人员分析解决。

data字段说明:

JSON字段 类型 说明
label number 大于等于0时,表明图片属于哪个分类或结果;等于-1时,代表该图片文件有错误,或者格式不支持(gif图不支持)
labels array 表示前5个最可能类别的label
rate string 介于0-1间的浮点数,表示该图像被识别为某个分类的概率值,概率越高、机器越肯定
rates array 和labels对应,前5个最可能类别对应得分
name string 图片的url地址或名称
review bool 本次识别结果是否存在偏差,返回true时存在偏差,可信度较低,返回false时可信度较高,具体可参考rate参数值
tag string 图片标签,值为Local Image或Using Buffer(无实际意义)

label值范围较大,对应的物体类别达2万余个,文档不便表述,详细对照表请点击下载

结果示例如下:

失败结果:

    {
	    "code":"10106",
	    "data":[],
	    "desc":"invalid parameter|invalid X-Param",
	    "sid":"tup00000001@ch239c0ef594db6a6b00"
	}

成功结果:

	{
		"code":"0",
		"data":[
			{
				"label":19015,
				"labels":[
					19015,
					18927,
					18929,
					698,
					5588
				],
				"name":"img.jpg",
				"rate":0.10702908039093018,
				"rates":[
					0.10702908039093018,
					0.08567219227552414,
					0.0592394582927227,
					0.04257886856794357,
					0.04108942672610283
				],
				"review":true,
				"tag":"Local Image"
			}
		],
		"desc":"success",
		"sid":"tup00000005@ch2ee40efd592d6a6b00"
	}

# 调用示例

物体识别demo go语言

物体识别demo php语言

物体识别demo java语言

物体识别demo python3语言

物体识别demo c#语言

# 常见问题

# 物体识别的主要功能是什么?

答:全球领先的通用物体检测算法,有效检测图像中的动物、交通工具、生活家具等2万多种生活常见物体。

# 识别的物体有哪些?

答:识别的内容包括动物、交通工具、生活家具等2万多种生活常见物体,详细内容可查看接口文档。

# 物体识别支持什么应用平台?

答:目前场景识别支持Web api应用平台。

# 物体识别如何试用?

答:可以的,登录讯飞开放平台---控制台---我的应用(没有应用先创建一个应用)---图像识别---场景识别(可免费调用Webapi接口共500次服务量,授权期限1个月)