华为仅提供AI基础能力，如需应用于医学、政治等敏感领域，请开发者务必声明华为HiAI仅提供基础能力。

AI对软件和硬件要求如下：软件：EMUI 8.1.0.108(C00)+ 硬件：Kirin 970+当前支持机型有：P20、 P20pro、 MateRS 、Honor 10 、 Honor play、 Nova3、Mate10（EMUI8.1）、Mate 10 pro（EMUI8.1）

AI能力保证向后兼容性，例如P20 EMUI8.1支持的所有AI能力在后续版本中依然支持。后续Mate系列、P系列、荣耀系列、Nova系列、麦芒系列旗舰机都会支持AI能力。

接口声明

{"name": "system.ai"}

导入模块

在调用接口页面的<script>部分增加如下配置。

import ai from '@system.ai'

或

var ai = require("@system.ai")

使用限制

限制条件	说明
适用终端	手机、平板、智慧屏
适用区域	全球

接口定义

接口	描述
ai.detectAestheticsScore(OBJECT)	美学评分：从多维度判断图像质量，为图像打分。
ai.detectFace(OBJECT)	人脸检测：检测图片中的人脸，返回高精度人脸矩形框坐标。
ai.faceCompare(OBJECT)	人脸比对：通过识别并提取人脸特征，对人像进行高精度比对，给出置信度分数，判断对象是否为同一个人。
ai.detectLabel(OBJECT)	图片分类标签：基于深度学习方法，识别图片中物体、场景、行为等信息，返回对应标签信息，如：花、鸟、鱼、虫、汽车、建筑等等。
ai.superImageResolution(OBJECT)	图像超分辨率：给定单一一张图片，使用智能方法将其放大，令其分辨率更高，得到比传统放大更加清晰的细节纹理。或者在分辨率不变的情况下，去除压缩噪声，获得更加锐利、干净的图片。
ai.superTextImageResolution(OBJECT)	文字图像超分辨率：对包含文字内容的图像进行放大，同时显著增强图像中文字的清晰度。
ai.detectDoc(OBJECT)	文档检测：识别图片中的文档，返回文档在原图中的位置信息，返回结果可做为文档校正API的输入参数。
ai.refineDoc(OBJECT)	文档校正：根据文档在原始图片中的位置信息校正文档的拍摄角度（可自定义校正的区域）。
ai.detectText(OBJECT)	OCR光学字符识别(Optical Character Recognition)：提取图片中的文字信息。
ai.imageSegmentation(OBJECT)	人像分割，是指的将图片中的人像和背景进行分离，分成不同的区域，用不同的标签进行区分。图像语义分割，是指对图像中的物体进行像素级的分割，从而获得图像中物体的类别信息以及精确位置信息，对不属于所支持的多类物体的部分，则标为“背景”，当前支持3类物体的识别和分割，人、天空、绿植（包括草地、树）。
ai.detectHeadPose(OBJECT)	人脸朝向识别：基于可见光图像利用图像识别技术检测平面内人脸朝上、人脸朝右、人脸朝下、人脸朝左、无人脸共五个类别信息。
ai.parseFace(OBJECT)	人脸解析：将人的头部包含人脸五官构成进行分解，得到头发、面部皮肤、眼睛、眉毛、鼻子、嘴、耳朵等区域。
ai.detectFaceAttributes(OBJECT)	人脸属性（性别）：对输入图片中的人脸做属性识别，给出人脸的性别属性。
ai.detectFaceLandMark(OBJECT)	五官特征检测：对输入图像进行人脸五官特征检测，返回代表五官轮廓位置的关键点坐标（目前数量为68个landmark点）。
ai.getAssistantIntention(OBJECT)	助手类意图识别：是指利用机器学习技术对用户发送给设备的文本消息进行意图分析和识别。
ai.getChatIntention(OBJECT)	IM类意图识别：是指利用机器学习技术对文本消息进行意图分析和识别。
ai.getWordPos(OBJECT)	词性标注：对一个文本自动分词并给出词性。
ai.getWordSegment(OBJECT)	分词：将一个汉字序列切分成一个一个单独的词。
ai.getEntity(OBJECT)	实体识别：识别文本中具有特定意义的实体。
ai.detectBarcode(OBJECT)	码检测：通过识别二维码、条码得到码中包含的信息。
ai.startRecognize(OBJECT)	开始语音识别。
ai.stopRecognize(OBJECT)	停止语音识别。
ai.cancelRecognize(OBJECT)	取消语音识别。
ai.canIUse(OBJECT)	判断当前环境下是否支持AI的接口。

[h2]ai.detectAestheticsScore(OBJECT)

描述

美学评分：从多维度判断图像质量，为图像打分。不仅能对图像的失焦、抖动等技术因素进行评价，还可以从歪斜、色彩、构图等角度评判主观“美”的感受。

建议输入图片大小不超过2000万像素，超过2000万像素会自动压缩，影响图片质量。

OBJECT参数

参数	类型	是否必填	说明
uri	string	是	源文件的uri，仅支持本地路径。应用内部资源，或者“internal:///”格式路径。
success	function	否	成功回调。
fail	function	否	失败回调，具体请参见“常见错误码”。
complete	function	否	执行结束后的回调。

success返回值：

参数	类型	说明
score	Number	结果评分，范围0 ~ 100，值越大图片质量越高。

示例代码

ai.detectAestheticsScore ({
    uri: "internal://temp/xxxx",
    success: function (data) {
        console.log("handling success: " + data.score)
    },
    fail: function (data, code) {
        console.log("handling fail, code: " + code)
    },
    complete: function () {
        console.log("handling complete")
    }
})

[h2]ai.detectFace(OBJECT)

描述

人脸检测：检测图片中的人脸，返回高精度人脸矩形框坐标。

建议输入图片大小不超过2000万像素，超过2000万像素会自动压缩，影响图片质量。

OBJECT参数

参数	类型	是否必填	说明
uri	string	是	源文件的uri，仅支持本地路径。应用内部资源，或者“internal:///”格式路径。
success	function	否	成功回调。
fail	function	否	失败回调，具体请参见“常见错误码”。
complete	function	否	执行结束后的回调。

success返回值：

参数	类型	说明
faces	object[]	人脸对象数组，详细内容请参见“faces参数说明”。
imageHeight	number	图片的高度。
imageWidth	number	图片的宽度。

faces参数说明：

参数	类型	说明
id	number	人脸ID，ID > 0。
probability	number	人脸置信度，范围-1及0 ~ 1， -1表示算法未提供置信度，值越大置信度越高。
faceRect	object	人脸在图片中的位置，详细内容请参见“faceRect参数说明”。
landmarks	object[]	特征点列表（左右眼中心、鼻子、左右嘴角），详细内容请参见“landmarks参数说明”。
yaw	number	左右旋转角度[-90(左), 90(右)]。
pitch	number	俯仰角度[-90(俯), 90(仰)]。
roll	number	平面内旋转角[-180(逆时针), 180(顺时针)]。

