Overview

A provider is the transport that talks to one AI vendor. The Client resolves which one to use from johannschopplich.copilot.provider and forwards every request unchanged – your call sites never know the difference.

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

Each provider receives its providers.<name> entry; the keys the plugin reads itself (completionModel, api, options, timeout) are not forwarded.

Retry Behavior

Every provider applies the per-provider timeout to its HTTP client, so a stalled connection fails rather than blocking. A failed request throws ProviderException with the upstream error attached as previous.