# 词条高亮

传入一句话，智能识别句中对应的词条，并返回词条位置和 entity_id，可在外部系统中快速实现词条智能高亮。
**注意事项**：为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至[新版本>>](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/lingo-v1/entity/highlight)

## 请求

基本 |  
---|---
HTTP URL | https://open.feishu.cn/open-apis/baike/v1/entities/highlight
HTTP Method | POST
接口频率限制 | [1000 次/分钟、50 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用**<br>开启任一权限即可 | 查看、创建、编辑、删除飞书词典词条(baike:entity)<br>创建、更新飞书词典免审词条(baike:entity:exempt_review)<br>查看飞书词典词条(baike:entity:readonly)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`<br>或<br>`user_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
Content-Type | string | 是 | **固定值**："application/json; charset=utf-8"

### 请求体

名称 | 类型 | 必填 | 描述
---|---|---|---
text | string | 是 | 需要识别词条的内容（不超过1000字）<br>**示例值**："词典是飞书提供的一款知识管理工具"<br>**数据校验规则**：<br>- 长度范围：`1` ～ `1000` 字符

### 请求体示例
```json
{
    "text": "词典是飞书提供的一款知识管理工具"
}
```

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
phrases | phrase\[\] | 识别到的词条信息
name | string | 识别到的关键词
entity_ids | string\[\] | 对应的词条 ID
span | span | 词条所在位置
start | int | 关键词开始位置，从 0 开始计数（编码格式采用 utf-8）
end | int | 关键词结束位置，从 0 开始计数（编码格式采用 utf-8）

### 响应体示例
```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "phrases": [
            {
                "name": "词典",
                "entity_ids": [
                    "enterprise_348***84"
                ],
                "span": {
                    "start": 0,
                    "end": 2
                }
            }
        ]
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
400 | 1540001 | invalid param | 参数错误，参考文档检查输入参数
500 | 1540002 | network anomaly, please try again | 多数请求是服务超时，请重新请求，少数是服务异常请[咨询客服](https://applink.feishu.cn/client/helpdesk/open?id=6626260912531570952&extra=%7B%22channel%22:14,%22created_at%22:1614493146,%22scenario_id%22:6885151765134622721,%22signature%22:%22ca94c408b966dc1de2083e5bbcd418294c146e98%22%7D)