Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 02e6abd

Browse files
author
jinjiaji
committed
Merge branch 'master' of https://github.com/roobo/docs
2 parents 0f40b26 + dc2c51e commit 02e6abd

16 files changed

Lines changed: 1099 additions & 328 deletions

File tree

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
_book/
2+
.DS_Store
3+
Bot/_book/
4+
Bot/node_modules/
5+
Bot/book.json

Bot/2-RosAiDocument/1-SkillsKit/important-concept/entity.md

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,28 @@
1-
# 基本信息
2-
- 实体表示一类客观事物的总和,比如城市,歌手,歌曲名称,食物名称等
1+
2+
## 基本信息
3+
4+
- 实体表示一类客观事物的总和,比如城市,歌手,歌曲名称,食物名称等
35
- 实体由一个实体名称,多个实体项,实体项的同义词组成
4-
## 实体命名规则
6+
7+
## 实体名称
8+
59
- 小写字母、数字、下划线组合
610
- 必须以字母开头
7-
- 单词间下划线分割
11+
- 单词间下划线分割
812
- 缩写单词也用小写字母
913
- 长度2-50字符
10-
## 实体项
14+
15+
## 实体项
16+
1117
实体中可能包含的单个单元,如城市的实体项,应该包括北京,上海,成都,深圳...
12-
## 同义词
18+
19+
## 同义词
20+
1321
- 每个实体项可以有多种不同的说法,如北京,当人们说:北京,北平,首都,帝都的时候,其实都是再说北京,所以要将北京,北平,首都,帝都这些同义词和北京联系起来,用来更好的理解用户意图。
1422
- 不支持特殊字符(中点,下点)
23+
1524
## 系统共享实体
25+
1626
<table>
1727
<tr>
1828
<td>分类</td>
@@ -45,7 +55,7 @@
4555
</td>
4656
</tr>
4757
<tr>
48-
<td>datatime</td>
58+
<td>datetime</td>
4959
<td>
5060
匹配一个日期时间
5161
(有明确日期概念时。例如:
@@ -91,7 +101,7 @@
91101
<td>{"amount":10,"unit":"USD"}</td>
92102
</tr>
93103
<tr>
94-
<td>unit_lenght</td>
104+
<td>unit_length</td>
95105
<td>匹配长度(基准单位m)</td>
96106
<td>5厘米</td>
97107
<td>{"amount":0.05,"unit":"m"}</td>
@@ -116,50 +126,47 @@
116126
</tr>
117127
<tr>
118128
<td rowspan="4">地理信息</td>
119-
<td>geog_country</td>
129+
<td>geo_country</td>
120130
<td>国家</td>
121131
<td>不丹</td>
122132
<td>不丹</td>
123133
</tr>
124134
<tr>
125-
<td>geog_province</td>
135+
<td>geo_province</td>
126136
<td>中国省份</td>
127137
<td>河南省</td>
128138
<td>河南省</td>
129139
</tr>
130140
<tr>
131-
<td>geog_city</td>
141+
<td>geo_city</td>
132142
<td>中国地级城市及以上城市</td>
133143
<td>北京市</td>
134144
<td>北京市</td>
135145
</tr>
136146
<tr>
137-
<td>geog_district</td>
147+
<td>geo_district</td>
138148
<td>中国区/县</td>
139149
<td>朝阳区</td>
140150
<td>朝阳区</td>
141151
</tr>
142152
<tr>
143153
<td rowspan="2">通用匹配</td>
144154
<td>any</td>
145-
<td>匹配任何字符或者空。同一模板中优先级最低,先匹配其他槽位。</td>
146-
<td>打电话给@sys.any:name打电话给李XXX</td>
147-
<td></td>
155+
<td>任何字符,包括空 都在该实体中。这个实体相当于正则中的*。和default的区别见any/default实体区别</td>
156+
<td>打电话给@sys.any:name打电话给李XX</td>
157+
<td>李XX</td>
148158
</tr>
149159
<tr>
150160
<td>default</td>
151-
<td>在模板中单独使用,需要配置上文,匹配任何字符。</td>
161+
<td>任何字符,包括空 都在该实体中。这个实体相当于正则中的*。和any的区别见any/default实体区别</td>
152162
<td>例如:英译汉场景。进入场景后,只要没有退出场景,所有后面的输入都需要翻译。就需要在场景中配置一个只有default的模板来匹配所有的输入,来实现这个功能。</td>
153163
<td></td>
154164
</tr>
155165
</table>
156166

157-
### any/default 实体 区别
167+
### any/default实体区别
158168

159169
|-|any|default|
160170
|---|---|---|
161171
| 优先级|跨场景模板比较中,处于低优先级。|跨场景模板比较中,处于高优先级。|
162172
|使用场景|如果需要一个通配的实体,并且使用这个实体的场景是一个可以随时跳到别的场景,那么使用@sys.any|如果需要一个通配实体,并且这个模板所在的场景是一个相对来说比较封闭的场景,可能这个通配实体要获取所有的东西都送到该场景中进行处理(如翻译场景,认为进入场景之后,所有的query都是需要翻译的话),那么使用@sys.default|
163-
164-
165-

Bot/2-RosAiDocument/1-SkillsKit/important-concept/intent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
- 下文
1717
1.添加下文的意图,表示下一个会话可能是一个多轮会话,可能触发上文和这个下文一致的意图。
1818
2.不能为除下划线以外的特殊字符,没有长度限制
19+
1920
# 示例
2021
在天气场景中,有三个意图
2122
- GetWeather(获取天气信息)
@@ -27,4 +28,3 @@ GetWeather为GetCityWeather和GetCity的父意图。
2728
对于GetCityWeather意图来说,它是一个起始句式,可以直接进入天气场景,因此其意图的上文应该不进行填写。而天气场景是一个多轮场景,所以这个意图有一个“启下”的使命,那么它的下文应该进行填写,这里我们写成:weather
2829

2930
对于GetCity意图来说,直接说:北京的呢? 并不能知道它是天气场景的query,但是如果已经在天气场景中了,那么这个query就有意义了,所以它的上文需要进行填写,这里写成:weather,表示它可以在GetCityWeather这个意图之后被命中。至于它的下文是否进行填写,需要看业务需求,这里因为这个意图后面还可以继续进行天气的询问,所以下文填写:weather
30-

Bot/2-RosAiDocument/1-SkillsKit/important-concept/template.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,31 @@
11
# 基本信息
22
- 模板,即用户query时需满足的句式
33
- 模板,是一个模式,满足了这个模式就可以触发该模式所在的意图和场景
4+
45
# 语法
56
## []语法
67
- []中用|来进行字,词的分割,表示“或”
78
- []中可以有固定的字词或者实体
9+
810
### []语法示例
911
- [A|B|CD]EF 表示AEF或BEF或CDEF
1012
- [A|@sys.date:date|] 表示A或@sys.date或空
13+
1114
## <<>>语法
1215
该语法表示<<>>中的所有段都可以进行位置上的交换,每个段可以跟一个对这个段出现次数的要求语法。
16+
1317
### 出现次数语法
18+
1419
- 至少出现一次:@pattern.A:A(1+)
1520
- 可以出现0次到多次:@pattern.A:A(0+)
1621
- 能并只能出现1次:@pattern.A:A(1) 或@pattern.A(1)
1722
- 可以出现0-1次:@pattern.A
23+
1824
### <<>>语法示例
1925
<<@pattern.A|@pattern.B>>可以匹配: AB, BA, A, B, 空
2026
<<@pattern.A:A(0+)|@pattern.B:B(1+)>>: 可以匹配AB, BA, AAB, AABBB, BB, BBAA等
2127
<<@pattern.A:A(1)|@pattern.B(1)>>:可以匹配: AB, BA
28+
2229
### <<>>语法注意
2330
<<>>中只能出现子模板。 <<>>中的"|"作为分隔子模板的符号,不存在<<A|>>的语法
2431
另外如果使用了(0+)或者(1+),请务必为你的子模板设置一个引用变量名称,如@pattern.A:var_A(0+)。 因为(0+)和(1+)返回的是一个列表。
25-
26-

Bot/3-ApiReference/rosai-client-development-protocol-intent.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,11 +94,27 @@ _Context_ 向所请求的CloudApp提供了当前的设备信息,用户信息
9494
| :--- | :--- | :--- | :--- |
9595
| service | String | 服务名 | Required |
9696
| context | String | 上文名称 | Optional |
97-
| parameters | Map | [Param定义](Bot_3-ApiReference_rosai-skills-deveopment-protocol) | Optional |
97+
| parameters | Map | [Param定义](/Bot/3-ApiReference/rosai-skills-development-protocol.md) | Optional |
9898

9999
#### 2.3 Location 定义
100100

101-
__Location__ 向所请求的CloudApp提供了当前的设备的地理信息,用于帮助CloudApp更好的去管理逻辑,状态以及对应的返回结果。
101+
__Location__ 向所请求的CloudApp提供了当前的设备的地理信息,用于帮助CloudApp更好的去管理逻辑,状态以及对应的返回结果。期望key 统一为 location
102+
103+
| Name | Type | Description | Required |
104+
|--|--|--|--|
105+
|address|object| [address定义](#231-address定义)| Optional |
106+
|longitude|float|经度| Required |
107+
|latitude|float|纬度| Required |
108+
109+
##### 2.3.1 address定义
110+
111+
| Name | Type | Description | Required |
112+
|--|--|--|--|
113+
|country|String| 国家| Optional |
114+
|province|String| 所在地区的省份 | Optional |
115+
|city|String|所在的城市| Optional |
116+
|detail|String|详细的地址信息| Optional |
117+
102118

103119
#### 2.4 Lang 定义
104120

0 commit comments

Comments
 (0)