Class: RubyLLM::Image

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby_llm/image.rb

Overview

Represents a generated image from an AI model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(url: nil, data: nil, mime_type: nil, revised_prompt: nil, model_id: nil, usage: {}) ⇒ Image

rubocop:disable Metrics/ParameterLists



10
11
12
13
14
15
16
17
 
# File 'lib/ruby_llm/image.rb', line 10

def initialize(url: nil, data: nil, mime_type: nil, revised_prompt: nil, model_id: nil, usage: {}) # rubocop:disable Metrics/ParameterLists
  @url = url
  @data = data
  @mime_type = mime_type
  @revised_prompt = revised_prompt
  @model_id = model_id
  @usage = usage
end

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data.



8
9
10
 
# File 'lib/ruby_llm/image.rb', line 8

def data
  @data
end

#mime_type ⇒ Object (readonly)

Returns the value of attribute mime_type.



8
9
10
 
# File 'lib/ruby_llm/image.rb', line 8

def mime_type
  @mime_type
end

#model_id ⇒ Object (readonly)

Returns the value of attribute model_id.



8
9
10
 
# File 'lib/ruby_llm/image.rb', line 8

def model_id
  @model_id
end

#revised_prompt ⇒ Object (readonly)

Returns the value of attribute revised_prompt.



8
9
10
 
# File 'lib/ruby_llm/image.rb', line 8

def revised_prompt
  @revised_prompt
end

#url ⇒ Object (readonly)

Returns the value of attribute url.



8
9
10
 
# File 'lib/ruby_llm/image.rb', line 8

def url
  @url
end

#usage ⇒ Object (readonly)

Returns the value of attribute usage.



8
9
10
 
# File 'lib/ruby_llm/image.rb', line 8

def usage
  @usage
end

Class Method Details

.paint(prompt, model: nil, provider: nil, assume_model_exists: false, size: '1024x1024', context: nil, with: nil, mask: nil, params: {}) ⇒ Object

rubocop:disable Metrics/ParameterLists



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/ruby_llm/image.rb', line 37

def self.paint(prompt, # rubocop:disable Metrics/ParameterLists
               model: nil,
               provider: nil,
               assume_model_exists: false,
               size: '1024x1024',
               context: nil,
               with: nil,
               mask: nil,
               params: {})
  config = context&.config || RubyLLM.config
  model ||= config.default_image_model
  model, provider_instance = Models.resolve(model, provider: provider, assume_exists: assume_model_exists,
                                                   config: config)
  model_id = model.id

  provider_instance.paint(prompt, model: model_id, size:, with:, mask:, params:)
end

Instance Method Details

#base64? ⇒ Boolean

Returns:

  • (Boolean) 


19
20
21
 
# File 'lib/ruby_llm/image.rb', line 19

def base64?
  !@data.nil?
end

#cost ⇒ Object 



62
63
64
 
# File 'lib/ruby_llm/image.rb', line 62

def cost
  Cost.new(tokens:, model: model_info, category: :images, input_details: input_tokens_details)
end

#model_info ⇒ Object 



66
67
68
69
70
71
72
 
# File 'lib/ruby_llm/image.rb', line 66

def model_info
  return unless model_id

  @model_info ||= RubyLLM.models.find(model_id)
rescue ModelNotFoundError
  nil
end

#save(path) ⇒ Object 



32
33
34
35
 
# File 'lib/ruby_llm/image.rb', line 32

def save(path)
  File.binwrite(File.expand_path(path), to_blob)
  path
end

#to_blob ⇒ Object 



23
24
25
26
27
28
29
30
 
# File 'lib/ruby_llm/image.rb', line 23

def to_blob
  if base64?
    Base64.decode64 @data
  else
    response = Connection.basic.get @url
    response.body
  end
end

#tokens ⇒ Object 



55
56
57
58
59
60
 
# File 'lib/ruby_llm/image.rb', line 55

def tokens
  @tokens ||= Tokens.build(
    input: usage_value('input_tokens'),
    output: usage_value('output_tokens')
  )
end