Class: RubyLLM::Models

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/ruby_llm/models.rb

Overview

Registry of available AI models and their capabilities.

Constant Summary collapse

MODELS_DEV_PROVIDER_MAP = 
{
  'openai' => 'openai',
  'anthropic' => 'anthropic',
  'google' => 'gemini',
  'google-vertex' => 'vertexai',
  'amazon-bedrock' => 'bedrock',
  'deepseek' => 'deepseek',
  'mistral' => 'mistral',
  'openrouter' => 'openrouter',
  'perplexity' => 'perplexity',
  'xai' => 'xai'
}.freeze
MODELS_DEV_INPUT_MODALITIES = 
%w[text image audio pdf video file].freeze
MODELS_DEV_OUTPUT_MODALITIES = 
%w[text image audio video embeddings moderation].freeze
MODELS_DEV_AUTHORITY_CAPABILITIES = 
%w[function_calling structured_output reasoning vision].freeze
PROVIDER_PREFERENCE = 
%w[
  openai
  anthropic
  gemini
  vertexai
  bedrock
  openrouter
  deepseek
  mistral
  perplexity
  xai
  azure
  ollama
  gpustack
].freeze
INSTANCE_DELEGATES = 
(Enumerable.instance_methods(false) + %i[
  all
  each
  find
  chat_models
  embedding_models
  audio_models
  image_models
  by_family
  by_provider
  load_from_json!
  load_from_database!
  save_to_json
]).uniq.freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(models = nil) ⇒ Models

Returns a new instance of Models.



453
454
455
 
# File 'lib/ruby_llm/models.rb', line 453

def initialize(models = nil)
  @models = self.class.filter_models(models || self.class.load_models)
end

Class Method Details

.add_provider_metadata(models_dev_model, provider_model) ⇒ Object

rubocop:disable Metrics/PerceivedComplexity



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/ruby_llm/models.rb', line 321

def add_provider_metadata(models_dev_model, provider_model) # rubocop:disable Metrics/PerceivedComplexity
  data = models_dev_model.to_h
  data[:name] = provider_model.name if blank_value?(data[:name])
  data[:family] = provider_model.family if blank_value?(data[:family])
  data[:created_at] = provider_model.created_at if blank_value?(data[:created_at])
  data[:context_window] = provider_model.context_window if blank_value?(data[:context_window])
  data[:max_output_tokens] = provider_model.max_output_tokens if blank_value?(data[:max_output_tokens])
  data[:modalities] = provider_model.modalities.to_h if blank_value?(data[:modalities])
  data[:pricing] = provider_model.pricing.to_h if blank_value?(data[:pricing])
  data[:metadata] = provider_model.metadata.merge(data[:metadata] || {})
  provider_capabilities = provider_model.capabilities - MODELS_DEV_AUTHORITY_CAPABILITIES
  data[:capabilities] = (models_dev_model.capabilities + provider_capabilities).uniq
  normalize_embedding_modalities(data)
  Model::Info.new(data)
end

.blank_value?(value) ⇒ Boolean

Returns:

  • (Boolean) 


346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/ruby_llm/models.rb', line 346

def blank_value?(value)
  return true if value.nil?
  return value.empty? if value.is_a?(String) || value.is_a?(Array)

  if value.is_a?(Hash)
    return true if value.empty?

    return value.values.all? { |nested| blank_value?(nested) }
  end

  false
end

.fetch_from_providers(remote_only: true) ⇒ Object

Backwards-compatible wrapper used by specs.



150
151
152
 
# File 'lib/ruby_llm/models.rb', line 150

def fetch_from_providers(remote_only: true)
  fetch_provider_models(remote_only: remote_only)[:models]
end

.fetch_models_dev_models(existing_models) ⇒ Object

rubocop:disable Metrics/PerceivedComplexity



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/ruby_llm/models.rb', line 186

def fetch_models_dev_models(existing_models) # rubocop:disable Metrics/PerceivedComplexity
  RubyLLM.logger.info 'Fetching models from models.dev API...'

  connection = Connection.basic do |f|
    f.request :json
    f.response :json, parser_options: { symbolize_names: true }
  end
  response = connection.get 'https://models.dev/api.json'
  providers = response.body || {}

  models = providers.flat_map do |provider_key, provider_data|
    provider_slug = MODELS_DEV_PROVIDER_MAP[provider_key.to_s]
    next [] unless provider_slug

    (provider_data[:models] || {}).values.map do |model_data|
      Model::Info.new(models_dev_model_to_info(model_data, provider_slug, provider_key.to_s))
    end
  end
  { models: models.reject { |model| model.provider.nil? || model.id.nil? }, fetched: true }
