llm4s-docs
API
Generated with
llm4s-docs/org.llm4s/org.llm4s.llmconnect/org.llm4s.llmconnect.provider/Llm4sOpenAICompatibleModule

Llm4sOpenAICompatibleModule

org.llm4s.llmconnect.provider.Llm4sOpenAICompatibleModule
@Stable
final class Llm4sOpenAICompatibleModule extends Llm4sProviderModule

Registers llm4s-openai-compatible's providers: the generic openai-compatible provider, for any endpoint speaking the OpenAI /chat/completions API, DeepSeek (deepseek), Z.ai (zai), OpenRouter (openrouter), Mistral (mistral), Cohere (cohere, through its OpenAI-compatibility API) and xAI (xai), each running on OpenAICompatibleClient with its own OpenAICompatibleDialect.

Declared in this module's META-INF/services/org.llm4s.llmconnect.spi.Llm4sProviderModule, so adding the llm4s-openai-compatible dependency is all it takes for ProviderRegistry.default to resolve these ids. Where discovery cannot run - a fat jar whose services files were overwritten rather than merged - register it explicitly:

given ProviderRegistry = ProviderRegistry.ofModules(new Llm4sOpenAICompatibleModule)

A class rather than an object because java.util.ServiceLoader instantiates the class named in the services file through its public no-arg constructor.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

override def chatProviders: Seq[ProviderDescriptor]

The chat providers this module supplies.

The chat providers this module supplies.

Attributes

Definition Classes

Inherited methods

def embeddingProviders: Seq[EmbeddingProviderDescriptor]

The embedding providers this module supplies.

The embedding providers this module supplies.

Both lists default to empty, so a module contributes whichever halves it has: llm4s-anthropic overrides only chatProviders, a Voyage or Jina module only embeddingProviders, and llm4s-ollama both.

Attributes

Inherited from:
Llm4sProviderModule
Generated with