Skip to main content

为 Copilot 扩展配置 GitHub Apps

了解如何配置 GitHub App,使其与 Copilot Extension 相关联。

Tool navigation

Note

GitHub Copilot Extensions 为 公共预览版,可能随时更改。

配置服务器并创建 GitHub App 后,需要将 GitHub App 配置为与 Copilot 扩展一起使用。

先决条件

配置 GitHub App

  1. 在 GitHub 上任意页的右上角,单击你的个人资料照片。

  2. 导航到你的帐户设置。

    • 对于由个人帐户拥有的应用,请单击“设置”****。
    • 对于组织拥有的应用:
      1. 单击“你的组织”。
      2. 在组织的右侧,单击设置
  3. 在左侧边栏中,单击“ 开发人员设置”。

  4. 在左侧边栏中,单击“GitHub Apps”。

  5. 在要为 Copilot Extension 配置的 GitHub App 的右侧,单击“编辑****”。

  6. 在“Identifying and authorizing users”部分的“Callback URL”下,输入回调终结点 URL,然后单击“Save changes”****。

    Note

    服务器的主机名是在配置服务器时从终端复制的转发端点。 请参阅“配置服务器以托管 Copilot 扩展”。

    如果在 ngrok 中使用临时域,则每次重新启动 ngrok 服务器时都需要更新此 URL。

  7. 在左侧边栏中,单击“权限和事件”****。

  8. 要展开“帐户权限”部分,请单击该部分中的任意位置。

  9. 在“GitHub Copilot Chat”行中,选择“访问权限:”**** 下拉菜单,然后单击“只读”****。 单击“保存更改”。

  10. 在左侧边栏中,单击“Copilot”。****

  11. 阅读 GitHub Marketplace 开发人员协议和 GitHub 预发行许可条款,然后接受创建 Copilot Extension 的条款。

  12. 在“应用类型”部分中,选择下拉菜单,然后单击“代理”****。

  13. 在“URL”下,输入从终端复制的服务器主机名(即转发端点)。

    Note

    如果在 ngrok 中使用临时域,则每次重新启动 ngrok 服务器时都需要更新此 URL。

  14. 在“推理说明”下,键入代理的简要说明,然后单击“保存”****。 这是用户在聊天窗口中将鼠标悬停在扩展的数据域上时看到的说明。

  15. 预授权 URL 是网站上的一个链接,用于启动扩展的授权过程。 当用户决定授权扩展时,将被重定向到此 URL。 如果使用的是预授权 URL,请在“预授权 URL”下输入该 URL,然后单击“**** 保存更改”。

  16. 在 GitHub App 设置中,单击左侧边栏的“安装应用 ,然后在要安装应用的帐户旁边单击“安装”。

  17. 在 GitHub 上任何页面的右上角,单击搜索栏旁边的 GitHub Copilot 图标。

    此时将显示 GitHub Copilot Chat 面板。 要调整面板的大小,请单击并拖动顶部或左侧边缘。

  18. 如果面板包含与 Copilot 的前一次对话,请单击面板右上角的“新建对话”图标(加号)。

    “新建对话”按钮的屏幕截图,以深橙色边框突出显示。

  19. 通过键入 @EXTENSION-NAME 来调用扩展,将扩展名称中的任何空格替换为 -,然后按 Enter

  20. 如果这是你第一次使用扩展,系统会提示你进行身份验证。 按照屏幕上的步骤对扩展进行身份验证。

  21. 在聊天窗口中向扩展提问。 例如,What is the software development lifecycle?

  1. 在 GitHub 上任意页的右上角,单击你的个人资料照片。

  2. 导航到你的帐户设置。

    • 对于由个人帐户拥有的应用,请单击“设置”****。
    • 对于组织拥有的应用:
      1. 单击“你的组织”。
      2. 在组织的右侧,单击设置
  3. 在左侧边栏中,单击“ 开发人员设置”。

  4. 在左侧边栏中,单击“GitHub Apps”。

  5. 在要为 Copilot Extension 配置的 GitHub App 的右侧,单击“编辑****”。

  6. 在“Identifying and authorizing users”部分的“Callback URL”下,输入回调终结点 URL,然后单击“Save changes”****。

    Note

    服务器的主机名是在配置服务器时从终端复制的转发端点。 请参阅“配置服务器以托管 Copilot 扩展”。

    如果在 ngrok 中使用临时域,则每次重新启动 ngrok 服务器时都需要更新此 URL。

  7. 在左侧边栏中,单击“权限和事件”****。

  8. 要展开“帐户权限”部分,请单击该部分中的任意位置。

  9. 在“GitHub Copilot Chat”行中,选择“访问权限:”**** 下拉菜单,然后单击“只读”****。 单击“保存更改”。

  10. 在左侧边栏中,单击“Copilot”。****

  11. 阅读 GitHub Marketplace 开发人员协议和 GitHub 预发行许可条款,然后接受创建 Copilot Extension 的条款。

  12. 在“应用类型”部分中,选择下拉菜单,然后单击“Skillset”****。

  13. 预授权 URL 是网站上的一个链接,用于启动扩展的授权过程。 当用户决定授权扩展时,将被重定向到此 URL。 如果使用的是预授权 URL,请在“预授权 URL”下输入该 URL,然后单击“**** 保存更改”。

  14. 对于你想要添加的每项技能(最多 5 项):

    1. 单击“Add new skill”****。
    2. 为技能输入一个清晰的名称(例如“Generate Lorem Ipsum Data”)。****
    3. 编写一个详细的推理描述,以帮助 Copilot 理解何时使用该技能****。
    4. 添加将接收 POST 请求的 API 终结点 URL****。
    5. 在“Parameter”字段中,添加定义预期请求格式的 JSON 架构****。
    6. 单击“Add Definition”以保存技能****。
  15. 单击“Save”以保存技能集****。

  16. 在 GitHub App 设置中,单击左侧边栏的“安装应用 ,然后在要安装应用的帐户旁边单击“安装”。

  17. 在 GitHub 上任何页面的右上角,单击搜索栏旁边的 GitHub Copilot 图标。

    此时将显示 GitHub Copilot Chat 面板。 要调整面板的大小,请单击并拖动顶部或左侧边缘。

  18. 如果面板包含与 Copilot 的前一次对话,请单击面板右上角的“新建对话”图标(加号)。

    “新建对话”按钮的屏幕截图,以深橙色边框突出显示。

  19. 通过键入 @EXTENSION-NAME 来调用扩展,将扩展名称中的任何空格替换为 -,然后按 Enter

  20. 如果这是你第一次使用扩展,系统会提示你进行身份验证。 按照屏幕上的步骤对扩展进行身份验证。

  21. 在聊天窗口中向扩展提问。 例如,What is the software development lifecycle?