faceRect参数说明：

参数	类型	说明
left	number	人脸区域离左边界的距离。
top	number	人脸区域离上边界的距离。
width	number	人脸区域的宽度。
height	number	人脸区域的高度。

landmarks参数说明：

参数	类型	说明
type	number	特征点类型，详细内容请参见“type参数说明”。
position	object	特征点位置，详细内容请参见“position参数说明”。

type参数说明：

特征点类型	特征点类型值	特征点说明
LEFT_EYE	0	左眼中心位置。
RIGHT_EYE	1	右眼中心位置。
NOSE_BASE	2	鼻子位置。
LEFT_MOUTH_CORNER	3	左嘴角位置。
RIGHT_MOUTH_CORNER	4	右嘴角位置。

position参数说明：

参数	类型	说明
x	number	特征点x坐标。
y	number	特征点y坐标。

示例代码

ai.detectFace({
    uri: "internal://temp/xxxx",
    success: function (data) {
        console.log("detect data="+JSON.stringify(data))
    },
    fail: function (data, code) {
        console.log("handling fail, code: " + code)
    },
    complete: function () {
        console.log("handling complete")
    }
})

[h2]ai.faceCompare(OBJECT)

描述

人脸比对：通过识别并提取人脸特征，对人像进行高精度比对，给出置信度分数，判断对象是否为同一个人。

建议输入图片大小不超过2000万像素，超过2000万像素会自动压缩，影响图片质量。

OBJECT参数

参数	类型	是否必填	说明
uri1	string	是	第一张源文件的uri，仅支持本地路径。应用内部资源，或者“internal:///”格式路径。
uri2	string	是	第二张源文件的uri，仅支持本地路径。应用内部资源，或者“internal:///”格式路径。
success	function	否	成功回调。
fail	function	否	失败回调，具体请参见“常见错误码”。
complete	function	否	执行结束后的回调。

success返回值：

参数	类型	说明
samePerson	boolean	是否为同一人。
score	number	人脸比对的分数（0% ~ 100%，值越大置信度越高）。

示例代码

ai.faceCompare({
    uri1: "internal://temp/xx1",
    uri2: "internal://temp/xx2",
    success: function (data) {
        console.log("handling success: " + data.samePerson + data.socre)
    },
    fail: function (data, code) {
        console.log("handling fail, code: " + code)
    },
    complete: function () {
        console.log("handling complete")
    }
})

[h2]ai.detectLabel(OBJECT)

描述

图片分类标签：基于深度学习方法，识别图片中物体、场景、行为等信息，返回对应标签信息，如：花、鸟、鱼、虫、汽车、建筑等等。

建议输入图片大小不超过2000万像素，超过2000万像素会自动压缩，影响图片质量。
建议输入图片分辨率不小于224*224。

OBJECT参数

参数	类型	是否必填	说明
uri	string	是	源文件的uri，仅支持本地路径。应用内部资源，或者“internal:///”格式路径。
success	function	否	成功回调。
fail	function	否	失败回调，具体请参见“常见错误码”。
complete	function	否	执行结束后的回调。

success返回值：

参数	类型	说明
category	number	图片类别，详细内容请参见“category参数说明”。
categoryProbability	number	图片类别置信度。
labelContent	object[]	标签列表，详细内容请参见“labelContent参数说明”。

category参数说明：

类别ID	类别名称（英文）	类别名称（中文）
0	People	人像
1	Food	美食
2	Landscapes	风景
3	Documents	文档
4	Festival	节日
5	Activities	活动
6	Animal	动物
7	Sports	运动
8	Vehicle	交通工具
9	Household products	家居
10	Appliance	电器
11	Art	艺术
12	Tools	工具
13	Apparel	服饰
14	Accessories	配饰
15	Toy	玩具
16	Figure Action	动作
-2	Others	其他

labelContent参数说明：

参数	类型	说明
labelId	number	标签ID，详细内容请参见“标签类别定义”。
probability	number	标签置信度，范围：-1及 0 ~ 1，-1表示算法未提供置信度，值越大置信度越高。

标签类别定义：

