Module: RubyLLM::Providers::OpenRouter::Models

Included in:
ChatCompletions
Defined in:
lib/ruby_llm/providers/openrouter/models.rb

Overview

Models methods of the OpenRouter API integration. Chat models come from the main catalog; embedding, speech, transcription, and image models live in separate catalogs that are merged in.

Constant Summary collapse

CATALOG_URLS = 
[
  'models',
  'embeddings/models',
  'models?output_modalities=speech',
  'models?output_modalities=transcription',
  'models?output_modalities=rerank',
  'images/models'
].freeze
OUTPUT_MODALITY_MAP = 
{
  'speech' => 'audio',
  'transcription' => 'text'
}.freeze
CAPABILITY_BY_OUTPUT_MODALITY = 
{
  'speech' => 'speech_generation',
  'transcription' => 'transcription',
  'image' => 'image_generation'
}.freeze
CAPABILITY_PARAMETERS = 
{
  'function_calling' => %w[tools tool_choice],
  'tool_choice' => %w[tool_choice],
  'parallel_tool_calls' => %w[parallel_tool_calls],
  'structured_output' => %w[response_format structured_outputs],
  'batch' => %w[batch]
}.freeze

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.models_url ⇒ Object 



46
47
48
 
# File 'lib/ruby_llm/providers/openrouter/models.rb', line 46

def models_url
  'models'
end

.parse_list_models_response(response, slug) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/ruby_llm/providers/openrouter/models.rb', line 50

def parse_list_models_response(response, slug)
  Array(response.body['data']).map do |model_data| # rubocop:disable Metrics/BlockLength
    output_modalities = Array(model_data.dig('architecture', 'output_modalities'))
    modalities = {
      input: Array(model_data.dig('architecture', 'input_modalities')),
      output: output_modalities.map { |modality| OUTPUT_MODALITY_MAP.fetch(modality, modality) }.uniq
    }

    pricing = { text_tokens: { standard: {} } }

    pricing_types = {
      prompt: :input_per_million,
      completion: :output_per_million,
      input_cache_read: :cache_read_input_per_million,
      input_cache_write: :cache_write_input_per_million,
      internal_reasoning: :reasoning_output_per_million
    }

    pricing_types.each do |source_key, target_key|
      value = model_data.dig('pricing', source_key.to_s).to_f
      pricing[:text_tokens][:standard][target_key] = value * 1_000_000 if value.positive?
    end

    capabilities = supported_parameters_to_capabilities(model_data['supported_parameters']) |
                   output_modalities.filter_map { |modality| CAPABILITY_BY_OUTPUT_MODALITY[modality] }

    Model.new(
      id: model_data['id'],
      name: model_data['name'],
      provider: slug,
      family: model_data['id'].split('/').first,
      created_at: model_data['created'] ? Time.at(model_data['created']) : nil,
      context_window: model_data['context_length'],
      max_output_tokens: model_data.dig('top_provider', 'max_completion_tokens'),
      knowledge_cutoff: model_data['knowledge_cutoff'],
      modalities: modalities,
      capabilities: capabilities,
      pricing: pricing,
      metadata: {
        description: model_data['description'],
        architecture: model_data['architecture'],
        top_provider: model_data['top_provider'],
        per_request_limits: model_data['per_request_limits'],
        supported_parameters: model_data['supported_parameters'],
        expiration_date: model_data['expiration_date']
      }
    )
  end
end

.supported_parameters_to_capabilities(params) ⇒ Object 



100
101
102
103
104
105
106
107
108
 
# File 'lib/ruby_llm/providers/openrouter/models.rb', line 100

def supported_parameters_to_capabilities(params)
  return [] unless params

  capabilities = ['streaming'] + CAPABILITY_PARAMETERS.filter_map do |capability, parameters|
    capability if parameters.any? { |parameter| params.include?(parameter) }
  end
  capabilities << 'predicted_outputs' if params.include?('logit_bias') && params.include?('top_k')
  capabilities
end

Instance Method Details

#list_models ⇒ Object 



38
39
40
41
42
 
# File 'lib/ruby_llm/providers/openrouter/models.rb', line 38

def list_models
  CATALOG_URLS.flat_map do |url|
    parse_list_models_response @connection.get(url), @provider.slug
  end.uniq(&:id)
end