Class: LLM::Message

Inherits:
Object
  • Object
show all
Defined in:
lib/llm/message.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(role, content, extra = {}) ⇒ LLM::Message

Returns a new message

Parameters:

  • role (Symbol)
  • content (String)
  • extra (Hash) (defaults to: {}) 


26
27
28
29
30
 
# File 'lib/llm/message.rb', line 26

def initialize(role, content, extra = {})
  @role = role.to_s
  @content = content
  @extra = LLM::Object.from(extra)
end

Instance Attribute Details

#content ⇒ String (readonly)

Returns the content of the message

Returns:

  • (String) 


13
14
15
 
# File 'lib/llm/message.rb', line 13

def content
  @content
end

#extra ⇒ Hash (readonly)

Returns extra context associated with the message

Returns:

  • (Hash) 


18
19
20
 
# File 'lib/llm/message.rb', line 18

def extra
  @extra
end

#role ⇒ Symbol (readonly)

Returns the role of the message

Returns:

  • (Symbol) 


8
9
10
 
# File 'lib/llm/message.rb', line 8

def role
  @role
end

Instance Method Details

#==(other) ⇒ Boolean Also known as: eql?

Returns true when two objects have the same role and content

Parameters:

  • other (Object) —

    The other object to compare

Returns:

  • (Boolean) 


58
59
60
61
62
63
64
 
# File 'lib/llm/message.rb', line 58

def ==(other)
  if other.respond_to?(:to_h)
    to_h == other.to_h
  else
    false
  end
end

#annotations ⇒ Array<LLM::Object>

Note:

This method might return annotations for assistant messages, and it returns an empty array for non-assistant messages

Returns annotations associated with the message

Returns:



182
183
184
 
# File 'lib/llm/message.rb', line 182

def annotations
  @annotations ||= LLM::Object.from(extra.annotations || [])
end

#assistant? ⇒ Boolean

Returns true when the message is an assistant message

Returns:

  • (Boolean) 


133
134
135
 
# File 'lib/llm/message.rb', line 133

def assistant?
  role == "assistant" || role == "model"
end

#compaction? ⇒ Boolean

Returns true when a message was created by context compaction

Returns:

  • (Boolean) 


85
86
87
 
# File 'lib/llm/message.rb', line 85

def compaction?
  !!extra.compaction
end

#content! ⇒ Hash

Try to parse JSON content

Returns:

  • (Hash) —

    Returns the parsed content as a Hash



71
72
73
 
# File 'lib/llm/message.rb', line 71

def content!
  LLM.json.load(content)
end

#file? ⇒ Boolean

Returns true when a message contains a local or remote file

Returns:

  • (Boolean) 


106
107
108
 
# File 'lib/llm/message.rb', line 106

def file?
  files.any?
end

#files ⇒ Array<LLM::Object>

Returns local and remote file content items from the message

Returns:



113
114
115
116
117
 
# File 'lib/llm/message.rb', line 113

def files
  content_items.select do
    LLM::Object === _1 && [:local_file, :remote_file].include?(_1.kind)
  end
end

#functions ⇒ Array<LLM::Function>

Returns:



121
122
123
124
125
126
127
128
 
# File 'lib/llm/message.rb', line 121

def functions
  @functions ||= tool_calls.filter_map do |fn|
    function = available_tools.find { _1.name.to_s == fn["name"] } || next
    function = function.dup
    function.tap { _1.id = fn.id }
    function.tap { _1.arguments = fn.arguments }
  end
end

#image_url? ⇒ Boolean

Returns true when a message contains an image URL

Returns:

  • (Boolean) 


92
93
94
 
# File 'lib/llm/message.rb', line 92

def image_url?
  image_urls.any?
end

#image_urls ⇒ Array<LLM::Object>

Returns image URL content items from the message

Returns:



99
100
101
 
# File 'lib/llm/message.rb', line 99

def image_urls
  content_items.select { LLM::Object === _1 && _1.kind == :image_url }
end

#inspect ⇒ String

Returns a string representation of the message

Returns:

  • (String) 


207
208
209
210
211
 
# File 'lib/llm/message.rb', line 207

def inspect
  "#<#{self.class.name}:0x#{object_id.to_s(16)} " \
  "tool_call=#{tool_calls.any?} role=#{role.inspect} " \
  "content=#{content.inspect} reasoning_content=#{reasoning_content.inspect}>"
end

#model ⇒ String?

Returns the model associated with a message

Returns:

  • (String, nil) —

    Returns the model associated with a message



200
201
202
 
# File 'lib/llm/message.rb', line 200

def model
  response&.model
end

#reasoning_content ⇒ String?

Returns reasoning content associated with the message

Returns:

  • (String, nil) 


78
79
80
 
# File 'lib/llm/message.rb', line 78

def reasoning_content
  extra.reasoning_content
end

#response ⇒ LLM::Response?

Note:

This method returns a response for assistant messages, and it returns nil for non-assistant messages

Returns the response associated with the message, or nil

Returns:

  • (LLM::Response, nil) —

    Returns the response associated with the message, or nil



172
173
174
 
# File 'lib/llm/message.rb', line 172

def response
  extra.response
end

#system? ⇒ Boolean

Returns true when the message is a system message

Returns:

  • (Boolean) 


140
141
142
 
# File 'lib/llm/message.rb', line 140

def system?
  role == "system"
end

#to_h ⇒ Hash

Returns a Hash representation of the message.

Returns:

  • (Hash) 


35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/llm/message.rb', line 35

def to_h
  {
    role:,
    content:,
    reasoning_content:,
    compaction: extra.compaction,
    tools: extra.tool_calls&.map { LLM::Object === _1 ? _1.to_h : _1 },
    usage:,
    original_tool_calls: extra.original_tool_calls
  }.compact.then { preserve_nil_content(_1) }
end

#to_json ⇒ String

Returns:

  • (String) 


49
50
51
 
# File 'lib/llm/message.rb', line 49

def to_json(...)
  LLM.json.dump(to_h, ...)
end

#tool_call? ⇒ Boolean

Returns true when the message requests a function call

Returns:

  • (Boolean) —

    Returns true when the message requests a function call



154
155
156
 
# File 'lib/llm/message.rb', line 154

def tool_call?
  tool_calls.any?
end

#tool_return? ⇒ Boolean

Returns true when the message represents a function return

Returns:

  • (Boolean) —

    Returns true when the message represents a function return



161
162
163
164
 
# File 'lib/llm/message.rb', line 161

def tool_return?
  LLM::Function::Return === content ||
    [*content].grep(LLM::Function::Return).any?
end

#usage ⇒ LLM::Object? Also known as: token_usage

Note:

This method returns token usage for assistant messages, and it returns nil for non-assistant messages

Returns token usage statistics

Returns:



192
193
194
 
# File 'lib/llm/message.rb', line 192

def usage
  @usage ||= extra.usage || response&.usage
end

#user? ⇒ Boolean

Returns true when the message is a user message

Returns:

  • (Boolean) 


147
148
149
 
# File 'lib/llm/message.rb', line 147

def user?
  role == "user"
end