类别ID	类别名称（英文）	类别名称（中文）
0	people	人像
1	food	美食
2	landscapes	风景
3	document	文档
4	id card	身份证
5	passport	护照
6	debit card	银行卡
7	bicycle	自行车
8	bus	巴士
9	ship	船
10	train	火车
11	airplane	飞机
12	automobile	汽车
13	bird	鸟
14	cat	猫
15	dog	狗
16	fish	鱼
18	wardrobe	衣柜
19	smartphone	手机
20	laptop	笔记本电脑
24	bridal veil	婚纱
25	flower	花朵
26	toy block	积木
27	sushi	寿司
28	barbecue	烧烤
29	banana	香蕉
31	watermelon	西瓜
32	noodle	面条
34	piano	钢琴
35	wedding	婚礼
36	playing chess	下棋
37	basketball	篮球
38	badminton	羽毛球
39	football	足球
40	city overlook	城市俯瞰
41	sunrise sunset	日出日落
42	ocean & beach	大海
43	bridge	桥
44	sky	天空
45	grassland	草地
46	street	街道
47	night	夜景
49	grove	树林
50	lake	湖泊
51	snow	雪
52	mountain	山
53	building	建筑
54	cloud	云
55	waterfall	瀑布
56	fog & haze	雾
57	porcelain	瓷器
58	model runway	模特
59	rainbow	彩虹
60	candle	蜡烛
62	statue of liberty	自由女神像
63	ppt	演示文稿
66	baby carriage	婴儿车
67	group photo	合影
68	dine together	聚餐
69	eiffel tower	埃菲尔铁塔
70	dolphin	海豚
71	giraffe	长颈鹿
72	penguin	企鹅
73	tiger	老虎
74	zebra	斑马
76	lion	狮子
77	elephant	大象
78	leopard	豹
79	peafowl	孔雀
80	blackboard	黑板
81	balloon	气球
83	air conditioner	空调
84	washing machine	洗衣机
85	refrigerator	冰箱
86	camera	相机
88	gun	枪
89	dress & skirt	裙子
91	uav	无人机
92	apple	苹果
93	dumpling	水饺
94	coffee	咖啡
95	grape	葡萄
96	hot pot	火锅
97	diploma	毕业照
102	watch	手表
103	glasses	眼镜
104	ferris wheel	摩天轮
105	fountain	喷泉
106	pavilion	亭子
107	fireworks	烟花
108	business card	名片
109	riding	骑马
110	music show	演唱会
111	sailboat	帆船
112	giant panda	大熊猫
113	birthday cake	生日蛋糕
114	birthday	生日
115	christmas	圣诞
116	the great wall	长城
117	oriental pearl tower	东方明珠
118	guangzhou tower	小蛮腰
120	tower	塔
121	rabbit	兔子
123	trolley case	拉杆箱
124	nail	美甲
125	guitar	吉他
128	yeah	剪刀手
129	swimming	游泳
130	Riding bicycletable	骑自行车
131	jump	跳跃
132	hug	拥抱
133	boating	划船
134	stonecrop familytable	多肉植物
135	trousers	长裤
136	mahjong	打麻将
137	handbag	手提包
138	Ring	戒指
139	bracelet	玉镯
140	Make a snowmantable	堆雪人
141	Flag raising ceremonytable	升旗仪式
142	Dragon dancetable	舞龙
143	Lion Dancetable	舞狮
144	Parent-childtable	亲子
145	Jellyfish	水母
146	turtle	龟
147	Brown beartable	棕熊
148	Black beartable	黑熊
149	Polar beartable	北极熊
150	ostrich	鸵鸟
151	parrot	鹦鹉
152	Flamingos	火烈鸟
153	chicken	鸡
154	duck	鸭
155	snails	蜗牛
156	Butterfly	蝴蝶
157	camel	骆驼
158	rhinocerostable	犀牛
159	Cows	奶牛
160	Deer	梅花鹿
161	horse	马
162	hippo	河马
163	Peking Opera Facetabletable	京剧脸谱
164	oil paintingtable	油画
165	calligraphytable	书法
166	sketch	素描
167	Drum	架子鼓
168	harp	竖琴
169	Flute	笛子
170	Buddha statuetable	佛像
171	Burger Kingtable	汉堡王
172	KFC	肯德基
173	Mcdonald	麦当劳
174	PizzaHut	必胜客
175	bra	胸罩
176	Bikini	比基尼
177	cheongsam	旗袍
178	Beijing Opera Costumetable	京剧戏服
179	deed	房产证
180	Account booktable	户口本
181	invoice	发票
182	Train tickettable	火车票
183	Air tickettable	飞机票
184	movie tickettable	电影票
185	Certificatetable	荣誉证书
186	Banner	锦旗
187	Hi word	喜字
188	Fu charactertable	福字
189	Red envelopetable	红包
190	Spring Festivaltable	春联
191	QR code	二维码
192	Bar code	条形码
193	Paper moneytable	纸币
194	coin	硬币
195	form	表格
196	menu	菜单
197	map	地图
198	Street signtable	路牌
199	License platetable	车牌
200	tablet	平板电脑
201	Water heatertable	热水器
202	Chinese Bunstable	包子
203	rice	米饭
204	Porridge	粥
205	Toast Breadtable	吐司面包
206	Moon cake	月饼
207	Pizza	披萨
208	Zongzi	粽子
209	beer	啤酒
210	red wine	红酒
211	milk	牛奶
212	egg	鸡蛋
213	Hamburger	汉堡
214	French Friestable	薯条
215	Sandwich	三明治
216	steak	牛排
217	Mango	芒果
218	peach	桃子
219	Kiwi	猕猴桃
220	pomegranatetable	石榴
221	Durian	榴莲
222	Crab	蟹
223	Lobsters	大龙虾
224	Crayfish	小龙虾
225	Base shrimptable	基围虾
226	Phi shrimptable	皮皮虾
227	Oysters	生蚝
228	scallop	扇贝
229	abalone	鲍鱼
230	onion	洋葱
231	corn	玉米
232	cucumber	黄瓜
233	Chinese cabbagetable	白菜
234	cabbage	卷心菜
235	Okra	秋葵
236	carrot	胡萝卜
237	White radishtable	白萝卜
238	potato	土豆
239	Sweet potatotable	地瓜
240	eggplant	茄子
241	Red chili	红辣椒
242	green peppertable	青椒
243	vase	花瓶
244	clock	钟表
245	table lamptable	台灯
246	floor lamptable	落地灯
247	fork	餐叉
248	Spoon	勺子
249	plate	盘子
250	bowl	碗
251	Toilet	马桶
252	Potala Palace in Lhasatable	拉萨布达拉宫
253	Sophia Church of Harbintable	哈尔滨索菲亚教堂
254	Macau Ruins of St Paul's Arch	澳门大三巴牌坊
255	Beijing Tiananmentabletable	北京天安门
256	Beijing National Stadium (Bird's Nest)	北京国家体育馆（鸟巢）table
257	Beijing National Swimming Center (Water Cube)table	北京国家游泳馆（水立方）table
258	Chongqing Jiefangbeitable	重庆解放碑
259	Kunming Dongsi Towertable	昆明东寺塔
260	Chengdu Covered Bridgetable	成都廊桥
261	Hong Kong Bank of China Tower	香港中银大厦
262	Yurt	蒙古包
263	Paris Arc de Triomphetable	巴黎凯旋门
264	Beijing Central Television Building	北京中央电视台大楼
265	Taipei 101 Buildingtabletable	台北 101 大厦
266	Suzhou Oriental Gatetable	苏州东方之门
267	bamboo foresttable	竹林
268	windmill	风车
269	Lipstick	口红
270	Liquid Foundationtabletable	粉底液
271	baseball	棒球运动
272	billiards	台球运动
273	Boxing	拳击运动
274	diving	潜水运动
275	fencing	击剑运动
276	ice hockeytable	冰球运动
277	pingpong	乒乓球运动
278	volleyballtable	排球运动
279	Treadmill	跑步机
280	skate	滑冰运动
281	ski	滑雪运动
282	high jump	跳高运动
283	long jump	跳远运动
284	pliers	钳子
285	Scissors	剪刀
286	ladder	梯子
287	Spanner	扳手
288	Binocularstable	双筒望远镜
289	Barbie dolltable	芭比娃娃
290	Toy gun	玩具枪
291	hot air balloontable	热气球
292	desktop	台式机
293	foliage	观叶植物
294	marriage certificatetable	结婚证
295	driver licensetable	驾驶证
296	Driving licensetable	行驶证
297	Shanghai World Expo Halltable	上海世博中国馆
298	Taekwondo	跆拳道运动
299	layout	设计图
300	hat	帽子
301	goose	鹅
302	cow	牛
303	pig	猪
304	sheep	羊
305	underwear	内裤
306	suit	西装
307	Excavator	挖掘机
308	ocean & beach & laketabletable	海湖景
-2	other	其它

示例代码

ai.detectLabel({
    uri: "internal://temp/xxx",
    success: function (data) {
        console.log("handling success: " + data.category +
        data.categoryProbability + data.labelContent[0].labelId + data.labelContent[0].probability)
    },
    fail: function (data, code) {
        console.log("handling fail, code: " + code)
    },
    complete: function () {
        console.log("handling complete")
    }
})

[h2]ai.superImageResolution(OBJECT)

描述

图像超分辨率：给定单一一张图片，使用智能方法将其放大，令其分辨率更高，得到比传统放大更加清晰的细节纹理。或者在分辨率不变的情况下，去除压缩噪声，获得更加锐利、干净的图片。

建议长边的像素数应大于0小于等于800，短边的像素数应大于0小于等于600，超过会自动压缩，影响图片质量。

OBJECT参数

参数	类型	是否必填	说明
uri	string	是	源文件的uri，仅支持本地路径。应用内部资源，或者“internal:///”格式路径。
scale	number	是	超分倍数，可选值为1.0或3.0，默认值为1.0 。
success	function	否	成功回调。
fail	function	否	失败回调，具体请参见“常见错误码”。
complete	function	否	执行结束后的回调。

success返回值：

参数	类型	说明
uri	string	超分辨率处理图片的路径(internal://mass//)。

示例代码

ai.superImageResolution({
    uri: "internal://tmp/xxx",
    scale: 1.0,
    success: function (data) {
        console.log("handling success: " + data.uri)
    },
    fail: function (data, code) {
        console.log("handling fail, code: " + code)
    },
    complete: function () {
        console.log("handling complete")
    }
})

[h2]ai.superTextImageResolution(OBJECT)

描述

文字图像超分辨率：对包含文字内容的图像进行放大，同时显著增强图像中文字的清晰度。

建议长边的像素数应大于0小于等于800，短边的像素数应大于0小于等于600，超过会自动压缩，影响图片质量。

OBJECT参数

参数	类型	是否必填	说明
uri	string	是	源文件的uri，仅支持本地路径。应用内部资源，或者“internal:///”格式路径。
success	function	否	成功回调。
fail	function	否	失败回调，具体请参见“常见错误码”。
complete	function	否	执行结束后的回调。

success返回值：

参数	类型	说明
uri	String	超分辨率处理图片的路径(internal://mass//)。

示例代码

ai.superTextImageResolution({
  uri: "internal://tmp/xxx",
  success: function (data) {
    console.log("handling success: " + data.uri)
  },
  fail: function (data, code) {
    console.log("handling fail, code: " + code)
  },
  complete: function () {
    console.log("handling complete")
  }
})

[h2]ai.detectDoc(OBJECT)

描述

文档检测：识别图片中的文档，返回文档在原图中的位置信息，返回结果可做为文档校正API的输入参数。

建议输入图片大小不超过2000万像素，超过2000万像素会自动压缩，影响图片质量。

OBJECT参数

参数	类型	是否必填	说明
uri	string	是	源文件的uri，仅支持本地路径。应用内部资源，或者“internal:///”格式路径。
success	function	否	成功回调。
fail	function	否	失败回调，具体请参见“常见错误码”。
complete	function	否	执行结束后的回调。

success返回值：

参数	类型	说明
topLeft	object	文档左上角坐标信息，详细内容请参见“坐标信息参数说明”。
topRight	object	文档左上角坐标信息，详细内容请参见“坐标信息参数说明”。
bottomLeft	object	文档左上角坐标信息，详细内容请参见“坐标信息参数说明”。
bottomRight	object	文档左上角坐标信息，详细内容请参见“坐标信息参数说明”。
imageWidth	number	图片宽度。
imageHeight	number	图片高度。

坐标信息参数说明：

参数	类型	说明
x	number	X轴坐标。
y	number	Y轴坐标。

示例代码

ai.detectDoc({
    uri: "internal://temp/xxx",
    success: function (data) {
        console.log("handling success: " + data.topLeft.x + " " + data.topRight.y)
    },
    fail: function (data, code) {
        console.log("handling fail, code: " + code)
    },
    complete: function () {
        console.log("handling complete")
    }
})

[h2]ai.refineDoc(OBJECT)

描述

文档校正：根据文档在原始图片中的位置信息校正文档的拍摄角度（可自定义校正的区域）。

建议像素不超过2000万，超过2000万接口会做缩放处理，因此图片质量会受影响。

OBJECT参数

参数	类型	是否必填	说明
uri	string	是	源文件的uri，仅支持本地路径。应用内部资源，或者“internal:///”格式路径。
coordinates	object	是	文档坐标信息，详细内容请参见“coordinates参数说明”。
success	function	否	成功回调。
fail	function	否	失败回调，具体请参见“常见错误码”。
complete	function	否	执行结束后的回调。

coordinates参数说明：

参数	类型	是否必填	说明
topLeft	object	是	文档左上角坐标信息，详细内容请参见“坐标信息参数说明”。
topRight	object	是	文档右上角坐标信息，详细内容请参见“坐标信息参数说明”。
bottomLeft	object	是	文档左下角坐标信息，详细内容请参见“坐标信息参数说明”。
bottomRight	object	是	文档右下角坐标信息，详细内容请参见“坐标信息参数说明”。

success返回值：

参数	类型	说明
uri	string	文档校正完成后的图片路径(internal://mass//)。

示例代码

ai.refineDoc({
    uri: "internal://temp/xxx",
    coordinates: {
        topLeft: {x : 0, y : 0},
        topRight: {x : 100, y : 100},
        bottomLeft: {x : 200, y : 200},
        bottomRight: {x : 400, y : 400}
    },
    success: function (data) {
        console.log("handling success: " + data.url)
    },
    fail: function (data, code) {
        console.log("handling fail, code: " + code)
    },
    complete: function () {
        console.log("handling complete")
    }
})

[h2]ai.detectText(OBJECT)

描述

OCR光学字符识别(Optical Character Recognition)：提取图片中的文字信息。

建议手机截屏OCR图片尺寸为：width最大为1440，height最大为15210，超过会自动压缩，影响图片质量。

OBJECT参数

参数	类型	是否必填	说明
uri	string	是	源文件的uri，仅支持本地路径。应用内部资源，或者“internal:///”格式路径。
roi	object	否	提取文字的矩形框区域，矩形框roi无效（right<=left \|\| left<0, bottom<=top \|\| top<0）。如果设置的right或bottom超过图片的边界或不设置roi，则默认取到图片的边界。详细内容请参见“roi区域参数说明”。
level	number	否	设置文本返回粒度，可选择值0（按文本块返回），1（按文本行返回），2（按文字字符返回），传入非可选值使用默认值为1。
success	function	否	成功回调。
fail	function	否	失败回调，具体请参见“常见错误码”。
complete	function	否	执行结束后的回调。

roi区域参数说明：

参数	类型	是否必填	说明
left	number	是	文本区域左坐标。
top	number	是	文本区域顶部坐标。
right	number	是	文本区域右坐标。
bottom	number	是	文本区域底部坐标。

success返回值：

参数	类型	说明
value	string	识别的所有文本内容，格式UTF8。
probability	number	置信度，范围[0,1]。
cornerPoints	object[]	文本区域四个角的位置，详细内容请参见“文本区域定点位置说明”。
blocks	object[]	文本块列表，详细内容请参见“文本块说明”。

文本区域定点位置说明：

参数	类型	说明
x	number	x 坐标值。
y	number	y 坐标值。

文本块说明：

参数	类型	说明
boundingBox	object	文本块区域位置，详细内容请参见“文本区域位置说明”。
cornerPoints	object[]	文本区域四个角的位置，详细内容请参见“文本区域定点位置说明”。
probability	number	置信度，范围[0,1]。
textLines	object[]	文本行列表，详细内容请参见“文本行说明”。
value	string	文本块内容。

文本行说明：

参数	类型	说明
lineRect	object	文本块区域位置，详细内容请参见“文本区域位置说明”。
cornerPoints	object[]	文本区域四个角的位置，详细内容请参见“文本区域定点位置说明”。
probability	number	置信度，范围[0,1]。
value	string	文本行内容。
elements	object[]	英文单词、中文列表（仅在level为2时出现），详细内容请参见“element参数说明”。

element参数说明：

参数	类型	说明
elementRect	object	文本块区域位置，详细内容请参见“文本区域位置说明”。
cornerPoints	object[]	文本区域四个角的位置，详细内容请参见“文本区域定点位置说明”。
probability	number	置信度，范围[0,1]。
value	string	文字内容。

约束

目前只支持提取手机截屏简单背景图片中的文字，自然场景图片和复杂背景的手机截屏，暂时不支持；
简单背景：文字背景为纯色；
支持的语言：中文和英文；
支持的字体：手机中常用的如思源黑体、黑体、宋体、楷体等。

示例代码

ai.detectText({
    uri: "internal://temp/xxx",
    roi: {
        left: 0,
        top: 100,
        right: 200,
        bottom: 400
    },
    level: 1,
    success: function (data) {
        console.log("handling success: " + data.value)
    },
    fail: function (data, code) {
        console.log("handling fail, code: " + code)
    },
    complete: function () {
        console.log("handling complete")
    }
})

[h2]ai.imageSegmentation(OBJECT)

描述

人像分割，是指的将图片中的人像和背景进行分离，分成不同的区域，用不同的标签进行区分。

图像语义分割，是指对图像中的物体进行像素级的分割，从而获得图像中物体的类别信息以及精确位置信息，对不属于所支持的多类物体的部分，则标为“背景”，当前支持3类物体的识别和分割，人、天空、绿植（包括草地、树）。

建议像素不超过1200万，超过1200万接口会做缩放处理，因此图片质量会受影响。

OBJECT参数

参数	类型	是否必填	说明
uri	string	是	源文件的uri，仅支持本地路径。应用内部资源，或者“internal:///”格式路径。
type	number	否	分割类型，默认为1。 0：人像分割 1：图像语义分割
success	function	否	成功回调。
fail	function	否	失败回调，具体请参见“常见错误码”。
complete	function	否	执行结束后的回调。

success返回值：

参数	类型	说明
uri	string	分割后图片的路径(internal://mass//)。

示例代码

ai.imageSegmentation ({
    uri: "internal://tmp/xxx",
    type: 0,
    success: function (data) {
        console.log("handling success: " + data.uri)
    },
    fail: function (data, code) {
        console.log("handling fail, code: " + code)
    },
    complete: function () {
        console.log("handling complete")
    }
})

[h2]ai.detectHeadPose(OBJECT)

描述

人脸朝向识别：基于可见光图像利用图像识别技术检测平面内人脸朝上、人脸朝右、人脸朝下、人脸朝左、无人脸共五个类别信息。

建议的图片尺寸为宽640像素，高480像素，不满足要求尺寸，会自动处理，图片质量可能受影响。

OBJECT参数

参数	类型	是否必填	说明
uri	string	是	源文件的uri，仅支持本地路径。应用内部资源，或者“internal:///”格式路径。
success	function	否	成功回调。
fail	function	否	失败回调，具体请参见“常见错误码”。
complete	function	否	执行结束后的回调。

success返回值：

参数	类型	说明
headpose	number	人脸朝向的类别编号[0 1 2 3 4]，详细内容请参见“headpose参数说明”。
confidence	number	置信度，范围[0,1]。

headpose参数说明：

字段值	说明
0	无人脸。
1	人脸朝上。
2	人脸朝右。
3	人脸朝下。
4	人脸朝左。

示例代码

ai. detectHeadPose ({
    uri: "internal://temp/xxxx",
    success: function (data) {
        console.log("handling success: headpose: " + data. headpose + " confidence: " + data. confidence)
    },
    fail: function (data, code) {
        console.log("handling fail, code: " + code)
    },
    complete: function (msg) {
        console.log("handling complete")
    }
})

[h2]ai.parseFace(OBJECT)

描述

人脸解析：将人的头部包含人脸五官构成进行分解，得到头发、面部皮肤、眼睛、眉毛、鼻子、嘴、耳朵等区域。

其长或宽都不得小于64像素，建议输入图片大小不超过1200w像素，超过1200万像素会自动压缩，影响图片质量。

OBJECT参数

参数	类型	是否必填	说明
uri	string	是	源文件的uri，仅支持本地路径。应用内部资源，或者“internal:///”格式路径。
success	function	否	成功回调。
fail	function	否	失败回调，具体请参见“常见错误码”。
complete	function	否	执行结束后的回调。

success返回值：

参数	类型	说明
uri	string	解析后的图片路径(internal://mass//)。

示例代码

ai.parseFace({
    uri: "internal://tmp/xxx",
    success: function (data) {
        console.log("handling success: " + data.uri)
    },
    fail: function (data, code) {
        console.log("handling fail, code: " + code)
    },
    complete: function () {
        console.log("handling complete")
    }
});

[h2]ai.detectFaceAttributes(OBJECT)

描述

人脸属性（性别）：对输入图片中的人脸做属性识别，给出人脸的性别属性。

建议输入图片大小不超过1300w像素，超过1300万像素会自动压缩，影响图片质量。

OBJECT参数

参数	类型	是否必填	说明
uri	string	是	源文件的uri，仅支持本地路径。应用内部资源，或者“internal:///”格式路径。
success	function	否	成功回调。
fail	function	否	失败回调，具体请参见“常见错误码”。
complete	function	否	执行结束后的回调。

success返回值：

参数	类型	说明
sex	string	性别。

示例代码

ai.detectFaceAttributes ({
    uri: "internal://tmp/xxx",
    success: function (data) {
        console.log("handling success: " + data.sex)
    },
    fail: function (data, code) {
        console.log("handling fail, code: " + code)
    },
    complete: function () {
        console.log("handling complete")
    }
})

[h2]ai.detectFaceLandMark(OBJECT)

描述

五官特征检测：对输入图像进行人脸五官特征检测，返回代表五官轮廓位置的关键点坐标（目前数量为68个landmark点）。

其长或宽都不得小于64像素，建议输入图片大小不超过1300w像素，超过1300万像素会自动压缩，影响图片质量。

OBJECT参数

参数	类型	是否必填	说明
uri	string	是	源文件的uri，仅支持本地路径。应用内部资源，或者“internal:///”格式路径。
success	function	否	成功回调。
fail	function	否	失败回调，具体请参见“常见错误码”。
complete	function	否	执行结束后的回调。

success返回值：

参数	类型	说明
marks	object[]	特征点列表（左右眼中心、鼻子、左右嘴角），详细内容请参见“marks参数说明”。

marks参数说明：

参数	类型	说明
type	number	特征点类型，详细内容请参见“特征类型说明”。
positionF	object	特征点位置(F表示float数据)，详细内容请参见“特征点位置说明”。

特征类型说明：

类型	说明
-1	未定义。
0	左眼中心位置。
1	右眼中心位置。
2	鼻子位置。
3	左嘴角位置。
4	右嘴角位置。

特征点位置说明：

参数	类型	说明
x	number	特征点x坐标。
y	number	特征点y坐标。

示例代码

ai.detectFaceLandMark ({
    uri: "internal://tmp/xxx",
    success: function (data) {
        console.log("handling success: " + data.marks)
    },
    fail: function (data, code) {
        console.log("handling fail, code: " + code)
    },
    complete: function () {
        console.log("handling complete")
    }
})

[h2]ai.getAssistantIntention(OBJECT)

描述

助手类意图识别：是指利用机器学习技术对用户发送给设备的文本消息进行意图分析和识别。

针对助手场景下的意图识别，分析用户的意图。分为系统设置类、出行类、生活类、娱乐类、联系社交类、手机应用控制类、系统应用操作类。目前支持类别以表格为准。

OBJECT参数

参数	类型	是否必填	说明
text	string	是	待分析的文本，文本长度不超过50个字符，文本要UTF-8格式，格式错误的不报错，分析结果会不正确。
category	string	否	需要分析的意图类别，默认分析所有类，多个用半角逗号”,”隔开，如需要系统设置类和出行类，传”systemSetting,trip”，详细内容请参见“意图说明”。
module	string	否	用于指定具体分析哪些意图模块，默认都分析。分析多个意图模块用半角逗号“,”隔开，如分析订火车票和订机票意图，传”bookTrainTicket,bookAirTicket”，详细内容请参见“intentions参数说明”。备注：分析时category与module取并集，如category为”systemSetting”，module为”bookTrainTicket”，则分析系统设置类的所有意图，以及订火车票”bookTrainTicket”意图。
success	function	否	成功回调。
fail	function	否	失败回调，具体请参见“常见错误码”。
complete	function	否	执行结束后的回调。

intentions参数说明：

参数	类型	是否必填	说明
name	string	否	意图名，如：“openWlan”。
attributes	object	否	意图对应的属性，详细内容请参见“意图说明”。

success返回值：

参数	类型	说明
message	string	描述执行结果信息。
intentions	object[]	意图列表、数组，详细内容请参见“intentions参数说明”。

意图说明：

意图类别

包含意图

具体的意图模块

systemSetting

详细请参见“助手类意图识别API说明”。

trip

订机票、退火车票、导航、查询地点。

bookAirTicket

bookTripTicket

navigation

queryPosition

contact

打电话。

call

示例代码

ai.getAssistantIntention({
  text: '我想要预定下午去南京的机票',
  category: 'trip',
  module: 'bookTrainTicket,bookAirTicket',
  success: function (data) {
    console.log("handling success, result: ", data)
  },
  fail: function (data, code) {
    console.log("handling fail, code: " + code)
  },
  complete: function (msg) {
    console.log("handling complete")
  }
})

[h2]ai.getChatIntention(OBJECT)

描述

IM类意图识别：是指利用机器学习技术对文本消息进行意图分析和识别。

目前仅开放了通知消息类的三个意图，分别是：还款提醒通知、还款成功通知、未接来电通知。

OBJECT参数

参数	类型	是否必填	说明
text	string	是	待分析的文本，不超过500个字符，超过300个字符的只分析通知类意图，文本要UTF-8格式，格式错误的不报错，分析结果会不正确。
timestamp	number	否	该文本的发送时间或接收时间，格式为时间戳,表示距离格林威治时间1970.1.1的毫秒数。
isSender	number	否	用于标识发送还是接收。 0：接收 1：发送
category	string	否	需要分析的意图类别，默认分析所有类，多个用半角逗号“,”隔开，如需要分析出行类和通知类，传“common,notice”，详细内容请参见“意图说明”。
module	string	否	用于指定具体分析哪些意图模块，默认都分析。分析多个意图模块用半角逗号“,”隔开，如分析，传“missedCallNotice” 备注：分析时category与module取并集，如category为“common”，module为“repayNotice”，则分析联系类的所有意图。
success	function	否	成功回调。
fail	function	否	失败回调，具体请参见“常见错误码”。
complete	function	否	执行结束后的回调。

意图说明：

意图类别

包含意图

具体的意图模块

common

有事件未识别出具体意图

unknown

notice

还款提醒通知、还款成功通知、未接来电通知。

missedCallNotice

repayNotice

repayedNotice

success返回值：

参数	类型	说明
message	string	描述执行结果信息。
intentions	object[]	意图列表，详细内容请参见“intentions参数说明”。

intentions参数说明：

参数	类型	是否必填	说明
name	string	否	意图名，如：“repayNotice”。
attributes	object	否	意图对应的属性，详细内容请参见“IM类意图识别API说明”中的“详细意图说明”。

示例代码

ai.getChatIntention({
  text: "您尾号6537的南京银行信用卡于10月23日还款人民币5000元。【南京银行】",
  timestamp: 160000000,
  isSender: 0,
  category: 'common',
  module: 'repayNotice,repayedNotice',
  success: function (data) {
    console.log("handling success, result: ", data)
  },
  fail: function (data, code) {
    console.log("handling fail, code: " + code)
  },
  complete: function (msg) {
    console.log("handling complete")
  }
})

[h2]ai.getWordPos(OBJECT)

描述

词性标注：对一个文本自动分词并给出词性。

为分词结果中的每个单词标注一个正确的词性的程序，标注每个词是名词、动词、形容词或其他词性，可自定义分词的粒度。

基本词粒度：准确率不低于95%
其他粒度：准确率不低于92%

OBJECT参数

参数	类型	是否必填	说明
text	string	是	待分析的文本，字数小于等于500字，文本要UTF-8格式，格式错误的不报错，分析结果会不正确。
type	string	否	分词的粒度，默认为0。 0：基本词，粒度较小，如“我要看速度与激情”，分成“我/要/看/速度/与/激情”。 1：在基本词的基础上，做实体合并，如“我要去江宁万达广场看速度与激情”，分成“我/要/看/速度与激情”，如“明天下午3点一起看电影”，分成“明天/下午/3点/一起/看/电影”。 9223372036854775807（2的63次方减1）：在type为1的基础上，把实体时间、地点等整体结构合并，出现符号隔开不合并，并把一些常用短语合并，如“形容词+的”，“单字动词+单字名词”等，简化句子成分，如“明天下午三点到五点我在江宁瑞都金逸影城看电影”，分成“明天下午三点/到/五点/我/在/江宁瑞都金逸影城/看/电影”。针对type为1和9223372036854775807的实体合并，仅合并nlu目前支持的实体合并，不在支持范围内的合并不保证，目前支持实体请参见“实体识别API说明”中的“实体接口和指标表”。说明：受JS Number类型最大数值精度的限制，type类型由Number类型修改为String，请已集成的开发者传入9223372036854775807时，务必调整为以String格式传入。
success	function	否	成功回调。
fail	function	否	失败回调，具体请参见“常见错误码”。
complete	function	否	执行结束后的回调。

success返回值：

参数	类型	是否必填	说明
message	string	是	描述执行结果信息。
pos	object	否	切分出的词数组，详细内容请参见“pos参数说明”。

pos参数说明：

参数	类型	是否必填	说明
word	string	否	分词结果，数组内为String类型。
tag	string	否	词性。type为1或9223372036854775807时，人名实体的词性给nr，时间实体的词给t，地点实体的词性给ns，其他实体统一给ne。

示例代码

ai.getWordPos({
  text: "我要去新街口看电影魔兽",
  type: "1",
  success: function (data) {
    console.log("handling success, result: ", data)
  },
  fail: function (data, code) {
    console.log("handling fail, code: " + code)
  },
  complete: function (msg) {
    console.log("handling complete")
  }
})

[h2]ai.getWordSegment(OBJECT)

描述

分词：将一个汉字序列切分成一个一个单独的词。

可自定义分词的粒度。

基本词粒度：准确率不低于95%
其他粒度：准确率不低于92%

OBJECT参数

参数	类型	是否必填	说明
text	string	是	待分析的文本，字数小于等于500字，文本要UTF-8格式，格式错误的不报错，分析结果会不正确。
type	string	否	分词的粒度，默认为0。 0：基本词，粒度较小，如“我要看速度与激情”，分成“我/要/看/速度/与/激情”。 1：在基本词的基础上，做实体合并，如“我要去江宁万达广场看速度与激情”，分成“我/要/看/速度与激情”，如“明天下午3点一起看电影”，分成“明天/下午/3点/一起/看/电影”。 9223372036854775807（2的63次方减1）：在type为1的基础上，把实体时间、地点等整体结构合并，出现符号隔开不合并，并把一些常用短语合并，如“形容词+的”，“单字动词+单字名词”等，简化句子成分，如“明天下午三点到五点我在江宁瑞都金逸影城看电影”，分成“明天下午三点/到/五点/我/在/江宁瑞都金逸影城/看/电影”。
success	function	否	成功回调。
fail	function	否	失败回调，具体请参见“常见错误码”。
complete	function	否	执行结束后的回调。

针对type为1和9223372036854775807的实体合并，仅合并nlu目前支持的实体合并，不在支持范围内的合并不保证，目前支持实体参见“实体识别API说明”中的“实体接口和指标表”。

success返回值：

参数	类型	是否必填	说明
message	string	是	描述执行结果信息。
words	array	否	分词结果，数组内为String类型。

示例代码

ai.getWordSegment({
  text: "我要去新街口看电影魔兽",
  type: "1",
  success: function (data) {
    console.log("handling success, result: ", data)
  },
  fail: function (data, code) {
    console.log("handling fail, code: " + code)
  },
  complete: function (msg) {
    console.log("handling complete")
  }
})

[h2]ai.getEntity(OBJECT)

描述

实体识别：识别文本中具有特定意义的实体。

实体包含电影、电视剧、综艺、动漫、单曲、专辑、图书、火车车次、航班号、球队、人名、快递单号、电话号码、url、邮箱、联赛、时间、地点（包含酒店、餐馆、景点、学校、道路、省、市、县、区、镇等）、验证码。

OBJECT参数

参数	类型	是否必填	说明
text	string	是	待分析的文本，字数小于等于500字，文本要UTF-8格式，格式错误的不报错，分析结果会不正确。
module	string	否	定义需要分析的实体，默认所有实体都分析。分析某个实体，传实体键值，如只需要分析时间实体，传“time”，可传多个，表示分析多个实体，以半角逗号“,”分隔，如分析时间和地点，传“time,location”。取值范围参见支持的实体类的键值。
success	function	否	成功回调。
fail	function	否	失败回调，具体请参见“常见错误码”。
complete	function	否	执行结束后的回调。

success返回值：

参数	类型	是否必填	说明
message	string	是	描述执行结果信息。
entity	object	否	实体分析结果，详细内容请参见文档“实体识别API说明”的“实体接口和指标表”。

示例代码

ai.getEntity({
  text: '明天一起看机器之血，晚上',
  module: 'time,location',
  success: function (data) {
    console.log("handling success, result: ", data)
  },
  fail: function (data, code) {
    console.log("handling fail, code: " + code)
  },
  complete: function (msg) {
    console.log("handling complete")
  }
})

[h2]ai.detectBarcode(OBJECT)

描述

码检测：通过识别二维码、条码得到码中包含的信息。

建议输入图片大小不超过2000万像素，超过2000万像素会自动压缩，影响图片质量。

OBJECT参数

参数	类型	是否必填	说明
uri	string	是	源文件的uri，仅支持本地路径。应用内部资源，或者“internal:///”格式路径。
success	function	否	成功回调。
fail	function	否	失败回调，具体请参见“常见错误码”。
complete	function	否	执行结束后的回调。

success返回值：

参数	类型	说明
barcode	object[]	码检测结果数组，详细内容请参见“barcode参数说明”。

barcode参数说明：

参数	类型	说明
contentTypes	number	码内包含信息类型，详细内容请参见“contentTypes参数说明”。
personName	string	人名。
phone	string	手机号码。
emailAddress	string	邮件地址。
address	string	地址。
geoLocation	string	位置。
url	string	网址。
text	string	文本，详细内容请参见“text参数说明”。

contentTypes参数说明：

参数	类型	说明
0	number	未知码类型。
1	number	包含电话信息的二维码。
2	number	包含地理位置信息的二维码。
3	number	包含网址信息的二维码。
4	number	包含邮件信息的二维码。
5	number	包含联系人信息的二维码。
6	number	包含短信信息的二维码。
7	number	包含日程事件信息的二维码。
8	number	包含wifi信息的二维码。
9	number	包含文本信息的二维码。
10	number	包含商品信息的条码。
11	number	包含书籍ISBN信息的条码。

text参数说明：

参数

类型

说明

text

string

文本内容。

languageType

number

CN = 1，中文文本。
EN = 2，英文文本。

目前统一返回为1。

barcode详细接口文档请参见“码检测API说明”中的“Barcode内部结构表”。

示例代码

ai.detectBarcode({
    uri: "internal://temp/xxxx",
    success: function (data) {
        console.log("handling success: " + data.barcode.text.text)
    },
    fail: function (data, code) {
        console.log("handling fail, code: " + code)
    },
    complete: function (msg) {
        console.log("handling complete")
    }
})

[h2]ai.startRecognize(OBJECT)

描述

开始语音识别。

开始语音识别后，引擎将用户说的话转化成文字。只支持中文识别。

OBJECT参数

参数	类型	是否必填	说明
fontTime	number	否	前端静音检测时间，单位毫秒，范围0 ~ 20000，设置参数错误时自动设置为4000。在这段时间内识别有没有传入语音，不传入语音停止检测。
backTime	number	否	后端静音检测时间，单位毫秒，范围0 ~ 20000，设置参数错误时自动设置为5000。语音传入时停顿时间，停顿超过这个时间段，检测停止。
totalTime	number	否	超时时间，单位毫秒，默认以及最多为20000，设置参数错误时自动设置为默认参数。引擎检测的时间（包含fontTime和backTime）。
onBeginningOfSpeech	function	否	用户开始说话回调该函数。
onRmsChanged	function	否	返回当前输入语音的能量，详细返回值请参见“onRmsChanged参数说明”。
onPartialResult	function	否	识别过程中，每解码一个chunk，回调一次，详细返回值请参见“onPartialResult返回值说明”。
onEndOfSpeech	function	否	引擎检测到用户已经说完后回调该函数。
onEnd	function	否	识别结束回调。
success	function	否	成功回调。
fail	function	否	失败回调，具体请参见“常见错误码”。
complete	function	否	执行结束后的回调。

onRmsChanged参数说明：

参数	类型	说明
rms	number	返回当前输入语音的能量。

success以及onPartialResult返回值：

参数	类型	说明
result	object[]	语音检测结果数组，详细内容请参见“result参数说明”。

result参数说明：

参数	类型	说明
confidence	number	可信度，取值为0 ~ 100，目前可信度统一返回0。
word	string	识别出的文字。

示例代码

ai.startRecognize({
    fontTime: 3000,
    backTime: 4000,
    totalTime: 20000,
    onBeginningOfSpeech: function () {
        console.log("begin speech")
    },
    onRmsChanged: function (res ) {
        console.log("rms is" + res.rms)
    },
    onEndOfSpeech: function () {
        console.log("end of speech")
    },
    onPartialResult: function (res) {
        console.log("PartialResult is: " + res.result.word)
    },
    onEnd: function () {
        console.log("voice recognization end")
    },
    success: function (data) {
        console.log("handling success: " + data.result.word)
    },
    fail: function (data, code) {
        console.log("handling fail, code: " + code)
    }
})

[h2]ai.stopRecognize(OBJECT)

描述

停止语音识别。

停止语音识别是指引擎停止对用户声音的采集，而不是销毁语音识别流程，停止语音识别之后引擎会继续执行startRecognize的onEndOfSpeech，success，onEnd等回调。

OBJECT参数

参数	类型	是否必填	说明
success	function	否	成功回调。
fail	function	否	失败回调。
complete	function	否	执行结束后的回调。

示例代码

ai.stopRecognize({
    success: function () {
        console.log("handling success")
    },
    fail: function (data, code) {
        console.log("handling fail, code: " + code)
    },
    complete: function (msg) {
        console.log("handling complete")
    }
})

[h2]ai.cancelRecognize(OBJECT)

描述

取消语音识别。

HUAWEI VR 2即插即用的分体式可以实现手机与PC的快速连接。

OBJECT参数

参数	类型	是否必填	说明
success	function	否	成功回调。
fail	function	否	失败回调。
complete	function	否	执行结束后的回调。

示例代码

ai.cancelRecognize({
    success: function (data) {
        console.log("handling success: " + data)
    },
    fail: function (data, code) {
        console.log("handling fail, code: " + code)
    },
    complete: function () {
        console.log("handling complete")
    }
})

[h2]ai.canIUse(OBJECT)

描述

判断当前环境下是否支持Ai的接口。

OBJECT参数

参数	类型	是否必填	说明
success	function	否	成功回调。
fail	function	否	失败回调，具体请参见“常见错误码”。
complete	function	否	执行结束后的回调。

success返回值：

参数	类型	说明
canUse	boolean	是否支持AI接口，true or false。

示例代码

ai.canIUse({
    success: function (data) {
        console.log("handling success: " + data)
    },
    fail: function (data, code) {
        console.log("handling fail, code: " + code)
    },
    complete: function () {
        console.log("handling complete")
    }
})

常见错误码

常见错误码	说明
202	参数错误。
203	服务不可用。
800	一般性检测失败。
801	模型文件错误。
802	模型加载失败。
803	神经网络处理单元错误。
804	录音相关错误。
805	客户端未调用引擎初始化。
806	没有声音。
807	未匹配识别结果。
808	客户端权限不足。
809	服务端权限不足。
810	设备AIEngine的功能开关被关闭了，无法使用。
811	不支持的功能或接口。

版本更新说明

版本	发布日期	描述
1030	2018-10-31	第一次正式发布。

目录

AI

接口声明

导入模块

使用限制

接口定义

[h2]ai.detectAestheticsScore(OBJECT)

[h2]ai.detectFace(OBJECT)

[h2]ai.faceCompare(OBJECT)

[h2]ai.detectLabel(OBJECT)

[h2]ai.superImageResolution(OBJECT)

[h2]ai.superTextImageResolution(OBJECT)

[h2]ai.detectDoc(OBJECT)

[h2]ai.refineDoc(OBJECT)

[h2]ai.detectText(OBJECT)

[h2]ai.imageSegmentation(OBJECT)

[h2]ai.detectHeadPose(OBJECT)

[h2]ai.parseFace(OBJECT)

[h2]ai.detectFaceAttributes(OBJECT)

[h2]ai.detectFaceLandMark(OBJECT)

[h2]ai.getAssistantIntention(OBJECT)

[h2]ai.getChatIntention(OBJECT)

[h2]ai.getWordPos(OBJECT)

[h2]ai.getWordSegment(OBJECT)

[h2]ai.getEntity(OBJECT)

[h2]ai.detectBarcode(OBJECT)

[h2]ai.startRecognize(OBJECT)

[h2]ai.stopRecognize(OBJECT)

[h2]ai.cancelRecognize(OBJECT)

[h2]ai.canIUse(OBJECT)

常见错误码

版本更新说明