实体

**目录**
1. 实体说明
2. 实体分类
	2.1. 自定义实体
	2.2. 官方实体

# 1. 实体说明
**实体**：就是词库，同一类型的词归纳为实体。
`例：{city}实体包含北京、上海、广州`
建议将以下词性的词设置为实体：名词、动词、形容词、数词、量词和代词

词槽及实体信息在语义结果的`slots`字段中，每个词槽对应一个slots的对象数组元素，元素对象内容为词槽命中的实体信息。
<summary>点击查看示例</summary>

```json
{
	//语义内容
  "semantic":[
    {
		//意图名称
      "intent":"QUERY",
      "slots":[
        {
		   //实体名
          "name":"datetime",
		  //词槽的命中词
          "value":"今天",
		  //词条名或规整后取值，建议取该值进行逻辑处理
          "normValue":"{"datetime":"2018-01-22","suggestDatetime":"2018-01-22"}"
        },
        {
          "name":"location.city",
          "value":"帝都",
          "normValue":"北京市"
        }
      ]
    }
  ],
  //技能唯一标识
  "service":"weather",
  //识别文本
  "text":"查看帝都今天的天气",
  //展示或TTS播报内容
  "answer":{
    "text":""北京今天晴"，"-10℃ ~ -2℃"，"西南风微风""
  },
  "save_history":true
}
```
# 2. 实体分类
AIUI平台根据实体词条更新信息的方式和在交互语料中的重要性,将实体分为两大类,分别为：自定义实体、官方实体。
- 自定义实体包含：
	- **静态实体**
	- **动态实体**
	- **所加即可说**
- 官方实体包含：
	- **一般实体**
	- **通配实体**
	- **辅助词**

下面就各实体做简要说明

## 2.1. 自定义实体
自定义实体是开发者自行创建和维护的实体数据，根据实体上传信息的方式进行数据分类，具体说明如下：
- **静态实体**
一般是将不常更改的数据创建为静态实体，开发者可直接在平台上进行修改更新，实时永久生效。
- **动态实体**
当数据由端侧使用环境不同或使用用户不同而需要动态变更时，创建实体就需要选择动态实体，例如 电话联系人。动态实体的生效范围分为`应用级`、`用户级`、`自定义级`，数据上传为覆盖更新，永久生效。
	- 应用级：动态更新的数据可以被当前应用所有设备或用户加载使用
	- 用户级：仅支持当前设备或用户加载使用
	- 自定义级：仅支持指定该维度的设备或用户加载使用
- **所见即可说**
所见即可说也属于动态实体一种，是一种特殊的动态实体。特殊在于该数据上传后仅一次交互后即失效，属于临时数据。
一般应用场景有：产品交互界面动态更新的数据需要实时加载生效，一次页面刷新后数据会有新的变更。

关于动态实体想要详细了解，可以点击查看[动态实体](https://aiui-doc.xf-yun.com/project-1/doc-49/)详情

## 2.2. 官方实体
官方实体即为AIUI平台提供的可供开发者直接配置使用的实体，例如常见的 时间、城市、数字等。关于官方提示分类说明如下：
- **一般实体**
该类型实体属于AIUI平台对于已有类型数据做了整合处理，无法开发者自行创建相关信息。如 城市、时间、数字、艺术家等相关指定类别的实体。
- **通配实体**
通配实体代表的是模糊匹配，按照设置配置的字符长度进行文本匹配。
- **辅助词**
这部分实体其实代表的是在交互话术中非重要描述字段，例如交互的语气词。配置后默认代表该槽位话术非必选。