词条高亮

传入一句话，智能识别句中对应的词条，并返回词条位置和 entity_id，可在外部系统中快速实现词条智能高亮。

Error: 为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至新版本>>

请求

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

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

请求体

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

请求体示例

{
    "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）

响应体示例

{
    "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	多数请求是服务超时，请重新请求，少数是服务异常请咨询客服