Mojentic.LLM.Gateways.OpenAIModelRegistry (Mojentic v1.2.0)

OpenAI Model Registry for managing model-specific configurations and capabilities.

This module provides infrastructure for categorizing OpenAI models and managing their specific parameter requirements and capabilities.

Model Types

:reasoning - Models like o1, o3 that use max_completion_tokens
:chat - Standard chat models that use max_tokens
:embedding - Text embedding models
:moderation - Content moderation models

Examples

iex> registry = OpenAIModelRegistry.new()
iex> OpenAIModelRegistry.is_reasoning_model?(registry, "o1")
true
iex> OpenAIModelRegistry.is_reasoning_model?(registry, "gpt-4")
false

Summary

Types

model_capabilities()

model_type()

t()

Functions

get_model_capabilities(open_ai_model_registry, model_name)

Gets the capabilities for a specific model.

get_registered_models(open_ai_model_registry)

Gets a list of all explicitly registered models.

get_token_limit_param(registry, model_name)

Gets the correct parameter name for token limits based on model type.

new()

Creates a new model registry with default models.

reasoning_model?(registry, model_name)

Checks if a model is a reasoning model.

register_model(registry, model_name, capabilities)

Registers a new model with its capabilities.

register_pattern(registry, pattern, model_type)

Registers a pattern for inferring model types.

supports_temperature?(registry, model_name, temperature)

Checks if a model supports a specific temperature value.

Types

model_capabilities()

@type model_capabilities() :: %{
  model_type: model_type(),
  supports_tools: boolean(),
  supports_streaming: boolean(),
  supports_vision: boolean(),
  max_context_tokens: non_neg_integer() | nil,
  max_output_tokens: non_neg_integer() | nil,
  supported_temperatures: [float()] | nil,
  supports_chat_api: boolean(),
  supports_completions_api: boolean(),
  supports_responses_api: boolean()
}

model_type()

@type model_type() :: :reasoning | :chat | :embedding | :moderation

t()

@type t() :: %Mojentic.LLM.Gateways.OpenAIModelRegistry{
  models: %{required(String.t()) => model_capabilities()},
  pattern_mappings: %{required(String.t()) => model_type()}
}

Functions

get_model_capabilities(open_ai_model_registry, model_name)

@spec get_model_capabilities(t(), String.t()) :: model_capabilities()

Gets the capabilities for a specific model.

Falls back to pattern matching for unknown models, and defaults to chat model capabilities if no match is found.

get_registered_models(open_ai_model_registry)

@spec get_registered_models(t()) :: [String.t()]

Gets a list of all explicitly registered models.

get_token_limit_param(registry, model_name)

@spec get_token_limit_param(t(), String.t()) :: String.t()

Gets the correct parameter name for token limits based on model type.

new()

@spec new() :: t()

Creates a new model registry with default models.

reasoning_model?(registry, model_name)

@spec reasoning_model?(t(), String.t()) :: boolean()

Checks if a model is a reasoning model.

register_model(registry, model_name, capabilities)

@spec register_model(t(), String.t(), model_capabilities()) :: t()

Registers a new model with its capabilities.

register_pattern(registry, pattern, model_type)

@spec register_pattern(t(), String.t(), model_type()) :: t()

Registers a pattern for inferring model types.

supports_temperature?(registry, model_name, temperature)

@spec supports_temperature?(t(), String.t(), float()) :: boolean()

Checks if a model supports a specific temperature value.