Overview

A provider is the transport that talks to one AI vendor. Switch between OpenAI, Anthropic, Gemini, or Mistral via johannschopplich.copilot.provider. The Client forwards every request to the resolved provider unchanged.

Built-in Implementations

Plug In Your Own Provider

Implement the Provider interface to add support for any AI service.

namespace JohannSchopplich\Copilot\AI\Providers;

interface Provider
{
    /**
     * @param list<array{role: string, content: string}> $messages
     * @param array<string, mixed> $schema
     * @return array<string, mixed>
     *
     * @throws ProviderException
     */
    public function generateObject(array $messages, array $schema): array;

    /**
     * @param list<array{role: string, content: string}> $messages
     *
     * @throws ProviderException
     */
    public function generateText(array $messages): string;
}

Both methods throw ProviderException on any failure.

Provider Selection

Client selects a provider via match on the resolved ProviderName enum. Each receives a ProviderConfig with apiKey, model, baseUrl, and an options bag forwarded to the upstream request.

Retry Behavior

A failed retry chain throws ProviderException with the upstream error attached as previous and the response body as responseExcerpt.