Skip to main content

设置 Copilot SDK

为用例配置和部署GitHub Copilot SDK。

支持 BYOK(自带密钥)的 Azure 托管标识

Copilot SDK 的 BYOK (自带密钥) 接受静态 API 密钥,但Azure部署通常使用托管标识(Microsoft Entra ID),而不是长期密钥。 由于 SDK 不原生支持 Microsoft Entra 身份验证,因此你可以通过提供程序配置字段 bearer_token 使用短期有效的持有者令牌。

后端服务设置

在服务器端应用程序中运行Copilot SDK-API、Web 后端、微服务和后台辅助角色。 CLI 作为一个无头服务器运行,你的后端代码通过网络连接到它。

默认设置(随附的 CLI)

Node.js 和.NET SDK 包括 Copilot CLI 作为依赖项 , 你的应用附带了它所需的一切,无需额外的安装或配置。

安装指南

这些指南将指导你配置特定用例的 Copilot SDK,从个人端项目到为数千个用户提供服务的生产平台。

GitHub OAuth 设置

让用户使用其GitHub帐户进行身份验证,以便通过应用程序使用Copilot。 这支持个人帐户、组织成员身份和企业标识。

本地 CLI 设置

使用特定的 CLI 二进制文件,而不是 SDK 的自动 CLI 管理。 这是一个高级选项-你显式提供 CLI 路径,你负责确保与 SDK 的版本兼容性。

多租户与服务器部署

多用户服务器模式是指在为多个用户、租户、工作区或集成账户提供服务的后端代码中运行 Copilot SDK。 在此设置中,应用程序拥有请求路由和授权,而 SDK 和运行时提供每会话状态、每会话身份验证和显式工具注册,因此一个用户的会话不会继承其他用户的工具或标识。

缩放和多租户

将 Copilot SDK 部署设计为可为多个用户提供服务、处理并发会话,并可在整个基础设施中实现横向扩展。 本指南介绍会话隔离模式、缩放拓扑和生产最佳做法。