场所识别 API 文档

接口说明

场所识别，支持识别80多类通用场所，包括会议室、广场、航站楼等。支持返回结果的结构化数据，调用简单，只需上传单张图片，秒级别获取识别结果。广泛应用于拍照识图、幼教科普、图片分类等场景。

该能力是通过HTTP API的方式给开发者提供一个通用的接口，适用于一次性交互数据传输的AI服务场景，块式传输。相较于SDK，API具有轻量、跨语言的特点，不过请注意该接口使用的HTTP API协议不支持跨域。

#接口Demo

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

#接口要求

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

内容	说明
传输方式	http[s] (为提高安全性，强烈推荐https)
请求地址	http(s): //api.xf-yun.com/v1/private/s5833e7f6 注：服务器IP不固定，为保证您的接口稳定，请勿通过指定IP的方式调用接口，使用域名方式调用
请求行	POST /v1/private/ss5833e7f6
接口鉴权	签名机制，详情请参照下方鉴权认证
字符编码	UTF-8
响应格式	统一采用JSON格式
开发语言	任意，只要可以向讯飞云服务发起HTTP请求的均可
适用范围	任意操作系统，但因不支持跨域不适用于浏览器
图片格式	jpg/jpeg/png/bmp
图片大小	base64编码后大小不超过4M

#接口调用流程

• 通过接口密钥基于hmac-sha256计算签名，将签名以及其他参数加在请求地址后面。详见下方 鉴权认证 。
• 将请求参数以及图片数据放在Http Request Body中，以POST表单的形式提交，详见下方 请求参数 。
• 向服务器端发送Http请求后，接收服务器端的返回结果。

#鉴权认证

在调用业务接口时，请求方需要对请求进行签名，服务端通过签名来校验请求的合法性。

#鉴权方法

通过在请求地址后面加上鉴权相关参数的方式，参数具体如下：

http示例url：

https://api.xf-yun.com/v1/private/s5833e7f6?authorization=YXBpX2tleT0iYXBpa2V5WFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFgiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iOFdRZmlVekMyWGNBS2dXZ2tGTFNmVktwZ1lPWHYyUXNGS01ORG5sQmtJVT0i&host=api.xf-yun.com&date=Wed%2C+09+Dec+2020+03%3A18%3A48+GMT

鉴权参数：

参数	类型	必须	说明	示例
host	string	是	请求主机	api.xf-yun.com
date	string	是	当前时间戳，RFC1123格式("EEE, dd MMM yyyy HH:mm:ss z")	Wed, 09 Dec 2020 03:18:48 GMT
authorization	string	是	使用base64编码的签名相关信息(签名基于hamc-sha256计算)	参考下方详细生成规则

• date参数生成规则：

date必须是UTC+0或GMT时区，RFC1123格式(Wed, 09 Dec 2020 03:18:48 GMT)。
服务端会对date进行时钟偏移检查，最大允许300秒的偏差，超出偏差的请求都将被拒绝。

• authorization参数生成格式：

1）获取接口密钥APIKey 和 APISecret。
在讯飞开放平台控制台，创建一个应用后打开人脸比对页面可以获取，均为32位字符串。

2）参数authorization base64编码前（authorization_origin）的格式如下。

api_key="$api_key",algorithm="hmac-sha256",headers="host date request-line",signature="$signature"

其中 api_key 是在控制台获取的APIKey，algorithm 是加密算法（仅支持hmac-sha256），headers 是参与签名的参数（见下方注释）。
signature 是使用加密算法对参与签名的参数签名后并使用base64编码的字符串，详见下方。

*注：* headers是参与签名的参数，请注意是固定的参数名（"host date request-line"），而非这些参数的值。

3）signature的原始字段(signature_origin)规则如下。

signature原始字段由 host，date，request-line三个参数按照格式拼接成，
拼接的格式为(\n为换行符,’:’后面有一个空格)：

host: $host\ndate: $date\n$request-line

假设

请求url = api.xf-yun.com
date = Wed, 09 Dec 2020 03:18:48 GMT

那么 signature原始字段(signature_origin)则为：

host: api.xf-yun.com
date: Wed, 09 Dec 2020 03:18:48 GMT
POST /v1/private/s5833e7f6 HTTP/1.1

4）使用hmac-sha256算法结合apiSecret对signature_origin签名，获得签名后的摘要signature_sha。

signature_sha=hmac-sha256(signature_origin,$apiSecret)

其中 apiSecret 是在控制台获取的APISecret

5）使用base64编码对signature_sha进行编码获得最终的signature。

signature=base64(signature_sha)

假设

APISecret = apisecretXXXXXXXXXXXXXXXXXXXXXXX    
date = Wed, 09 Dec 2020 03:18:48 GMT

则signature为

