词典词条 - 用户令牌(FeishuUserV1LingoEntity)
接口名称
词典词条(用户令牌) -(IFeishuUserV1LingoEntity)
功能描述
提供以用户身份查询飞书词典词条的能力。飞书词典(Lingo)词条入口域用户态 SDK 是一组服务端 OpenAPI 的封装,以用户身份继承 IFeishuV1LingoEntity 的词条详情查询、分页列表、模糊搜索、精准匹配与高亮识别端点(免审创建/更新/删除仅支持租户态,见 IFeishuTenantV1LingoEntity)。本接口全部端点支持 user_access_token 调用。支持获取词条详情、获取词条列表、模糊搜索词条、精准搜索词条、词条高亮等操作。
参考文档
函数列表
| 函数名称 | 功能描述 | 认证方式 | HTTP 方法 |
|---|---|---|---|
| GetEntityAsync | 获取词条详情 | 用户令牌 | GET |
| GetEntityListAsync | 获取词条列表 | 用户令牌 | GET |
| SearchEntityAsync | 模糊搜索词条 | 用户令牌 | POST |
| MatchEntityAsync | 精准搜索词条 | 用户令牌 | POST |
| HighlightEntityAsync | 词条高亮 | 用户令牌 | POST |
函数详细内容
获取词条详情
按词条 ID 获取词条详情;也可通过 provider + outer_id 以外部系统关联方式查询。返回结果包含词条名、别名、释义、相关信息、反馈统计、外部关联、创建/更新信息等。限频:1000 次/分钟、50 次/秒。所需权限(任一即可):baike:entity(查看、创建、编辑、删除词典词条)、baike:entity:exempt_review(创建、更新词典免审词条)、baike:entity:readonly(查看词典词条)。字段权限:contact:user.employee_id:readonly(返回的创建者/更新者字段)。支持的应用类型:自建应用。
函数签名:
Task<FeishuApiResult<GetEntityResult>?> GetEntityAsync(
[Path] string entity_id,
[Query("provider")] string? provider = null,
[Query("outer_id")] string? outer_id = null,
[Query("user_id_type")] string? user_id_type = null,
CancellationToken cancellationToken = default);认证:用户令牌
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
entity_id | string | ✅ | 词条 ID,示例值:enterprise_515879 |
provider | string? | ⚪ | 外部系统,长度 2 ~ 32 字符,示例值:星云 |
outer_id | string? | ⚪ | 词条在外部系统中对应的唯一 ID,长度 1 ~ 64 字符,示例值:123aaa |
user_id_type | string? | ⚪ | 用户 ID 类型(open_id/union_id/user_id),默认 open_id;取 user_id 时需 contact:user.employee_id:readonly 字段权限 |
响应:
{
"code": 0,
"msg": "success",
"data": {
"entity": {
"id": "enterprise_515879",
"main_keys": [
{
"key": "飞书词典",
"display_status": {
"allow_highlight": true,
"allow_search": true
}
}
],
"aliases": [],
"description": "飞书词典是飞书提供的一款词条释义工具",
"rich_text": "",
"creator": "ou_30b07b63089ea46518789914dac63d36",
"create_time": "1627540853",
"updater": "ou_30b07b63089ea46518789914dac63d36",
"update_time": "1627541853",
"source": 4
}
}
}说明:除按词条 ID 查询外,也可通过 provider 与 outer_id 以外部系统关联方式定位词条。创建者与更新者字段需 contact:user.employee_id:readonly 字段权限才会返回;查询范围受当前用户的词库可见权限约束。
获取词条列表
分页获取飞书词典的全部词条,支持按外部系统 provider 过滤、按词库 repo_id 拉取。限频:1000 次/分钟、50 次/秒。所需权限(任一即可):baike:entity(查看、创建、编辑、删除词典词条)、baike:entity:exempt_review(创建、更新词典免审词条)、baike:entity:readonly(查看词典词条)。字段权限:contact:user.employee_id:readonly(返回的创建者/更新者字段)。支持的应用类型:自建应用。以用户身份拉取需该用户拥有对应词库的可见权限。
函数签名:
Task<FeishuApiResult<GetEntityListResult>?> GetEntityListAsync(
[Query("page_size")] int? page_size = null,
[Query("page_token")] string? page_token = null,
[Query("provider")] string? provider = null,
[Query("repo_id")] string? repo_id = null,
[Query("user_id_type")] string? user_id_type = null,
CancellationToken cancellationToken = default);认证:用户令牌
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
page_size | int? | ⚪ | 分页大小,默认 20,取值范围 1 ~ 100 |
page_token | string? | ⚪ | 分页标记,首次请求不填,翻页时取上一次返回的 page_token |
provider | string? | ⚪ | 相关外部系统,可用来过滤词条数据,长度 2 ~ 32 字符,示例值:星云 |
repo_id | string? | ⚪ | 词库 ID,不传时默认返回全员词库数据,示例值:7152790921053274113 |
user_id_type | string? | ⚪ | 用户 ID 类型(open_id/union_id/user_id),默认 open_id;取 user_id 时需 contact:user.employee_id:readonly 字段权限 |
响应:
{
"code": 0,
"msg": "success",
"data": {
"entities": [
{
"id": "enterprise_515879",
"main_keys": [
{
"key": "飞书词典",
"display_status": {
"allow_highlight": true,
"allow_search": true
}
}
],
"description": "飞书词典是飞书提供的一款词条释义工具",
"source": 4
}
],
"page_token": "408ecac018b2e3518db37275e812aad7bb8ad3e755fc886f322ac6c430ba",
"has_more": true
}
}说明:当 has_more 为 true 时,可使用返回的 page_token 继续拉取下一页数据。以用户身份调用时仅返回当前用户有可见权限的词库中的词条。
模糊搜索词条
传入关键词,与词条名、别名、释义等信息进行模糊匹配,返回搜到的词条信息;支持按分类、创建来源、创建者过滤。限频:1000 次/分钟、50 次/秒。所需权限(任一即可):baike:entity(查看、创建、编辑、删除词典词条)、baike:entity:exempt_review(创建、更新词典免审词条)、baike:entity:readonly(查看词典词条)。字段权限:contact:user.employee_id:readonly(返回的创建者/更新者字段)。支持的应用类型:自建应用。
函数签名:
Task<FeishuApiResult<SearchEntityResult>?> SearchEntityAsync(
[Body] SearchEntityRequest request,
[Query("page_size")] int? page_size = null,
[Query("page_token")] string? page_token = null,
[Query("repo_id")] string? repo_id = null,
[Query("user_id_type")] string? user_id_type = null,
CancellationToken cancellationToken = default);认证:用户令牌
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
request | SearchEntityRequest | ✅ | 搜索请求体(query 搜索关键词 1 ~ 100 字符、classification_filter 分类筛选、sources 创建来源、creators 创建者) |
page_size | int? | ⚪ | 每页返回的词条量,默认 20,取值范围 1 ~ 100 |
page_token | string? | ⚪ | 分页标记,首次请求不填,翻页时取上一次返回的 page_token |
repo_id | string? | ⚪ | 词库 ID,不传时默认在全员词库内搜索,示例值:7202510112396640276 |
user_id_type | string? | ⚪ | 用户 ID 类型(open_id/union_id/user_id),默认 open_id;取 user_id 时需 contact:user.employee_id:readonly 字段权限 |
响应:
{
"code": 0,
"msg": "success",
"data": {
"entities": [
{
"id": "enterprise_515879",
"main_keys": [
{
"key": "飞书词典",
"display_status": {
"allow_highlight": true,
"allow_search": true
}
}
],
"description": "飞书词典是飞书提供的一款词条释义工具",
"source": 4
}
],
"page_token": "b152fa6e6f62a291019a04c3a93f365f8ac641910506ff15ff4cad6534e087cb4ed8fa2c",
"has_more": true
}
}说明:模糊匹配覆盖词条名、别名与释义,可通过请求体的分类、创建来源与创建者条件进一步收窄结果范围。
精准搜索词条
将关键词与词条名、别名精准匹配,并返回对应的词条 ID,可在外部系统中快速定位词条。限频:1000 次/分钟、50 次/秒。所需权限(任一即可):baike:entity(查看、创建、编辑、删除词典词条)、baike:entity:exempt_review(创建、更新词典免审词条)、baike:entity:readonly(查看词典词条)。支持的应用类型:自建应用。
函数签名:
Task<FeishuApiResult<MatchEntityResult>?> MatchEntityAsync(
[Body] MatchEntityRequest request,
[Query("repo_id")] string? repo_id = null,
CancellationToken cancellationToken = default);认证:用户令牌
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
request | MatchEntityRequest | ✅ | 匹配请求体(word 搜索关键词必填,1 ~ 100 字符) |
repo_id | string? | ⚪ | 词库 ID,不传时默认在全员词库内搜索,示例值:7202510112396640276 |
响应:
{
"code": 0,
"msg": "success",
"data": {
"results": [
{
"entity_id": "enterprise_34***584",
"type": 0
}
]
}
}说明:与模糊搜索不同,精准搜索只与词条名、别名做完全匹配,适合在外部系统中按确定名称定位词条 ID。
词条高亮
传入一句话,智能识别句中对应的词条,并返回词条位置和 entity_id,可在外部系统中快速实现词条智能高亮。限频:1000 次/分钟、50 次/秒。所需权限(任一即可):baike:entity(查看、创建、编辑、删除词典词条)、baike:entity:exempt_review(创建、更新词典免审词条)、baike:entity:readonly(查看词典词条)。支持的应用类型:自建应用。
函数签名:
Task<FeishuApiResult<HighlightEntityResult>?> HighlightEntityAsync(
[Body] HighlightEntityRequest request,
CancellationToken cancellationToken = default);认证:用户令牌
参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
request | HighlightEntityRequest | ✅ | 高亮请求体(text 需要识别的内容必填,1 ~ 1000 字符) |
响应:
{
"code": 0,
"msg": "success",
"data": {
"phrases": [
{
"name": "企业百科",
"entity_ids": ["enterprise_51587960"],
"span": {
"start": 0,
"end": 4
}
}
]
}
}说明:返回的 span 为词条在传入文本中的位置区间(从 0 开始计数,utf-8 编码),可直接用于前端高亮渲染。