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.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(models = nil) ⇒ Models

Returns a new instance of Models.



156
157
158
 
# File 'lib/ruby_llm/models.rb', line 156

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

Class Method Details

.add_provider_metadata(parsera_model, provider_model) ⇒ Object 



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

def add_provider_metadata(parsera_model, provider_model)
  data = parsera_model.to_h
  data[:metadata] = provider_model.metadata.merge(data[:metadata] || {})
  Model::Info.new(data)
end

.fetch_from_parsera ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/ruby_llm/models.rb', line 94

def fetch_from_parsera
  RubyLLM.logger.info 'Fetching models from Parsera API...'

  connection = Connection.basic do |f|
    f.request :json
    f.response :json, parser_options: { symbolize_names: true }
  end
  response = connection.get 'https://api.parsera.org/v1/llm-specs'
  models = response.body.map { |data| Model::Info.new(data) }
  models.reject { |model| model.provider.nil? || model.id.nil? }
end

.fetch_from_providers(remote_only: true) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/ruby_llm/models.rb', line 35

def fetch_from_providers(remote_only: true)
  config = RubyLLM.config
  configured_classes = if remote_only
                         Provider.configured_remote_providers(config)
                       else
                         Provider.configured_providers(config)
                       end
  configured = configured_classes.map { |klass| klass.new(config) }

  RubyLLM.logger.info "Fetching models from providers: #{configured.map(&:name).join(', ')}"

  configured.flat_map(&:list_models)
end

.find_parsera_model(key, parsera_by_key) ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/ruby_llm/models.rb', line 128

def find_parsera_model(key, parsera_by_key)
  # Direct match
  return parsera_by_key[key] if parsera_by_key[key]

  # VertexAI uses same models as Gemini
  provider, model_id = key.split(':', 2)
  return unless provider == 'vertexai'

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

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

.index_by_key(models) ⇒ Object 



143
144
145
146
147
 
# File 'lib/ruby_llm/models.rb', line 143

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

.instance ⇒ Object 



9
10
11
 
# File 'lib/ruby_llm/models.rb', line 9

def instance
  @instance ||= new
end

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



17
18
19
 
# File 'lib/ruby_llm/models.rb', line 17

def load_models(file = RubyLLM.config.model_registry_file)
  read_from_json(file)
end

.merge_models(provider_models, parsera_models) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/ruby_llm/models.rb', line 106

def merge_models(provider_models, parsera_models)
  parsera_by_key = index_by_key(parsera_models)
  provider_by_key = index_by_key(provider_models)

  all_keys = parsera_by_key.keys | provider_by_key.keys

  models = all_keys.map do |key|
    parsera_model = find_parsera_model(key, parsera_by_key)
    provider_model = provider_by_key[key]

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

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

.method_missing(method) ⇒ Object 



82
83
84
85
86
87
88
 
# File 'lib/ruby_llm/models.rb', line 82

def method_missing(method, ...)
  if instance.respond_to?(method)
    instance.send(method, ...)
  else
    super
  end
end

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



21
22
23
24
25
26
 
# File 'lib/ruby_llm/models.rb', line 21

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

.refresh!(remote_only: false) ⇒ Object 



28
29
30
31
32
33
 
# File 'lib/ruby_llm/models.rb', line 28

def refresh!(remote_only: false)
  provider_models = fetch_from_providers(remote_only: remote_only)
  parsera_models = fetch_from_parsera
  merged_models = merge_models(provider_models, parsera_models)
  @instance = new(merged_models)
end

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

rubocop:disable Metrics/PerceivedComplexity



49
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
 
# File 'lib/ruby_llm/models.rb', line 49

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?
  end

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

    provider_class ||= raise(Error, "Unknown provider: #{provider.to_sym}")
    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(Error,
                                                                        "Unknown provider: #{model.provider}")
    provider_instance = provider_class.new(config)
  end
  [model, provider_instance]
end

.respond_to_missing?(method, include_private = false) ⇒ Boolean

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/ruby_llm/models.rb', line 90

def respond_to_missing?(method, include_private = false)
  instance.respond_to?(method, include_private) || super
end

.schema_file ⇒ Object 



13
14
15
 
# File 'lib/ruby_llm/models.rb', line 13

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

Instance Method Details

#all ⇒ Object 



168
169
170
 
# File 'lib/ruby_llm/models.rb', line 168

def all
  @models
end

#audio_models ⇒ Object 



192
193
194
 
# File 'lib/ruby_llm/models.rb', line 192

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

#by_family(family) ⇒ Object 



200
201
202
 
# File 'lib/ruby_llm/models.rb', line 200

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

#by_provider(provider) ⇒ Object 



204
205
206
 
# File 'lib/ruby_llm/models.rb', line 204

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

#chat_models ⇒ Object 



184
185
186
 
# File 'lib/ruby_llm/models.rb', line 184

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

#each ⇒ Object 



172
173
174
 
# File 'lib/ruby_llm/models.rb', line 172

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

#embedding_models ⇒ Object 



188
189
190
 
# File 'lib/ruby_llm/models.rb', line 188

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

#find(model_id, provider = nil) ⇒ Object 



176
177
178
179
180
181
182
 
# File 'lib/ruby_llm/models.rb', line 176

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 



196
197
198
 
# File 'lib/ruby_llm/models.rb', line 196

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

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



160
161
162
 
# File 'lib/ruby_llm/models.rb', line 160

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

#refresh!(remote_only: false) ⇒ Object 



208
209
210
 
# File 'lib/ruby_llm/models.rb', line 208

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

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



212
213
214
 
# File 'lib/ruby_llm/models.rb', line 212

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 



164
165
166
 
# File 'lib/ruby_llm/models.rb', line 164

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