signature=1gWRhcJRcOEJyWzoHZkHxxBgXEp0NCFHrPOoFJXu6M0=

6）根据以上信息拼接authorization base64编码前（authorization_origin）的字符串，示例如下。

api_key="apikeyXXXXXXXXXXXXXXXXXXXXXXXXXX", algorithm="hmac-sha256", headers="host date request-line", signature="1gWRhcJRcOEJyWzoHZkHxxBgXEp0NCFHrPOoFJXu6M0="

注： headers是参与签名的参数，请注意是固定的参数名（"host date request-line"），而非这些参数的值。

7）最后再对authorization_origin进行base64编码获得最终的authorization参数。

authorization = base64(authorization_origin)
示例：
authorization=YXBpX2tleT0iYXBpa2V5WFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFgiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iOFdRZmlVekMyWGNBS2dXZ2tGTFNmVktwZ1lPWHYyUXNGS01ORG5sQmtJVT0i

#鉴权结果

如果鉴权失败，则根据不同错误类型返回不同HTTP Code状态码，同时携带错误描述信息，详细错误说明如下：

HTTP Code	说明	错误描述信息	解决方法
401	缺少authorization参数	{"message":"Unauthorized"}	检查是否有authorization参数，详情见authorization参数详细生成规则
401	签名参数解析失败	{“message”:”HMAC signature cannot be verified”}	检查签名的各个参数是否有缺失是否正确，特别确认下复制的api_key是否正确
401	签名校验失败	{“message”:”HMAC signature does not match”}	签名验证失败，可能原因有很多。 1. 检查api_key,api_secret 是否正确。 2.检查计算签名的参数host，date，request-line是否按照协议要求拼接。 3. 检查signature签名的base64长度是否正常(正常44个字节)。
403	时钟偏移校验失败	{“message”:”HMAC signature cannot be verified, a valid date or x-date header is required for HMAC Authentication”}	检查服务器时间是否标准，相差5分钟以上会报此错误

认证失败返回示例：

HTTP/1.1 403 Forbidden
Date: Thu, 06 Dec 2018 07:55:16 GMT
Content-Length: 116
Content-Type: text/plain; charset=utf-8
{
    "message": "HMAC signature does not match"
}

payload.result.text字段base64解码后具体信息如下，其中各元素及结果请关注：

参数名	类型	描述	备注
place	array	场所分类结果
place[n].frameID	int	图像帧号	预留字段，无需特别关注
place[n].startTimeOffset	float	开始时间偏移量	预留字段，无需特别关注
place[n].entity	array	top-n分类结果	图像的top-n分类结果，按置信度由高到低排序
place[n].entity[n].score	float	置信度	当前分类结果的置信度（范围：0-1），0代表置信度最低，1代表置信度最高
place[n].entity[n].name	string	类别名	当前分类结果的类别名，详见下方场所分类列表。
place[n].entity[n].id	int	类别号	当前分类结果的类别号，详见下方场所分类列表。

场所分类列表：

id	类别名name	id	类别名name	id	类别名name	id	类别名name
0	航站楼 airport_terminal	21	田地/农场 farm/farm_field	42	售票处 ticket_booth	63	树林 forest
1	停机坪 landing_field	22	果园菜园 orchard/vegetable	43	露营地 campsite	64	桥 bridge
2	机舱 airplane_cabin	23	牧场 pasture	44	音乐工作室 music_studio	65	住宅 residential_neighborhood
3	游乐场 amusement_park	24	乡村 countryside	45	电梯/楼梯 elevator/staircase	66	汽车展厅 auto_showroom
4	冰场 skating_rink	25	温室 greenhouse	46	公园/花园 garden	67	河流湖泊 lake/river
5	舞台 arena/performance	26	电视台 television_studio	47	建筑工地 construction_site	68	水族馆 aquarium
6	艺术室 art_room	27	亚洲寺庙 templeeast_asia	48	综合超市 general_store	69	沟渠 aqueduct
7	流水线 assembly_line	28	亭子 pavilion	49	商店 specialized_shops	70	宴会厅 banquet_hall
8	棒球场 baseball_field	29	塔 tower	50	集市 bazaar	71	卧室 bedchamber
9	橄榄球场 football_field	30	宫殿 palace	51	图书馆/书店 library/bookstore	72	山 mountain
10	足球场 soccer_field	31	西式教堂 church	52	教室 classroom	73	站台 station/platform
11	排球场 volleyball_court	32	街道 street	53	海洋/沙滩 ocean/beach	74	草地 lawn
12	高尔夫球场 golf_course	33	餐厅食堂 dining_room	54	消防 firefighting	75	育儿室/幼儿园 nursery
13	田径场 athletic_field	34	咖啡厅 coffee_shop	55	加油站 gas_station	76	美容/美发店 beauty_salon
14	滑雪场 ski_slope	35	厨房 kitchen	56	垃圾场 landfill	77	修理店 repair_shop
15	篮球馆(场) basketball_court	36	广场 plaza	57	阳台 balcony	78	斗牛场 rodeo
16	健身房 gymnasium	37	实验室 laboratory	58	游戏室/娱乐室 recreation_room	79	雪屋/冰雕 igloo/ice_engraving
17	保龄球馆 bowling_alley	38	酒吧 bar	59	舞厅 discotheque	80	车内 in_car
18	游泳池 swimming_pool	39	会议室 conference_room	60	博物馆 museum	81	客厅 living_room
19	拳击场 boxing_ring	40	办公室 office	61	沙漠 desert/sand	82	浴室/盥洗室 bath_room
20	跑马场 racecourse	41	医院 hospital	62	漂流 raft	83	其它 others

