Docs
文档目录

外部数据源与语雀文档

数据源可以把外部语雀内容引入知识库。根据需要,可以配置团队数据源并管理同步,也可以通过个人语雀授权导入在线文档。导入和摄取是不同步骤:文档进入知识库后,仍需等待解析、分块和向量化完成,才能参与检索。

功能概述

以上功能依赖目标环境的语雀连接配置、出网能力、用户授权和知识库模型配置。具体可用入口和字段以当前部署的控制台为准。

操作前准备

  1. 已创建目标项目和知识库,具有该项目中执行相应写入操作的权限。

  2. 知识库已配置可用的向量模型及适合目标文件的解析方式。涉及图片或扫描内容时,确认已配置可用的视觉模型。

  3. 确认语雀账号对目标文档有读取权限;如需团队数据源,准备环境要求的团队连接信息。个人导入需要在控制台完成语雀授权。

  4. 确保分享或上传的文档允许进入目标知识库。请勿把访问凭据粘贴进文档、日志或提交到代码仓库。

外部数据源接入与语雀(Yuque)增量同步:流程示意,不是运行截图

流程示意,不是运行截图。

查看流程图大图

配置团队数据源

  1. 在目标知识库中打开数据源页,选择创建数据源并填写名称,选择语雀类型。

  2. 根据表单填写团队连接信息和需要访问的知识库范围。可按界面提示选择文档,并按需设置同步计划。配置了版本草稿时,页面可能不提供定时计划。

  3. 如需创建后立即同步,勾选相应选项;否则创建后可在数据源列表中手动发起同步。创建数据源与同步完成是两个不同的状态。

  4. 在数据源列表查看状态和同步记录;若部分文档失败,查看逐项错误并处理权限或来源问题。新增或更新的文档还要完成摄取,才能在知识库中检索。

团队连接的凭据由团队数据源配置使用,不等同于个人语雀登录授权。不要因为团队连接可用就假设当前用户的个人文档也可访问。

从文档页面导入个人语雀文档

  1. 在知识库的文档页选择导入在线文档。页面提供语雀文档地址输入框,每行填写一个受支持的企业版语雀 HTTPS 文档地址,单次最多 20 个;公网语雀域名不受支持。

  2. 按提示完成语雀授权。授权弹窗被浏览器拦截、授权过期或被撤销时,按页面提示重新授权;账号必须有权读取所填文档。若知识库已启用版本管理,先进入要写入的草稿版本;通过接口调用时传入该草稿的实际 versionId。

  3. 提交后检查逐项导入结果。有失败项时先逐项处理;成功导入也不代表摄取已经完成。

  4. 返回文档列表,等待相关文档和摄取任务就绪(ready),再到检索页用可由原文回答的问题验证结果及来源。

导入接口 POST /v1/knowledgebases/{knowledgeBaseId}/documents/yuque 使用已授权的个人语雀会话;全部成功返回 200,有一项或多项失败(包括全部失败)返回 207。它需要当前用户会话或 JWT,不应把服务端项目 API 密钥当作个人语雀授权的替代品。

个人数据源与团队数据源

个人数据源使用当前用户的语雀授权;团队数据源使用团队连接配置。两者的认证方式和可访问内容不同,团队连接正常不代表当前用户已完成个人授权。首次授权前,目标环境需要配置语雀授权能力;如授权入口不可用,请联系环境管理员。

同步状态只说明同步任务的进度或结果,不单独证明每个文档都可检索。请同时检查文档的摄取状态;派生索引是否需要重新构建应以对应索引页的状态提示为准。建议以语雀中的原文为准,通过同步更新知识库,避免在两处独立修改造成内容不一致。

常见问题

相关文档