# 场景识别 API 文档

# 接口说明

场景识别，可以精准识别自然环境下数十种场景，让智能相册管理、照片检索和分类，等基于场景的应用展现得更加直观。
该能力是通过HTTP API的方式给开发者提供一个通用的接口，适用于一次性交互数据传输的AI服务场景，块式传输。相较于SDK，API具有轻量、跨语言的特点，不过请注意该接口使用的HTTP API协议不支持跨域。

# 接口Demo

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

# 接口要求

集成场景识别API时，需按照以下要求。

# 接口调用流程

注： 若需配置IP白名单，请前往控制台。IP白名单规则请参照 IP白名单。

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

接口地址示例：

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

# 白名单

在调用该业务接口时

• 若关闭IP白名单，接口认为IP不限，不会校验IP。
• 若打开IP白名单，则服务端会检查调用方IP是否在讯飞开放平台配置的IP白名单中，对于没有配置到白名单中的IP发来的请求，服务端会拒绝服务。

IP白名单规则

• IP白名单，在 控制台-我的应用-相应服务的应用管理卡片上 编辑，保存后五分钟左右生效；
• 不同Appid的不同服务都需要分别设置IP白名单；
• IP白名单需设置为外网IP，请勿设置局域网IP；
• 如果服务器返回结果如下所示(illegal client_ip)，则表示由于未配置IP白名单或配置有误，服务端拒绝服务。

{
    "code":"10105",
    "desc":"illegal access|illegal client_ip",
    "data":"",
    "sid":"xxxxxx"
}

# 接口请求参数

# 请求头

在 Http Request Header 中配置以下参数。

# 授权认证

以下参数用于授权认证：

注：

• 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参数，第二种将图片二进制数据写入请求体中。若同时设置，以第一种为准。

X-Param生成示例：

	原始JSON串：
	{
	    "image_name": "img.jpg"，
		"image_url":""
	}
	BASE64编码（即X-Param）：
	eyJlbmdpbmVfdHlwZSI6InNtczE2ayIsImF1ZSI6InJhdyJ9

# 请求体

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

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

# 接口返回参数

返回值为 json 串，各字段如下：

data字段说明：

label值范围及对应场景：

结果示例如下：

失败结果：

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

成功结果：

	{
	    "code":"0",
	    "data":{
	        "fileList":[
	            {
	                "label":22,
	                "labels":[
	                    22,
	                    18,
	                    19,
	                    0,
	                    12
	                ],
	                "name":"img.jpg",
	                "rate":0.9624900221824646,
	                "rates":[
	                    0.9624900221824646,
	                    0.03550189360976219,
	                    0.0009935186244547367,
	                    0.00045110780047252774,
	                    0.00023404983221553266
	                ],
	                "review":false,
	                "tag":"Local Image"
	            }
	        ]
	    },
	    "desc":"success",
	    "sid":"tup00000001@ch3d9c0f04d71e6a6b00"
	}

# 调用示例

场景识别demo go语言

场景识别demo php语言

场景识别demo java语言

场景识别demo python3语言

场景识别demo c#语言

# 场景识别的主要功能是什么？

答:精准识别自然环境下数十种场景，让智能相册管理、照片检索和分类，等基于场景的应用展现得更加直观。

# 场景的类别有哪些？

答:对实际应用场景分为室内、室外、自然风景和其他四大分类，每个分类都会按照实际场景细分为多个类别。

# 场景识别支持什么应用平台？

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

# 场景识别如何试用？

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