rescue StandardError => e
  RubyLLM.logger.warn("Failed to fetch models.dev (#{e.class}: #{e.message}). Keeping existing.")
  {
    models: existing_models.select { |model| model.metadata[:source] == 'models.dev' },
    fetched: false
  }
end

.fetch_provider_models(remote_only: true) ⇒ Object

rubocop:disable Metrics/PerceivedComplexity



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/ruby_llm/models.rb', line 117

def fetch_provider_models(remote_only: true) # rubocop:disable Metrics/PerceivedComplexity
  config = RubyLLM.config
  provider_classes = remote_only ? Provider.remote_providers.values : Provider.providers.values
  configured_classes = if remote_only
                         Provider.configured_remote_providers(config)
                       else
                         Provider.configured_providers(config)
                       end
  configured = configured_classes.select { |klass| provider_classes.include?(klass) }
  result = {
    models: [],
    fetched_providers: [],
    configured_names: configured.map(&:name),
    failed: []
  }

  provider_classes.each do |provider_class|
    next if remote_only && provider_class.local?
    next unless provider_class.configured?(config)

    begin
      result[:models].concat(provider_class.new(config).list_models)
      result[:fetched_providers] << provider_class.slug
    rescue StandardError => e
      result[:failed] << { name: provider_class.name, slug: provider_class.slug, error: e }
    end
  end

  result[:fetched_providers].uniq!
  result
end

.filter_models(models) ⇒ Object 



279
280
281
282
283
 
# File 'lib/ruby_llm/models.rb', line 279

def filter_models(models)
  models.reject do |model|
    model.provider.to_s == 'vertexai' && model.id.to_s.include?('/')
  end
end

.find_models_dev_model(key, models_dev_by_key) ⇒ Object 



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/ruby_llm/models.rb', line 285

def find_models_dev_model(key, models_dev_by_key)
  # Direct match
  return models_dev_by_key[key] if models_dev_by_key[key]

  provider, model_id = key.split(':', 2)
  if provider == 'bedrock'
    normalized_id = model_id.sub(/^[a-z]{2}\./, '')
    context_override = nil
    normalized_id = normalized_id.gsub(/:(\d+)k\b/) do
      context_override = Regexp.last_match(1).to_i * 1000
      ''
    end
    bedrock_model = models_dev_by_key["bedrock:#{normalized_id}"]
    if bedrock_model
      data = bedrock_model.to_h.merge(id: model_id)
      data[:context_window] = context_override if context_override
      return Model::Info.new(data)
    end
  end

  # VertexAI uses same models as Gemini
  return unless provider == 'vertexai'

  gemini_model = models_dev_by_key["gemini:#{model_id}"]
  return unless gemini_model

  # Return Gemini's models.dev data but with VertexAI as provider
  Model::Info.new(gemini_model.to_h.merge(provider: 'vertexai'))
end

.index_by_key(models) ⇒ Object 



315
316
317
318
319
 
# File 'lib/ruby_llm/models.rb', line 315

def index_by_key(models)
  models.to_h do |model|
    ["#{model.provider}:#{model.id}", model]
  end
end

.instance ⇒ Object 



67
68
69
 
# File 'lib/ruby_llm/models.rb', line 67

def instance
  @instance ||= new
end

.load_existing_models ⇒ Object 



213
214
215
216
217
 
# File 'lib/ruby_llm/models.rb', line 213

def load_existing_models
  existing_models = instance&.all
  existing_models = read_from_json if existing_models.nil? || existing_models.empty?
  existing_models
end

.load_models(file = RubyLLM.config.model_registry_file) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/ruby_llm/models.rb', line 75

def load_models(file = RubyLLM.config.model_registry_file)
  source = RubyLLM.config.model_registry_source
  if source && file == RubyLLM.config.model_registry_file
    models = source.read
    return models if models.any?

    RubyLLM.logger.debug { 'Model registry source is empty, falling back to JSON registry' }
  end

  read_from_json(file)
end

.log_models_dev_fetch(models_dev_fetch) ⇒ Object 



234
235
236
237
238
 
# File 'lib/ruby_llm/models.rb', line 234

