实践手册：将SharePoint接入到DTS RAGFlow知识库

步骤一：在Microsoft Entra ID中注册应用程序

1. 登录Azure门户。

2. 在左侧导航栏，选择Microsoft Entra ID。

3. 单击应用注册 > 新注册。

4. 填写应用信息，然后单击注册。

   配置项	说明
   名称	输入应用名称，例如KBSync-SharePoint-Reader。
   支持的账户类型	选择仅此组织目录中的账户（单租户）。
   重定向URI	可留空。客户端凭证流程不需要重定向URI。

5. 注册完成后，在应用概述页面，记录以下信息。

   参数	说明
   应用程序(客户端) ID	应用的唯一标识，对应KBSync配置中的llamahubReader_client_id参数。
   目录(租户) ID	Microsoft Entra租户标识，对应KBSync配置中的llamahubReader_tenant_id参数。

步骤二：创建客户端密钥

1. 在应用页面，选择证书和密码 > 客户端密码。

2. 单击新客户端密钥。

3. 填写描述并选择过期时间（建议选择24个月或从不）。

4. 单击添加后，立即复制密钥值。

   重要

   离开页面后将无法再次查看该密钥值，请务必在创建后立即复制并妥善保存。该密钥对应KBSync配置中的llamahubReader_client_secret参数。

步骤三：配置API权限

1. 在应用页面，选择API权限 > 添加权限。

2. 选择Microsoft Graph > 应用程序权限。

3. 搜索并添加以下权限。

   权限类型	权限名称	说明
   应用程序	Sites.Read.All 或 Sites.Selected	Sites.Read.All：读取所有SharePoint站点（推荐用于全站点访问）。 Sites.Selected：仅读取选定的SharePoint站点（更安全的选项）。 说明 若选择Sites.Selected权限，则需要通过Microsoft Graph API为您的应用显式授权访问特定SharePoint站点。
   应用程序	Files.Read.All	读取所有文件。
   应用程序	BrowserSiteLists.Read.All	读取浏览器站点列表。

4. 获取管理员同意。

   添加权限后，必须获得全局管理员的同意才能生效。

   1. 在API权限页面，单击代表<租户名称>授予管理员同意。

   2. 确认状态列显示为已授予。

   说明

   如果您没有管理员权限，请联系组织的Microsoft 365全局管理员完成此步骤。

步骤四：获取SharePoint站点信息

在配置KBSync之前，需要收集以下SharePoint信息。

步骤一：准备配置文件

1. 获取KBSync程序并准备KBSync程序的运行环境。

   说明

   • 您可以添加钉钉群（群号：79690034672），联系技术支持人员以获取KBSync文件。

   • 运行KBSync程序需要为Linux环境，并且可以访问Microsoft Graph API和RAGFlow。

2. 准备配置文件config。

   1. 创建名为config的Linux系统文件。

   2. 将以下代码复制到config文件中。

      # 基础配置
      sourceType=LlamaHub
      sinkType=RagFlowV2
      whiteList=
      blackList=
      
      sleepTime=600
      jobId=dts_kbsync_llamahub_sharepoint_to_ragflow
      documentSyncMode=full
      
      # LlamaHub Reader 配置
      llamahubReaderClass=llama_index.readers.microsoft_sharepoint.SharePointReader
      llamahubReader_client_id=96b75717-****-****-****-46b70e29bec1
      llamahubReader_tenant_id=c2211d60-****-****-****-fd062b3f8c2b
      llamahubReader_client_secret=Xwd8Q***************DmpRTDmpRTw
      llamahubReader_sharepoint_host_name=contoso.sharepoint.com
      llamahubReader_sharepoint_site_name=Marketing
      llamahubReader_drive_name=Documents
      llamahubLoad_sharepoint_folder_path=Reports
      
      # Sink RAGFlow 配置
      sinkOSSAccessKeyId=
      sinkOSSAccessKeySecret=
      sinkOSSRegion=
      sinkOSSBucket=
      sinkOSSEndpoint=

   3. 替换config文件中的参数。

      重要

      • 无需配置的参数，将其取值设置为空值即可。

      • 参数blackList的优先级高于参数whiteList。

      参数	是否必填	说明	获取方式
      whiteList	否	需要传输（白名单）和无需传输（黑名单）的路径。 说明 支持正则表达式，多个路径需使用空格分隔。	自行在SharePoint中获取目标文件夹路径。
      blackList	否
      sourceType	是	源端的类型。	取值请保持LlamaHub。
      sinkType	是	目标端的类型。	取值请保持RagFlowV2。
      sleepTime	是	增量扫描间隔。	-
      documentSyncMode	是	同步模式： full：全量 inc：增量	-
      llamahubReader_client_id	是	Microsoft Entra ID中注册的应用程序(客户端) ID。	步骤一：在Microsoft Entra ID中注册应用程序。
      llamahubReader_tenant_id	是	Microsoft Entra ID中的目录(租户) ID。
      llamahubReader_client_secret	是	Microsoft Entra ID中创建的客户端密钥。	步骤二：创建客户端密钥。
      llamahubReader_sharepoint_site_name	是	SharePoint站点名称。	步骤四：获取SharePoint站点信息。
      llamahubReader_sharepoint_host_name	否 说明 使用Sites.Selected权限时必填。	SharePoint主机名。
      llamahubReader_drive_name	否	SharePoint文档库名称。默认为Documents。
      llamahubLoad_sharepoint_folder_path	否	文档库中的文件夹路径。不填则传输文档库根目录下的全部内容。
      sinkOSSAccessKeyId	是	OSS Bucket相关信息。	请前往OSS对象存储控制台获取。
      sinkOSSAccessKeySecret	是
      sinkOSSRegion	是
      sinkOSSBucket	是
      sinkOSSEndpoint	是

步骤二：运行KBSync程序

1. 将KBSync文件和配置文件config，放在Linux环境中的同一目录中。

2. 在Linux环境中执行./KBSync --config config命令，运行KBSync程序。