返回参数示例：

{
    "header": {
        "code": 0,
        "message": "success",
        "sid": "ase000d60a0@hu176465263c60212882"
    },
    "payload": {
        "result": {
            "compress": "raw",
            "encoding": "utf8",
            "format": "json",
            "text": "eyJwbGFjZSI6..."
        }
    }
}

base64解码后的text示例：

{
    "place": [{
        "frameID": 0,
        "startTimeOffset": 0.0,
        "entity": [{
            "score": 0.99022954702377319,
            "name": "swimming_pool",
            "id": 18
        }]
    }]
}

#错误码

备注：如出现下述列表中没有的错误码，可到 这里 查询。

错误码	错误描述	说明	处理策略
10009	input invalid data	输入数据非法	检查输入数据
10010	service license not enough	没有授权许可或授权数已满	请到控制台提交工单联系技术人员
10019	service read buffer timeout, session timeout	session超时	检查是否数据发送完毕但未关闭连接
10114	session timeout	session 超时	会话时间超时，检查是否发送数据时间超过了60s
10139	invalid param	参数错误	检查参数是否正确
10160	parse request json error	请求数据格式非法	检查请求数据是否是合法的json
10161	parse base64 string error	base64解码失败	检查发送的数据是否使用base64编码了
10163	param validate error:...	参数校验失败	具体原因见详细的描述
10200	read data timeout	读取数据超时	检查是否累计10s未发送数据并且未关闭连接
10223	RemoteLB: can't find valued addr	lb 找不到节点	请到控制台提交工单联系技术人员
10313	invalid appid	appid和apikey不匹配	检查appid是否合法
10317	invalid version	版本非法	请到控制台提交工单联系技术人员
10700	not authority	引擎异常	按照报错原因的描述，对照开发文档检查输入输出，如果仍然无法排除问题，请提供sid以及接口返回的错误信息，到控制台提交工单联系技术人员排查。
11200	auth no license	功能未授权	请先检查appid是否正确，并且确保该appid下添加了相关服务。若没问题，则按照如下方法排查。 1. 确认总调用量是否已超越限制，或者总次数授权已到期，若已超限或者已过期请联系商务人员。 2. 查看是否使用了未授权的功能，或者授权已过期。
11201	auth no enough license	该APPID的每日交互次数超过限制	根据自身情况提交应用审核进行服务量提额，或者联系商务购买企业级正式接口，获得海量服务量权限以便商用。

#调用示例

注: demo只是一个简单的调用示例，不适合直接放在复杂多变的生产环境使用

场所识别demo java语言

场所识别demo python语言

注： 其他开发语言请参照 接口调用流程 进行开发，也欢迎热心的开发者到 讯飞开放平台社区 分享你们的demo。

#常见问题

#场所识别支持一张图片、多个场所的情况识别吗？

答：目前场所识别接口暂不支持一张图片包含多个场所的识别，不建议进行这种情况的场所识别。

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

答：目前支持Web API应用平台。

#场所识别对图片有什么要求吗？

答：需要清晰的图片，格式为jpg/jpeg/png/bmp，同时图片大小base64编码后不要超过4M。

{
  "header": {
    "app_id": "XXXXXXXX",
    "status": 3
  },
  "parameter": {
    "s5833e7f6": {
      "func": "image/place",
      "result": {
        "encoding": "utf8",
        "compress": "raw",
        "format": "json"
      }
    }
  },
  "payload": {
    "data1": {
      "encoding": "jpg",
      "status": 3,
      "image": "/4AAQSkZJRgA..."
    },
  }
}

{
  "header": {
    "code": 0,
    "message": "success",
    "sid": "ase000d60a0@hu176465263c60212882"
  },
  "payload": {
    "result": {
      "compress": "raw",
      "encoding": "utf8",
      "format": "json",
      "text": "eyJwbGFjZSI6..."
    }
  }
}