def log_models_dev_fetch(models_dev_fetch)
  return if models_dev_fetch[:fetched]

  RubyLLM.logger.warn('Using cached models.dev data due to fetch failure.')
end

.log_provider_fetch(provider_fetch) ⇒ Object 



224
225
226
227
228
229
230
231
232
 
# File 'lib/ruby_llm/models.rb', line 224

def log_provider_fetch(provider_fetch)
  RubyLLM.logger.info "Fetching models from providers: #{provider_fetch[:configured_names].join(', ')}"
  provider_fetch[:failed].each do |failure|
    RubyLLM.logger.warn(
      "Failed to fetch #{failure[:name]} models (#{failure[:error].class}: #{failure[:error].message}). " \
      'Keeping existing.'
    )
  end
end

.merge_models(provider_models, models_dev_models) ⇒ Object 



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/ruby_llm/models.rb', line 257

def merge_models(provider_models, models_dev_models)
  models_dev_by_key = index_by_key(models_dev_models)
  provider_by_key = index_by_key(provider_models)

  all_keys = models_dev_by_key.keys | provider_by_key.keys

  models = all_keys.map do |key|
    models_dev_model = find_models_dev_model(key, models_dev_by_key)
    provider_model = provider_by_key[key]

    if models_dev_model && provider_model
      add_provider_metadata(models_dev_model, provider_model)
    elsif models_dev_model
      models_dev_model
    else
      provider_model
    end
  end

  filter_models(models).sort_by { |m| [m.provider, m.id] }
end

.merge_with_existing(existing_models, provider_fetch, models_dev_fetch) ⇒ Object 



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/ruby_llm/models.rb', line 240

def merge_with_existing(existing_models, provider_fetch, models_dev_fetch)
  existing_by_provider = existing_models.group_by(&:provider)
  preserved_models = existing_by_provider
                     .except(*provider_fetch[:fetched_providers])
                     .values
                     .flatten

  provider_models = provider_fetch[:models] + preserved_models
  models_dev_models = if models_dev_fetch[:fetched]
                        models_dev_fetch[:models]
                      else
                        existing_models.select { |model| model.metadata[:source] == 'models.dev' }
                      end

  merge_models(provider_models, models_dev_models)
end

.models_dev_capabilities(model_data, modalities) ⇒ Object 



385
386
387
388
389
390
391
392
 
# File 'lib/ruby_llm/models.rb', line 385

def models_dev_capabilities(model_data, modalities)
  capabilities = []
  capabilities << 'function_calling' if model_data[:tool_call]
  capabilities << 'structured_output' if model_data[:structured_output]
  capabilities << 'reasoning' if model_data[:reasoning] || model_data[:reasoning_options]
  capabilities << 'vision' if modalities[:input].intersect?(%w[image video pdf])
  capabilities.uniq
end

.models_dev_metadata(model_data, provider_key) ⇒ Object 



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/ruby_llm/models.rb', line 416

def models_dev_metadata(model_data, provider_key)
  metadata = {
    source: 'models.dev',
    provider_id: provider_key,
    open_weights: model_data[:open_weights],
    attachment: model_data[:attachment],
    temperature: model_data[:temperature],
    last_updated: model_data[:last_updated],
    status: model_data[:status],
    interleaved: model_data[:interleaved],
    reasoning_options: model_data[:reasoning_options],
    cost: model_data[:cost],
    limit: model_data[:limit],
    knowledge: model_data[:knowledge]
  }
  metadata.compact
end

.models_dev_model_to_info(model_data, provider_slug, provider_key) ⇒ Object 



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/ruby_llm/models.rb', line 359

def models_dev_model_to_info(model_data, provider_slug, provider_key)
  modalities = normalize_models_dev_modalities(model_data[:modalities])
  capabilities = models_dev_capabilities(model_data, modalities)

  created_date = [model_data[:release_date], model_data[:last_updated]]
                 .find { |value| !value.to_s.strip.empty? }

  data = {
    id: model_data[:id],
    name: model_data[:name] || model_data[:id],
    provider: provider_slug,
    family: model_data[:family],
    created_at: Utils.iso_date_prefix_to_utc_midnight_string(created_date),
    context_window: model_data.dig(:limit, :context),
    max_output_tokens: model_data.dig(:limit, :output),
    knowledge_cutoff: normalize_models_dev_knowledge(model_data[:knowledge]),
    modalities: modalities,
    capabilities: capabilities,
    pricing: models_dev_pricing(model_data[:cost]),
    metadata: models_dev_metadata(model_data, provider_key)
  }

  normalize_embedding_modalities(data)
  data
