Skip to content

Http Client

Polyglot does not implement its own HTTP transport. It builds on the shared HTTP package, keeping transport concerns separate from request and response normalization. This separation means you can swap HTTP implementations, add middleware, or inject test doubles without touching the driver layer.

The Transport Contract

All HTTP communication flows through a single contract:

interface CanSendHttpRequests
{
    public function send(HttpRequest $request): PendingHttpResponse;
}
// @doctest id="8e46"

Inference, embeddings, and Decision drivers receive a CanSendHttpRequests implementation. Each driver translates its domain request into an HttpRequest, resolves the PendingHttpResponse, and normalizes the result into its operation-specific response.

Default Client

When a runtime is created from config without an HTTP client, Polyglot creates a default one using HttpClientBuilder. This applies to InferenceRuntime, EmbeddingsRuntime, and DecisionRuntime:

$httpClient = (new HttpClientBuilder(events: $events))->create();
// @doctest id="aecd"

The builder selects an appropriate underlying HTTP library (Guzzle, Symfony HttpClient, or Laravel's HTTP client) based on what is available in your project.

You can inject your own client when you need specific configuration:

use Cognesy\Http\Creation\HttpClientBuilder;

$httpClient = (new HttpClientBuilder())
    ->withMiddleware(new MyLoggingMiddleware())
    ->create();

$runtime = InferenceRuntime::fromConfig($config, httpClient: $httpClient);
// @doctest id="db81"

Pass the same client through DecisionRuntime::fromConfig(..., httpClient: $httpClient) when transport customization or mock HTTP behavior is required. Decision owns its retry loop, so avoid wrapping Decision calls in a second HTTP retry middleware.

HttpRequest and HttpResponse

These data objects represent the HTTP layer's request and response. Drivers create HttpRequest objects through their request adapters and read HttpResponse objects through their response adapters.

HttpRequest

$request = new HttpRequest(
    url: 'https://api.openai.com/v1/chat/completions',
    method: 'POST',
    headers: ['Authorization' => 'Bearer ...', 'Content-Type' => 'application/json'],
    body: ['model' => 'gpt-4.1-nano', 'messages' => [...]],
    options: ['stream' => true],
);

$request->url();        // string
$request->method();     // string
$request->headers();    // array
$request->body();       // HttpRequestBody
$request->options();    // array
$request->isStreamed(); // bool

// Create a copy with streaming toggled
$streamRequest = $request->withStreaming(true);
// @doctest id="71b2"

HttpResponse

The HttpResponse interface provides access to the response data:

$response->statusCode(); // int
$response->headers();    // array
$response->body();       // string -- the full response body
$response->stream();     // Generator -- for streaming responses
$response->original();   // mixed -- the underlying library's native response
// @doctest id="4ec5"

For streaming, the stream() method returns a Generator that yields chunks as they arrive from the provider. The driver's response adapter parses these chunks into SSE events and then into PartialInferenceDelta objects.

Middleware

The HTTP client supports a middleware stack for cross-cutting concerns like logging, retries, caching, and authentication. Middleware implements the HttpMiddleware interface:

interface HttpMiddleware
{
    public function handle(
        HttpRequest $request,
        CanHandleHttpRequest $next,
    ): HttpResponse;
}
// @doctest id="2d37"

The BaseMiddleware abstract class provides convenient hooks so you do not need to manage the chain manually:

abstract class BaseMiddleware implements HttpMiddleware
{
    // Called before the request is sent
    protected function beforeRequest(HttpRequest $request): void {}

    // Called after the response is received
    protected function afterRequest(
        HttpRequest $request,
        HttpResponse $response,
    ): HttpResponse {
        return $response;
    }

    // Determines whether to wrap the response
    protected function shouldDecorateResponse(
        HttpRequest $request,
        HttpResponse $response,
    ): bool {
        return false;
    }

    // Wraps the response if shouldDecorateResponse returns true
    protected function toResponse(
        HttpRequest $request,
        HttpResponse $response,
    ): HttpResponse {
        return $response;
    }
}
// @doctest id="db89"

Managing the Middleware Stack

The MiddlewareStack supports named middleware for easy manipulation:

$client->middleware()->append($middleware, name: 'logging');
$client->middleware()->prepend($middleware, name: 'auth');
$client->middleware()->replace('logging', $newMiddleware);
$client->middleware()->remove('logging');
$client->middleware()->has('logging'); // bool
$client->middleware()->get('logging'); // ?HttpMiddleware
$client->middleware()->all();          // array
$client->middleware()->clear();        // self
// @doctest id="c29e"

Middleware runs in stack order: middleware added with prepend() runs before middleware added with append(). The name parameter is optional but recommended -- it allows you to replace or remove middleware later without tracking references.

Stream Cache Manager

For advanced use cases, Polyglot supports stream caching through the CanManageStreamCache contract. When provided, the stream cache manager can record and replay streaming responses, which is useful for testing and development:

$runtime = InferenceRuntime::fromConfig(
    $config,
    streamCacheManager: $cacheManager,
);
// @doctest id="cae5"

The cache behavior is controlled per-request through the ResponseCachePolicy enum on the InferenceRequest. You can set this through the facade:

use Cognesy\Polyglot\Inference\Enums\ResponseCachePolicy;

$inference->withResponseCachePolicy(ResponseCachePolicy::Memory);
// @doctest id="6fce"

Shared Event Dispatcher

The HTTP client shares the same event dispatcher as the runtime that created it. This means HTTP-level events (connection errors, timeouts, etc.) flow through the same event system as inference events, providing a unified observability pipeline.