Skip to main content

Copilot SDK を設定する

ユース ケースに合わせて GitHub Copilot SDK を構成してデプロイします。

BYOK を使用した Azure マネージド ID

Copilot SDK の BYOK (独自のキーを持ち込む) は静的 API キーを受け入れますが、Azureデプロイでは、有効期間の長いキーではなくマネージド ID (Microsoft Entra ID) が使用されることがよくあります。 SDK はMicrosoft Entra認証をネイティブにサポートしていないため、bearer_token プロバイダー構成フィールドを介して有効期間の短いベアラー トークンを使用できます。

バックエンド サービスのセットアップ

サーバー側アプリケーション (API、Web バックエンド、マイクロサービス、バックグラウンド ワーカー) で Copilot SDK を実行します。 CLI は、バックエンド コードがネットワーク経由で接続するヘッドレス サーバーとして実行されます。

既定のセットアップ (バンドルされた CLI)

Node.js SDK と .NET SDK には、依存関係として Copilot CLI が含まれています。アプリには必要なものがすべて付属しており、追加のインストールや構成は必要ありません。

セットアップ ガイド

これらのガイドでは、個人側のプロジェクトから数千人のユーザーにサービスを提供する運用プラットフォームまで、特定のユース ケースに合わせて Copilot SDK を構成する手順について説明します。

GitHub OAuth のセットアップ

ユーザーが自分のGitHub アカウントで認証を行い、アプリケーションでCopilotを使用できるようにします。 これにより、個々のアカウント、組織のメンバーシップ、およびエンタープライズ ID がサポートされます。

ローカル CLI のセットアップ

SDK の自動 CLI 管理ではなく、特定の CLI バイナリを使用します。 これは高度なオプションです。CLI パスを明示的に指定し、SDK とのバージョンの互換性を確保する必要があります。

マルチテナントとサーバーの展開

マルチユーザー サーバー モードとは、複数の人間、テナント、ワークスペース、または統合アカウントにサービスを提供するバックエンド コードから Copilot SDK を実行することを意味します。 このセットアップでは、アプリケーションは要求のルーティングと承認を所有しますが、SDK とランタイムはセッションごとの状態、セッションごとの認証、および明示的なツール登録を提供するため、あるユーザーのセッションが別のユーザーのツールまたは ID を継承しません。

スケーリングとマルチテナント

複数のユーザーにサービスを提供し、同時セッションを処理し、インフラストラクチャ全体で水平方向にスケーリングするように、Copilot SDK のデプロイを設計します。 このガイドでは、セッション分離パターン、スケーリング トポロジ、運用のベスト プラクティスについて説明します。