Skip to content
Kumiko

ai-provider-openai-compat

Enterprise Part of the commercial Kumiko Enterprise offering — not in the open framework.

Registers the adapters for connections of kind "openai" (api.openai.com) and "openai-compatible" (any server that speaks the OpenAI API: OpenRouter, Groq, Ollama, vLLM, llama.cpp, faster-whisper-server, Kokoro-FastAPI) for text (/chat/completions), transcription (/audio/transcriptions) and read-aloud (/audio/speech) in ai-foundation. Keys, endpoints and the choice of model live in ai-foundation (AI connections, standard models); this package reads the model listing a connection reports and the tenant-declared model profiles. No OpenAI SDK dependency; direct fetch.

Build it yourself

Section titled “Build it yourself”

This Enterprise implementation is optional. If you need a narrower or domain-specific version, you can build a provider adapter with Kumiko’s public extension points.

Use this package when you want the maintained implementation, its existing contracts, and the surrounding operational behavior. A custom implementation is not drop-in compatible automatically: your app owns its authorization, validation, provider integration, tests, security review, and production operations.

Start with Features and composition and the provider registration of AI foundation.

How it fits

Section titled “How it fits”

What this feature needs to run (Requires, top) and the write commands this feature provides (Provides, bottom).

flowchart TB
  n_ai_provider_openai_compat["ai-provider-openai-compat"]
  subgraph how_reqs["Requires"]
    n_ai_foundation["ai-foundation"]
  end
  subgraph how_provides["Provides"]
    n_cmd_ai_provider_openai_compat_write_model_profile_create(["create"])
    n_cmd_ai_provider_openai_compat_write_model_profile_delete(["delete"])
    n_cmd_ai_provider_openai_compat_write_model_profile_update(["update"])
  end
  n_ai_foundation --> n_ai_provider_openai_compat
  n_ai_provider_openai_compat --> n_cmd_ai_provider_openai_compat_write_model_profile_create
  n_ai_provider_openai_compat --> n_cmd_ai_provider_openai_compat_write_model_profile_delete
  n_ai_provider_openai_compat --> n_cmd_ai_provider_openai_compat_write_model_profile_update

Provides — write commands this feature registers (dispatch them through the command bus):

  • ai-provider-openai-compat:write:model-profile:create
  • ai-provider-openai-compat:write:model-profile:delete
  • ai-provider-openai-compat:write:model-profile:update

Dependencies

Section titled “Dependencies”

Extensions & cross-feature APIs

Section titled “Extensions & cross-feature APIs”
  • Registers extension: llmProvider → openai, transcribeProvider → openai, speechProvider → openai, llmProvider → openai-compatible, transcribeProvider → openai-compatible, speechProvider → openai-compatible