llm4s-docs
API
Generated with
llm4s-docs/org.llm4s/org.llm4s.llmconnect/org.llm4s.llmconnect.config/OpenAICompatibleConfig

OpenAICompatibleConfig

org.llm4s.llmconnect.config.OpenAICompatibleConfig
See theOpenAICompatibleConfig companion class
object OpenAICompatibleConfig

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Members list

Type members

Inherited and Abstract types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def apply(model: String, baseUrl: String, apiKey: Option[String], contextWindow: Int, reserveCompletion: Int, headers: Map[String, String], streamUsage: Boolean, timeouts: ProviderTimeouts, tokenExchange: Option[TokenExchangeConfig]): OpenAICompatibleConfig

Builds a config without validating it; fromValues validates. Every field after baseUrl has a default.

Builds a config without validating it; fromValues validates. Every field after baseUrl has a default.

Attributes

def apply(model: String, baseUrl: String): OpenAICompatibleConfig

The model and base URL, every other field at its default: the entry point for Java and Kotlin, which do not see Scala default arguments. Set the rest with the with* setters.

The model and base URL, every other field at its default: the entry point for Java and Kotlin, which do not see Scala default arguments. Set the rest with the with* setters.

Attributes

def fromValues(model: String, baseUrl: String, apiKey: Option[String], contextWindow: Option[Int], reserveCompletion: Option[Int], headers: Map[String, String], streamUsage: Boolean, tokenExchange: Option[TokenExchangeConfig]): Result[OpenAICompatibleConfig]

Builds and validates a config.

Builds and validates a config.

Attributes

Returns

Left(ConfigurationError) for a blank model or baseUrl, a non-positive context window, a reserve that is negative or does not leave room for a prompt, or a tokenExchange that validate refuses. A blank apiKey is treated as none.

Concrete fields

val DEFAULT_CONTEXT_WINDOW: Int

Context window used when config sets none: 8192 tokens, small enough that any current chat model accepts it.

Context window used when config sets none: 8192 tokens, small enough that any current chat model accepts it.

Attributes

val DEFAULT_RESERVE_COMPLETION: Int

Completion reserve used when config sets none.

Completion reserve used when config sets none.

Attributes

val ProviderIdName: String

The provider id, as written in provider = "openai-compatible".

The provider id, as written in provider = "openai-compatible".

Attributes

Generated with