GitHub Cloud Knowledge 智能 Microsoft 365 Copilot 副驾驶® 连接器 (预览版)

借助 GitHub 云知识智能 Microsoft 365 Copilot 副驾驶®连接器,可为 GitHub 存储库中的内容编制索引,使其在 Microsoft 365 生态系统中轻松进行搜索。 此连接器非常适合使用 GitHub Cloud 进行文档、项目文件或内容管理的组织。 通过将 GitHub 数据与Microsoft搜索集成,用户可以直接在 Microsoft 365 应用程序中访问相关内容,从而简化工作流并减少在平台之间切换的需要。

本文适用于 Microsoft 365 管理员或配置、运行和监视 GitHub Cloud Knowledge Copilot 连接器的任何人。

功能

  • 为 GitHub 云存储库和 markdown 文件编制索引,使项目文档在 Microsoft 365 中可访问。
  • 使最终用户能够在 Copilot 中提出与项目文档和技术指南相关的问题。
    • 如何实现设置 Project Alpha?
    • 在哪里可以找到部署说明?
    • 此项目的体系结构概述是什么?
    • 汇总项目文档中的关键部分以供快速参考
  • Copilot 中使用语义搜索 ,使用户能够根据关键字、个人偏好和社交关系查找相关内容。

限制

  • 仅对存储库元数据和 markdown 文件编制索引。 其他 GitHub 实体(如问题、拉取请求和注释)不会编制索引。
  • 仅支持大小为 1 MB 的 Markdown 文件。 不会为较大的文件编制索引。

先决条件

  • 你必须是组织的 Microsoft 365 租户的 搜索管理员
  • 确保可以通过 API 访问 GitHub 实例。
  • 按照此处所述的步骤配置和设置身份验证GitHub Apps。
  • 确保访问已编制索引的 GitHub 数据的用户具有用于权限映射的相应Microsoft Entra ID标识。
  • 对于通过单 Sign-On (SSO) 进行身份验证的企业托管用户,必须在执行任何作之前登录帐户,因为 GitHub 身份验证流当前不支持 SSO 登录。

为身份验证设置GitHub Apps

按照以下步骤创建用于 Graph 连接器的GitHub Apps:

  1. 在 GitHub 中,单击个人资料照片 (右上角) ,选择“你的组织”,然后选择 Graph 连接器应从中拉取数据的组织。

    显示如何访问“你的组织”的屏幕截图。

  2. 在组织概述页上,单击 “设置”。

    显示如何访问组织页中的“设置”的屏幕截图。

  3. 在左侧边栏中,向下滚动到 “开发人员设置” ,然后单击“ GitHub 应用”。

    显示如何访问 GitHub 应用的屏幕截图。

  4. 单击“新建GitHub Apps”。

    显示创建新应用的入口点的屏幕截图。

  5. 配置应用:

    • GitHub Apps名称:输入所选的名称。
    • 主页 URL:从浏览器地址栏复制 URL, (根据需要) 引用图像。
    • 回调 URL
      • 对于Microsoft 365 企业版:https://gcs.office.com/v1.0/admin/oauth/callback

      • 对于 Microsoft 365 政府版: https://gcsgcc.office.com/v1.0/admin/oauth/callback

        显示应用配置的初始部分(包括名称和 URL)的屏幕截图。

  6. 安装过程中选中“ (OAuth) 请求用户授权 ”并禁用 “Webhook ”选项。

    应用配置所需的某些检查框的屏幕截图。

  7. 设置以下权限:

    • 存储库权限:内容 (只读) 、元数据 (只读)
    • 组织权限:成员 (只读)
    • 帐户权限:Email地址 (只读)
  8. 在“安装此GitHub Apps的位置”下,选择“任何帐户”,然后单击“创建GitHub Apps”。

    显示 GitHub 应用设置的最终步骤的屏幕截图。

  9. 在GitHub Apps的“常规”页上,单击“生成新的客户端密码”来生成并复制客户端密码。 然后单击“ 安装应用”。

    显示应用的凭据(包括客户端 ID 和客户端密码)的屏幕截图。

  10. 选择要安装应用的组织。 安装后,即可配置连接器。

    显示应用安装对话框的屏幕截图。

入门

1. 显示名称

显示名称用于标识 Copilot 中的每个引文,帮助用户轻松识别关联的文件或项目。 显示名称还表示受信任的内容。 显示名称也用作 内容源筛选器。 此字段存在默认值,但你可以将其自定义为组织中的用户可识别的名称。

2.身份验证类型

  • 选择“代表) 用户GitHub Apps (”作为身份验证方法。
  • 输入前面创建的GitHub Apps中的“客户端 ID”和“客户端密码”。
  • 单击“ 授权 ”以登录并授予所需的访问权限。

3. 面向有限受众推出

如果要先在 Copilot 和其他搜索图面中验证此连接,然后再将此连接部署到有限的用户群,然后再将它扩展到更广泛的受众。 若要详细了解有限推出,请参阅 分阶段推出

自定义设置

自定义设置适用于想要编辑所列设置的默认值的管理员。 单击“自定义设置”选项后,会看到另外三个选项卡 - 用户、内容和同步。

用户

访问权限

GitHub 云知识连接器支持对仅 有权访问此数据源的人员 可见的搜索权限, (默认) 或 所有人。 如果选择“ 仅有权访问此数据源的人员”,则索引数据将显示在有权访问这些数据源的用户的搜索结果中。 如果选择“ 所有人”,则索引数据将显示在所有用户的搜索结果中。

映射标识

在自定义设置中,可以编辑用户、内容和同步的任何默认值。为确保正确实施权限,请将 GitHub 用户标识映射到Microsoft Entra ID。 以下是选项:

  • Email:将 GitHub 电子邮件映射到Microsoft Entra ID用户属性。
  • 登录名:使用Microsoft Entra ID用户属性映射 GitHub 登录名。
  • 名称:使用Microsoft Entra ID用户属性映射 GitHub 名称。

如果直接映射失败,请使用正则表达式 (正则表达式) 来转换数据。 例如:[a-zA-Z0-9]+ 对于个人帐户,由于电子邮件域和单个电子邮件可见性设置的变化,映射准确性可能会受到影响。

有关标识转换,请参阅 映射非 Azure AD 标识

有关标识转换的详细信息,请参阅 映射非 Azure AD 标识

内容

选择存储库和文件类型 (最初 markdown 文件和其他非代码文档) 您希望搜索。

“管理属性” 下,可以在 GitHub 数据源中添加或删除可用属性,将架构分配给属性, (定义属性是可搜索的、可查询的、可检索的还是可精简的) ,更改语义标签并向属性添加别名。

同步

刷新间隔确定数据在数据源和 Graph 连接器索引之间同步的频率。 有两种类型的刷新间隔 - 完全爬网和增量爬网。 有关详细信息,请参阅 刷新设置

下面是默认值:

  • 默认情况下,增量爬网每 15 分钟运行一次。
  • 完全爬网每天运行,以确保最新的索引编制。

如果需要,可以从此处更改刷新间隔的默认值。

疑难解答

发布连接后,可以在管理中心的“数据源”选项卡下查看状态。 若要了解如何进行更新和删除,请参阅 管理连接器

注意

使用 索引浏览器 标识索引项时,存储库和文件名 区分大小写。 请确保匹配确切的大小写以检索准确的结果。

如果遇到问题或想要提供反馈,请联系 Microsoft Graph |支持