end

.models_dev_pricing(cost) ⇒ Object 



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/ruby_llm/models.rb', line 394

def models_dev_pricing(cost)
  return {} unless cost

  text_standard = {
    input_per_million: cost[:input],
    output_per_million: cost[:output],
    cache_read_input_per_million: cost[:cache_read],
    cache_write_input_per_million: cost[:cache_write],
    reasoning_output_per_million: cost[:reasoning]
  }.compact

  audio_standard = {
    input_per_million: cost[:input_audio],
    output_per_million: cost[:output_audio]
  }.compact

  pricing = {}
  pricing[:text_tokens] = { standard: text_standard } if text_standard.any?
  pricing[:audio_tokens] = { standard: audio_standard } if audio_standard.any?
  pricing
end

.normalize_embedding_modalities(data) ⇒ Object 



337
338
339
340
341
342
343
344
 
# File 'lib/ruby_llm/models.rb', line 337

def normalize_embedding_modalities(data)
  return unless data[:id].to_s.include?('embedding')

  modalities = data[:modalities].to_h
  modalities[:input] = ['text'] if modalities[:input].nil? || modalities[:input].empty?
  modalities[:output] = ['embeddings']
  data[:modalities] = modalities
end

.normalize_models_dev_knowledge(value) ⇒ Object 



443
444
445
446
447
448
449
450
 
# File 'lib/ruby_llm/models.rb', line 443

def normalize_models_dev_knowledge(value)
  return if value.nil?
  return value if value.is_a?(Date)

  Date.parse(value.to_s)
rescue ArgumentError
  nil
end

.normalize_models_dev_modalities(modalities) ⇒ Object 



434
435
436
437
438
439
440
441
 
# File 'lib/ruby_llm/models.rb', line 434

def normalize_models_dev_modalities(modalities)
  normalized = { input: [], output: [] }
  return normalized unless modalities

  normalized[:input] = Array(modalities[:input]).compact & MODELS_DEV_INPUT_MODALITIES
  normalized[:output] = Array(modalities[:output]).compact & MODELS_DEV_OUTPUT_MODALITIES
  normalized
end

.raise_unknown_provider(provider) ⇒ Object

Raises:



219
220
221
222
 
# File 'lib/ruby_llm/models.rb', line 219

def raise_unknown_provider(provider)
  available = Provider.providers.keys.join(', ')
  raise Error, "Unknown provider: #{provider.inspect}. Available providers: #{available}"
end

.read_from_database ⇒ Object 



95
96
97
 
# File 'lib/ruby_llm/models.rb', line 95

def read_from_database
  ModelRegistry::ActiveRecordSource.new.read
end

.read_from_json(file = RubyLLM.config.model_registry_file) ⇒ Object 



87
88
89
90
91
92
93
 
# File 'lib/ruby_llm/models.rb', line 87

def read_from_json(file = RubyLLM.config.model_registry_file)
  data = File.exist?(file) ? File.read(file) : '[]'
  models = JSON.parse(data, symbolize_names: true).map { |model| Model::Info.new(model) }
  filter_models(models)
rescue JSON::ParserError
  []
end

.refresh!(remote_only: false) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/ruby_llm/models.rb', line 99

def refresh!(remote_only: false)
  # Replaces the process-wide model registry. Call save_to_json when the
  # refreshed registry should also be persisted.
  RubyLLM.instrument('models.refresh.ruby_llm', remote_only:) do |payload|
    existing_models = load_existing_models

    provider_fetch = fetch_provider_models(remote_only: remote_only)
    log_provider_fetch(provider_fetch)

    models_dev_fetch = fetch_models_dev_models(existing_models)
    log_models_dev_fetch(models_dev_fetch)

    merged_models = merge_with_existing(existing_models, provider_fetch, models_dev_fetch)
    payload[:model_count] = merged_models.size
    @instance = new(merged_models)
  end
end

.resolve(model_id, provider: nil, assume_exists: false, config: nil) ⇒ Object

rubocop:disable Metrics/PerceivedComplexity



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/ruby_llm/models.rb', line 154

