core
API
Generated with
core/org.llm4s/org.llm4s.llmconnect/org.llm4s.llmconnect.provider

org.llm4s.llmconnect.provider

package org.llm4s.llmconnect.provider

Members list

Type members

Classlikes

class AnthropicClient(config: AnthropicConfig) extends LLMClient

Attributes

Companion
object
Supertypes
trait LLMClient
class Object
trait Matchable
class Any
object AnthropicClient

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
trait EmbeddingProvider

Text embedding provider interface for generating vector representations.

Text embedding provider interface for generating vector representations.

Provides a unified interface for different embedding services (OpenAI, VoyageAI, Ollama). Each implementation handles provider-specific API calls and response formats.

Text content is the primary input; multimedia content (images, audio) should be processed through the UniversalEncoder façade which handles content extraction before embedding.

== Usage Example ==

val provider: EmbeddingProvider = OpenAIEmbeddingProvider.fromConfig(config)
val request = EmbeddingRequest(
 input = Seq("Hello world", "How are you?"),
 model = EmbeddingModelName("text-embedding-3-small")
)
val result: Result[EmbeddingResponse] = provider.embed(request)

Attributes

See also

OpenAIEmbeddingProvider for OpenAI text-embedding models

VoyageAIEmbeddingProvider for VoyageAI embedding models

OllamaEmbeddingProvider for local Ollama embedding models

Supertypes
class Object
trait Matchable
class Any
sealed trait LLMProvider

Enumeration of supported LLM providers.

Enumeration of supported LLM providers.

Defines the available language model service providers that can be used with llm4s. Each provider has specific configuration requirements and API characteristics.

Attributes

See also

org.llm4s.llmconnect.config.ProviderConfig for provider-specific configuration

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Anthropic
object Azure
object Ollama
object OpenAI
object OpenRouter
object LLMProvider

Companion object providing LLM provider instances and utilities.

Companion object providing LLM provider instances and utilities.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class OllamaClient(config: OllamaConfig) extends LLMClient

Attributes

Companion
object
Supertypes
trait LLMClient
class Object
trait Matchable
class Any
object OllamaClient

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
object OllamaEmbeddingProvider

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
class OpenAIClient extends LLMClient

LLMClient implementation supporting both OpenAI and Azure OpenAI services.

LLMClient implementation supporting both OpenAI and Azure OpenAI services.

Provides a unified interface for interacting with OpenAI's API and Azure's OpenAI service. Handles message conversion between llm4s format and OpenAI format, completion requests, streaming responses, and tool calling (function calling) capabilities.

Uses Azure's OpenAI client library internally, which supports both direct OpenAI and Azure-hosted OpenAI endpoints.

== Extended Thinking / Reasoning Support ==

For OpenAI o1/o3/o4 models with reasoning capabilities, use OpenRouterClient instead, which fully supports the reasoning_effort parameter. The Azure SDK used by this client does not yet expose the reasoning_effort API parameter.

For Anthropic Claude models with extended thinking, use AnthropicClient which has full support for the thinking parameter with budget_tokens.

Value parameters

client

configured Azure OpenAI client instance

config

provider configuration containing context window and reserve completion settings

model

the model identifier (e.g., "gpt-4", "gpt-3.5-turbo")

Attributes

Companion
object
Supertypes
trait LLMClient
class Object
trait Matchable
class Any
object OpenAIClient

Factory methods for creating OpenAIClient instances.

Factory methods for creating OpenAIClient instances.

Provides safe construction of OpenAI clients with error handling via Result type.

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
object OpenAIEmbeddingProvider

OpenAI embedding provider implementation.

OpenAI embedding provider implementation.

Provides text embeddings using OpenAI's embedding API (text-embedding-3-small, text-embedding-3-large, text-embedding-ada-002). Supports batch embedding of multiple texts in a single request.

== Supported Models ==

  • text-embedding-3-small - Efficient, lower cost (recommended)
  • text-embedding-3-large - Higher quality, higher cost
  • text-embedding-ada-002 - Legacy model

== Token Usage == The response includes token usage information when available from the API.

Attributes

See also

EmbeddingProvider for the provider interface

Supertypes
class Object
trait Matchable
class Any
Self type
class OpenRouterClient(config: OpenAIConfig) extends LLMClient

Attributes

Companion
object
Supertypes
trait LLMClient
class Object
trait Matchable
class Any
object OpenRouterClient

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
object VoyageAIEmbeddingProvider

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Generated with