设置 Copilot 扩展

按照以下步骤开始构建 Copilot 扩展。

本文内容

注意

GitHub Copilot 扩展处于公开预览阶段，可能会发生变化。

1. 了解 Copilot 代理

Copilot 代理包含 Copilot 扩展的自定义代码，并与 GitHub 应用集成以形成 Copilot 扩展本身。更多信息，请参阅“[关于 Copilot 代理](/en/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/about-copilot-agents)”。

要成功构建 Copilot 代理，你需要了解代理如何与以下内容通信：

  • 使用服务器发送事件的 Copilot 平台。请参阅“[配置你的 Copilot 代理以与 Copilot 平台通信](/en/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/configuring-your-copilot-agent-to-communicate-with-the-copilot-platform)”。
  • GitHub API。请参阅“[配置你的 Copilot 代理以与 GitHub 通信](/en/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/configuring-your-copilot-agent-to-communicate-with-github)”。

2. 查看 Copilot 代理示例和 Copilot 扩展 SDK

要了解实践中的先前概念并了解代理实现，请查看以下示例代理和软件开发工具包 (SDK)，所有这些都可以在 copilot-extensions 组织中找到

  • Blackbeard（最佳起点）：一个简单的代理，使用 Copilot 的大型语言模型 (LLM) API 和特殊的系统提示来响应类似海盗的请求。
  • GitHub 模型：一个更复杂的代理，允许你通过 Copilot 聊天询问和交互 GitHub Marketplace 上列出的各种 LLM。GitHub 模型代理利用了函数调用。
  • 函数调用：一个用 Go 编写的示例代理，演示了函数调用和确认对话框。
  • RAG 扩展：一个用 Go 编写的示例代理，演示了检索增强生成 (RAG) 的简单实现。
  • 预览 SDK：一个简化 Copilot 扩展开发的 SDK，它会自动处理请求验证、有效负载解析和响应格式化。此 SDK 允许扩展构建者更专注于创建核心功能，而不是样板代码。

3. 构建 Copilot 代理

使用前面步骤中的参考材料，规划和构建你的 Copilot 代理。你可以选择实现以下任何选项：

  • 为了避免构建和管理你自己的 LLM 部署，你的代理可以调用 Copilot LLM 部署。请参阅“[为你的代理使用 Copilot 的 LLM](/en/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/using-copilots-llm-for-your-agent)”。
  • 要快速解释用户输入并从各种预定义函数中选择要执行的函数，你可以在你的代理中实现函数调用。要了解更多信息，请参阅 Azure OpenAI 文档中的“[如何使用 Azure OpenAI 服务进行函数调用](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling)”和 OpenAI 文档中的“[函数调用](https://platform.openai.com/docs/guides/function-calling)”。

4. 部署你的 Copilot 代理

要使你的 Copilot 代理可供 Copilot 平台和 GitHub 访问，你需要将其部署到可以通过 HTTP 请求访问的服务器。请参阅“[配置你的服务器以部署你的 Copilot 代理](/en/copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-server-to-deploy-your-copilot-agent)”。

5. 创建 GitHub 应用并将其与你的 Copilot 代理集成

要创建 Copilot 扩展，你需要创建和配置一个 GitHub 应用，然后将其与你的 Copilot 代理集成。请参阅“[为你的 Copilot 扩展创建一个 GitHub 应用](/en/copilot/building-copilot-extensions/creating-a-copilot-extension/creating-a-github-app-for-your-copilot-extension)”和“[为你的 Copilot 代理配置你的 GitHub 应用](/en/copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-github-app-for-your-copilot-agent)”。

6. 选择 Copilot 扩展的可用性

为你的 Copilot 扩展选择两个可见性级别之一：

  • **公开**：任何拥有扩展安装页面链接的用户或组织帐户都可以安装它。
  • **私有**：只有创建扩展的用户或组织帐户才能安装它。

如果你公开你的 Copilot 扩展，你就可以选择将其列在 GitHub Marketplace 上。

要了解如何更改 Copilot 扩展的可见性并将其列在 GitHub Marketplace 上，请参阅“[管理 Copilot 扩展的可用性](/en/copilot/building-copilot-extensions/managing-the-availability-of-your-copilot-extension)”。

后续步骤

要了解如何使用你的 Copilot 扩展，请参阅“[使用扩展将外部工具与 Copilot 聊天集成](/en/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat)”。