def resolve(model_id, provider: nil, assume_exists: false, config: nil) # rubocop:disable Metrics/PerceivedComplexity
  config ||= RubyLLM.config
  provider_class = provider ? Provider.providers[provider.to_sym] : nil

  if provider_class
    temp_instance = provider_class.new(config)
    assume_exists = true if temp_instance.local? || temp_instance.assume_models_exist?
  end

  if assume_exists
    raise ArgumentError, 'Provider must be specified if assume_exists is true' unless provider

    provider_class ||= raise_unknown_provider(provider)
    provider_instance = provider_class.new(config)

    model = if provider_instance.local?
              begin
                Models.find(model_id, provider)
              rescue ModelNotFoundError
                nil
              end
            end

    model ||= Model::Info.default(model_id, provider_instance.slug)
  else
    model = Models.find model_id, provider
    provider_class = Provider.providers[model.provider.to_sym] || raise_unknown_provider(model.provider)
    provider_instance = provider_class.new(config)
  end
  [model, provider_instance]
end

.schema_file ⇒ Object 



71
72
73
 
# File 'lib/ruby_llm/models.rb', line 71

def schema_file
  File.expand_path('models_schema.json', __dir__)
end

Instance Method Details

#all ⇒ Object 



474
475
476
 
# File 'lib/ruby_llm/models.rb', line 474

def all
  @models
end

#audio_models ⇒ Object 



498
499
500
 
# File 'lib/ruby_llm/models.rb', line 498

def audio_models
  self.class.new(all.select { |m| m.type == 'audio' || m.modalities.output.include?('audio') })
end

#by_family(family) ⇒ Object 



506
507
508
 
# File 'lib/ruby_llm/models.rb', line 506

def by_family(family)
  self.class.new(all.select { |m| m.family == family.to_s })
end

#by_provider(provider) ⇒ Object 



510
511
512
 
# File 'lib/ruby_llm/models.rb', line 510

def by_provider(provider)
  self.class.new(all.select { |m| m.provider == provider.to_s })
end

#chat_models ⇒ Object 



490
491
492
 
# File 'lib/ruby_llm/models.rb', line 490

def chat_models
  self.class.new(all.select { |m| m.type == 'chat' })
end

#each ⇒ Object 



478
479
480
 
# File 'lib/ruby_llm/models.rb', line 478

def each(&)
  all.each(&)
end

#embedding_models ⇒ Object 



494
495
496
 
# File 'lib/ruby_llm/models.rb', line 494

def embedding_models
  self.class.new(all.select { |m| m.type == 'embedding' || m.modalities.output.include?('embeddings') })
end

#find(model_id, provider = nil) ⇒ Object 



482
483
484
485
486
487
488
 
# File 'lib/ruby_llm/models.rb', line 482

def find(model_id, provider = nil)
  if provider
    find_with_provider(model_id, provider)
  else
    find_without_provider(model_id)
  end
end

#image_models ⇒ Object 



502
503
504
 
# File 'lib/ruby_llm/models.rb', line 502

def image_models
  self.class.new(all.select { |m| m.type == 'image' || m.modalities.output.include?('image') })
end

#load_from_database! ⇒ Object

Replaces this registry instance with models loaded from the configured ActiveRecord model class.



464
465
466
 
# File 'lib/ruby_llm/models.rb', line 464

def load_from_database!
  @models = self.class.read_from_database
end

#load_from_json!(file = RubyLLM.config.model_registry_file) ⇒ Object

Replaces this registry instance with models loaded from JSON.



458
459
460
 
# File 'lib/ruby_llm/models.rb', line 458

def load_from_json!(file = RubyLLM.config.model_registry_file)
  @models = self.class.read_from_json(file)
end

#refresh!(remote_only: false) ⇒ Object 



514
515
516
 
# File 'lib/ruby_llm/models.rb', line 514

def refresh!(remote_only: false)
  self.class.refresh!(remote_only: remote_only)
end

#resolve(model_id, provider: nil, assume_exists: false, config: nil) ⇒ Object 



518
519
520
 
# File 'lib/ruby_llm/models.rb', line 518

def resolve(model_id, provider: nil, assume_exists: false, config: nil)
  self.class.resolve(model_id, provider: provider, assume_exists: assume_exists, config: config)
end

#save_to_json(file = RubyLLM.config.model_registry_file) ⇒ Object

Persists this registry instance to JSON without changing the global RubyLLM.models instance.



470
471
472
 
# File 'lib/ruby_llm/models.rb', line 470

def save_to_json(file = RubyLLM.config.model_registry_file)
  File.write(file, JSON.pretty_generate(all.map(&:to_h)))
end