aisdk/openai-compatible

Shared OpenAI-compatible chat-completions wire format (request builder, response/stream parsers) for the PHP AI SDK.

Maintainers

Package info

github.com/phpaisdk/openai-compatible

pkg:composer/aisdk/openai-compatible

Statistics

Installs: 2

Dependents: 1

Suggesters: 0

Stars: 0

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

v0.1.0-alpha1 2026-06-30 05:22 UTC

Requires

Requires (Dev)

MIT fcd3c2e5e24bad346d2e73fd09502570a0bb70bd

aillmchat-completionsopenai-compatibleaisdk

This package is auto-updated.

Last update: 2026-06-30 05:42:02 UTC

README

Shared OpenAI-compatible chat-completions wire adapter for the PHP AI SDK. Reusable by any provider that speaks the OpenAI /chat/completions REST/SSE protocol.

Installation

composer require aisdk/openai-compatible

What This Package Does

This package provides the shared wire-format bridge between core portable contracts (AiSdk\*) and the OpenAI-compatible chat-completions shape. It is used by providers like Groq, xAI, OpenRouter, and others that implement the OpenAI-compatible API.

It owns:

  • Request body building (ChatRequestBuilder)
  • Response parsing (ChatResponseParser)
  • SSE stream parsing (ChatStreamParser)
  • Message conversion (ChatMessageConverter)
  • Tool conversion (ChatToolConverter)
  • Usage normalization (ChatUsage)
  • Finish reason mapping (MapsFinishReason)

It does not own:

  • Provider authentication
  • Model catalogs
  • Provider-specific quirks or fallback behavior

Usage

This package is consumed by provider packages, not directly by end users. A provider that speaks OpenAI-compatible chat completions uses it like this:

use AiSdk\OpenAICompatible\ChatRequestBuilder;
use AiSdk\OpenAICompatible\ChatResponseParser;
use AiSdk\OpenAICompatible\ChatStreamParser;

$body = ChatRequestBuilder::build($modelId, $providerName, $request, stream: false);
$payload = $this->runner()->postJson($url, $body, $headers, $providerName);
$response = ChatResponseParser::parse($payload, $providerName);

Provider Integration

To build a provider on top of this package:

  1. Depend on aisdk/core and aisdk/openai-compatible.
  2. Create a provider class extending BaseProvider.
  3. Create a text model extending BaseModel that calls ChatRequestBuilder::build(), ChatResponseParser::parse(), and ChatStreamParser::parse().
  4. Add provider-specific auth, base URL, headers, and model catalog.
  5. Apply any provider-specific adaptations (e.g., structured output downgrades) after calling ChatRequestBuilder::build().

Testing

composer test

Links