アーキテクチャの概要
すべてのCopilot SDK 統合は、同じコア パターンに従います。アプリケーションは SDK と通信し、JSON-RPC 経由で Copilot CLI と通信します。 セットアップ間の変更点は、 CLI の実行場所、 ユーザーの認証方法、 およびセッションの管理方法です。
以下のセットアップ ガイドは、シナリオに合わせて各レイヤーを構成するのに役立ちます。
あなたは誰ですか。
🧑💻 愛好家
パーソナル アシスタント、サイド プロジェクト、または試験的なアプリを構築しています。 コードでCopilotを取得するための最も簡単なパスが必要です。
最初に次の内容を使用します。
- ** 既定のセットアップ (バンドルされた CLI)** -SDK には CLI が自動的に含まれています。インストールして実行するだけです
- ** ローカル CLI のセットアップ** - 独自の CLI バイナリまたは実行中のインスタンスを使用する (詳細)
🏢 内部アプリ開発者
あなたはチームや会社のためのツールを構築しているところです。 ユーザーは、エンタープライズ GitHub アカウントまたは組織メンバーシップで認証する必要がある従業員です。
最初に次の内容を使用します。
- ** GitHub OAuth のセットアップ** - 従業員が自分のGitHub アカウントでサインインできるようにします
- ** バックエンド サービスのセットアップ** - 内部サービスで SDK を実行する
1 台のサーバーを超えてスケーリングする場合:
- ** スケーリングとマルチテナント** - 複数のユーザーとサービスを処理する
🚀 アプリ開発者 (ISV)
顧客向けの製品を構築しています。 GitHubまたは ID を自分で管理することで、ユーザーの認証を処理する必要があります。
最初に次の内容を使用します。
- ** GitHub OAuth のセットアップ** — 顧客が GitHub でサインインできるようにします
- ** BYOK (bring your own key)** - 独自のモデル キーを使用して ID を自分で管理する
- ** バックエンド サービスのセットアップ** - サーバー側コードから製品に電力を供給する
プロダクション環境の場合:
- ** スケーリングとマルチテナント** - 多くのお客様に確実にサービスを提供する
🏗️ プラットフォーム開発者
Copilot をプラットフォーム (API、開発者ツール、または他の開発者が構築するインフラストラクチャ) に埋め込んでいます。 セッション、スケーリング、マルチテナントをきめ細かく制御する必要があります。
最初に次の内容を使用します。
- ** バックエンド サービスのセットアップ** - コア サーバー側の統合
- ** スケーリングとマルチテナント** - セッションの分離、水平スケーリング、永続化
認証モデルに応じて、次の手順を実行します。
- ** GitHub OAuth のセットアップ**— GitHub認証されたユーザーの場合
- ** BYOK (bring your own key)** - 自己管理 ID とモデル アクセス用
デシジョン マトリックス
次の表を使用して、実行する必要がある内容に基づいて適切なガイドを見つけます。
| 必要なもの | ガイド |
|---|---|
| すぐに始める | |
| 既定のセットアップ (バンドルされた CLI) | |
| 独自の CLI バイナリまたはサーバーを使用する | |
| ローカル CLI のセットアップ | |
| ユーザーがGitHubでサインインする | |
| GitHub OAuth のセットアップ | |
| 独自のモデル キー (OpenAI、Azure など) を使用する | |
| BYOK (bring your own key) | |
| マネージド ID を使用した Azure BYOK (API キーなし) | |
| BYOK を使用した Azure マネージド ID | |
| サーバーで SDK を実行する | |
| バックエンド サービスのセットアップ | |
| 複数のユーザーにサービスを提供する/水平方向にスケーリングする | |
| スケーリングとマルチテナント |
構成の比較
Prerequisites
すべてのガイドでは、次のことを前提としています。
- インストールされている SDK の 1 つ (Node.js、Python、.NET SDK には CLI が自動的に含まれます)。
- Node.js:
npm install @github/copilot-sdk - パイソン:
pip install github-copilot-sdk - Go:
go get github.com/github/copilot-sdk/go(個別の CLI インストールが必要) - .NET：
dotnet add package GitHub.Copilot.SDK
- Node.js:
まったく新しい場合は、最初に 初めてのCopilot搭載アプリを構築する から始めてから、運用環境の構成のためにここに戻ります。
次のステップ
上記の 決定マトリックス から状況に一致するガイドを選択するか、ロールに最も近いペルソナの説明から始めます。