Skip to content

精准搜索词条

将关键词与词条名、别名精准匹配,并返回对应的 词条 ID。

请求

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

请求头

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

查询参数

名称类型必填描述
repo_idstring词库ID(不传时默认在全员词库内搜索)
如以应用身份搜索非全员词库中的词条,需要在“词库设置”页面添加应用;若以用户身份搜索非全员词库中的词条,该用户需要拥有对应词库的可见权限。
示例值:7202510112396640276

请求体

名称类型必填描述
wordstring搜索关键词,将与词条名、别名进行精准匹配
示例值:"飞书词典"
数据校验规则
- 长度范围:1100 字符

请求体示例

json
{
    "word": "飞书词典"
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ resultsmatch_info\[\]搜索结果
    └ entity_idstring词条 ID
    └ typeint匹配中的字段
可选值有
- 0: 词条名 - 1: 全称 - 2: 别名

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "results": [
            {
                "entity_id": "enterprise_34***584",
                "type": 0
            }
        ]
    }
}

错误码

HTTP状态码错误码描述排查建议
4002250001invalid param参数错误,参考文档检查输入参数
5002250002network anomaly, please try again多数请求是服务超时,请重新请求,少数是服务异常请咨询客服

内容来源:飞书开放平台 · 自动爬取整理