Skip to content

概述

1. 什么是飞书词典?

飞书词典是一部高效汇聚企业内各类信息,并可由企业成员参与编辑的在线词典

  • 它将企业内具有特定意义的信息(如缩写词、专业术语、企业专属用词等),提炼为 词条 收录到词典 应用之中,以轻量化的方式完成企业专属知识的收集与管理。
  • 通过智能推荐展示,成员可以在聊天、搜索时快速发现 词条,并在对应的 词条卡片 上了解相关信息,有效降低知识的获取成本,提高沟通效率,实现企业知识的自由流通。

2. 词条包含哪些信息?

  • 词条名:词条最通用的名称
  • 别名:词条的别名
  • 词库:多词库租户可以设置创建词条所归属词库,默认全员词库
  • 分类:词条所属分类,仅支持选择二级分类,且每个一级分类下仅支持选择一个二级分类
  • 释义:词条的含义阐释。支持纯文本释义和富文本释义。当写入富文本释义时,纯文本释义自动失效。富文本释义目前支持以下几种格式:
    • 段落 <p><span>这是第一段文本</span></p>
    • 文本 <span>这是一段纯文本</span>
    • 加粗 <b>这是一段加粗文本</b>
    • 斜体 <i>这是一段斜体文本</i>
    • 链接 <a href="https://feishu.cn">这是一个链接</a>
  • 相关云文档:词条相关的云文档,可放入说明文档、使用指南等,成员可一键点击跳转
  • 相关公开群:词条相关的公开群,成员可直接入群(不支持普通群、话题群)
  • 相关服务台:词条相关的云文档,成员可快速向服务台发起问询沟通
  • 相关联系人:词条相关的联系人,成员可在词条卡片上快速发起会话
  • 相关链接:词条相关的链接,可放产品入口、更多信息等,成员可点击跳转
  • 相关词条:和当前词条有关联的词条
  • outer_info:不对外展示,可关联词条和外部系统中的信息来源。比如连接词条和 CRM,可将 CRM 中的用户 Id 和词条 Id 一一对应,动态更新,当用户在消息或者文档中提及对应客户,即可通过词条卡片查看客户的最新信息。

3. 开放接口支持哪些功能?

草稿

  • 创建草稿
    • 支持不指定 entity_id 字段(词条唯一 ID)创建草稿,管理员审核通过后创建新词条
    • 支持指定 entity_id 字段创建草稿,管理员审核通过后更新已有词条
    • 支持指定 outer_info 字段(外部信息可标识词条)创建和更新词条的草稿,管理员审核通过后生效
  • 更新草稿
    • 仅能通过 draft_id 字段(草稿唯一 ID)更新已有的草稿,草稿一旦被审批通过成为新词条则无法被更新

词条(实体词)

  • 创建词条
    • 无需管理员审核,直接创建新词条
  • 更新词条
    • 无需管理员审核,直接更新已有词条
  • 删除词条
    • 无需管理员审核,直接删除已有词条
  • 获取词条详情
    • 通过 entity_id 字段拉取词条的详情数据
  • 获取词条列表
    • 分页获取词条列表,支持传入 provider 字段过滤与特定外部系统相关的词条
  • 高亮词条
    • 传入一句话,智能识别句中对应的词条,并返回词条位置和 entity_id,可在外部系统中快速实现词条智能高亮
  • 精准匹配词条
    • 传入词条名称,精准匹配是否有对应词条的 entity_id
  • 模糊搜索词条
    • 传入一个查询词,返回相关的词条详情数据

分类

  • 获取词条分类
    • 分页获取飞书词典当前的分类列表

图片管理

  • 上传图片
    • 词条上的图片资源需要先上传,获取图片 token,将 token 和词条绑定
  • 下载图片
    • 拉取词条信息后,获取到的相关图片 token 需要通过下载接口下载完整图片

词库

  • 获取词库列表
    • 获取有权限访问的飞书词典词库列表

接口限制

开放 API 接口的 QPS 限制。若有特殊需求可联系咨询客服

  • 创建更新相关接口 100次/分钟
  • 读取数据相关接口 50次/秒 或 1000次/分钟

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