カスタムプロバイダー

カスタムプロバイダー（BYOK - Bring Your Own Key）を使用すると、独自の API キーで OpenAI 互換の API エンドポイントに接続できます。Ollama などのローカルプロバイダーもサポートしています。

ProviderConfig

ProviderConfig クラスは以下のプロパティを持ちます。

プロパティ	型	説明
`baseUrl`	`string`	必須。APIエンドポイントのURL
`type`	`string\|null`	プロバイダータイプ。`openai`（デフォルト）、`azure`、`anthropic`
`wireApi`	`string\|null`	APIフォーマット（openai/azureのみ）。`completions`（デフォルト）または`responses`
`apiKey`	`string\|null`	APIキー。Ollamaなどのローカルプロバイダーでは不要
`apiKeyCommand`	`string\|null`	各プロバイダーリクエストの前に Copilot ランタイムが実行し、最新の API キーを取得するコマンド。コマンド失敗時はモデルリクエスト前にターンが失敗します。`bearerTokenProvider` を指定した場合は実行されません
`bearerToken`	`string\|null`	Bearer Token認証用。`apiKey`より優先される
`bearerTokenProvider`	`callable\|null`	各プロバイダーリクエストでBearerトークンを取得するコールバック。シリアライズされません
`azure`	`array\|null`	Azure固有のオプション。`['apiVersion' => '2024-10-21']`など

基本的な使い方

カスタムプロバイダーを使用する場合、model パラメータは必須です。

use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Types\ProviderConfig;
use Revolution\Copilot\Types\SessionConfig;

$response = Copilot::run(
    prompt: 'Hello!',
    config: new SessionConfig(
        model: 'gpt-4', // カスタムプロバイダー使用時は必須
        provider: new ProviderConfig(
            baseUrl: 'https://my-api.example.com/v1',
            apiKey: config('services.openai.key'),
        ),
    ),
);

配列形式でも指定可能です。

$response = Copilot::run(
    prompt: 'Hello!',
    config: [
        'model' => 'gpt-4',
        'provider' => [
            'baseUrl' => 'https://my-api.example.com/v1',
            'apiKey' => config('services.openai.key'),
        ],
    ],
);

Ollama（ローカルプロバイダー）

Ollama などのローカルプロバイダーでは apiKey は不要です。

use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Types\ProviderConfig;
use Revolution\Copilot\Types\SessionConfig;

$response = Copilot::run(
    prompt: 'Hello!',
    config: new SessionConfig(
        model: 'deepseek-coder-v2:16b',
        provider: new ProviderConfig(
            type: 'openai',
            baseUrl: 'http://localhost:11434/v1',
        ),
    ),
);

Azure OpenAI

Azure OpenAI を使用する場合、以下の点に注意してください。

type は必ず azure を指定（openai ではなく）
baseUrl にはホストのみを指定（/openai/v1 などのパスは含めない）

use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Types\ProviderConfig;
use Revolution\Copilot\Types\SessionConfig;

$response = Copilot::run(
    prompt: 'Hello!',
    config: new SessionConfig(
        model: 'gpt-4',
        provider: new ProviderConfig(
            type: 'azure', // Azureエンドポイントでは必ず'azure'を指定
            baseUrl: 'https://my-resource.openai.azure.com', // ホストのみ
            apiKey: config('services.azure.openai_key'),
            azure: [
                'apiVersion' => '2024-10-21',
            ],
        ),
    ),
);

Azure Managed Identity

有効期限付きトークンを使う場合は、bearerTokenProviderで各リクエスト時にトークンを取得できます。コールバックにはproviderNameとsessionIdを含む配列が渡されます。次の例では、アプリケーション側のトークン取得サービスを呼び出します。

use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Types\ProviderConfig;
use Revolution\Copilot\Types\SessionConfig;

$response = Copilot::run(
    prompt: 'Hello!',
    config: new SessionConfig(
        model: 'gpt-4',
        provider: new ProviderConfig(
            type: 'azure',
            baseUrl: 'https://my-resource.openai.azure.com',
            azure: ['apiVersion' => '2024-10-21'],
            bearerTokenProvider: fn (array $args): string => app(AzureManagedIdentityTokenProvider::class)->getToken(),
        ),
    ),
);

トークンの取得・キャッシュ・更新はコールバック側で行ってください。ランタイムは各プロバイダーリクエストでコールバックを呼び出します。

API キーコマンド

ローテーションされる API キーを使う場合は、apiKeyCommand で各プロバイダーリクエストの前にコマンドを実行して最新のキーを取得できます。コマンドはこのパッケージではなく Copilot ランタイムが実行します。

use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Types\ProviderConfig;
use Revolution\Copilot\Types\SessionConfig;

$response = Copilot::run(
    prompt: 'Hello!',
    config: new SessionConfig(
        model: 'gpt-4',
        provider: new ProviderConfig(
            baseUrl: 'https://my-api.example.com/v1',
            apiKeyCommand: config('services.my_api.key_command'),
        ),
    ),
);

apiKeyCommand は null または空白でない文字列である必要があります。空文字列や空白のみの場合は、リクエスト送信前に InvalidArgumentException が発生します。配列形式で文字列以外を指定した場合も InvalidArgumentException になります。ProviderConfig コンストラクターに文字列以外を渡すと、PHP の型チェックにより TypeError が発生します。例外メッセージにコマンドは含まれません。
コマンドの失敗はランタイム側でターンの失敗として扱われ、モデルへのリクエストは送信されません。
bearerTokenProvider を指定するとそちらが優先され、apiKeyCommand は実行されません。
コマンド文字列は資格情報と同様に機密として扱い、ログや例外メッセージに出力しないでください。このパッケージもコマンドやその出力をログに記録しません。
apiKeyCommand は ProviderConfig のみで利用できます（NamedProviderConfig では未対応）。

重要な注意点

カスタムプロバイダー使用時は model パラメータが必須です。指定しないとエラーになります。

Azureエンドポイント（*.openai.azure.com）では、必ず type: 'azure' を使用してください
baseUrl はホストのみを指定し、パスの構築は SDK が自動的に行います

onListModels ハンドラー

BYOK モードでカスタムプロバイダーを使用している場合、client->listModels() が CLI サーバーではなくカスタムハンドラーを呼び出すように設定できます。 listModelsUsing() メソッドを使って設定します。client は初期化されやすいため、listModels() の前に常に listModelsUsing() を設定してください。

use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Types\ModelInfo;

$models = Copilot::client()->listModelsUsing(function (): array {
    // カスタムプロバイダーで利用可能なモデルを返す
    return [
        ['id' => 'my-model-1', 'name' => 'My Model 1', 'version' => '1.0'],
        ['id' => 'my-model-2', 'name' => 'My Model 2', 'version' => '2.0'],
    ];
})->listModels();

null を渡すとハンドラーを解除してデフォルトの CLI サーバー動作に戻ります。

// ハンドラーを解除してデフォルト動作（CLIサーバーに問い合わせ）に戻す
$models = Copilot::client()->listModelsUsing(null)->listModels();

listModelsUsing() が設定されている場合、listModels() は CLI サーバーへの接続を必要とせず、キャッシュも使用しません。

最新情報は GitHub リポジトリを参照してください。

GitHub Copilot

SDK

AI SDK

VOICEVOX

スターターキット

フィード・RSS

ミドルウェア

カスタムプロバイダー