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 = extra
end

Instance Attribute Details

#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

#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

Instance Method Details

#inspect ⇒ String

Returns a string representation of the message

Returns:

  • (String)


157
158
159
160
161
 
# File 'lib/llm/message.rb', line 157

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

#to_h ⇒ Hash

Returns a Hash representation of the message.

Returns:

  • (Hash)


35
36
37
38
39
 
# File 'lib/llm/message.rb', line 35

def to_h
  {role:, content:,
   tools: @extra[:tool_calls],
   original_tool_calls: extra[:original_tool_calls]}.compact
end

#to_json ⇒ String

Returns:

  • (String)


43
44
45
 
# File 'lib/llm/message.rb', line 43

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

#==(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)


52
53
54
55
56
57
58
 
# File 'lib/llm/message.rb', line 52

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

#content! ⇒ Hash

Try to parse JSON content

Returns:

  • (Hash) —

    Returns the parsed content as a Hash



65
66
67
 
# File 'lib/llm/message.rb', line 65

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

#functions ⇒ Array<LLM::Function>

Returns:



71
72
73
74
75
76
77
 
# File 'lib/llm/message.rb', line 71

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

#assistant? ⇒ Boolean

Returns true when the message is an assistant message

Returns:

  • (Boolean)


82
83
84
 
# File 'lib/llm/message.rb', line 82

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

#system? ⇒ Boolean

Returns true when the message is a system message

Returns:

  • (Boolean)


89
90
91
 
# File 'lib/llm/message.rb', line 89

def system?
  role == "system"
end

#user? ⇒ Boolean

Returns true when the message is a user message

Returns:

  • (Boolean)


96
97
98
 
# File 'lib/llm/message.rb', line 96

def user?
  role == "user"
end

#tool_call? ⇒ Boolean

Returns true when the message requests a function call

Returns:

  • (Boolean) —

    Returns true when the message requests a function call



103
104
105
 
# File 'lib/llm/message.rb', line 103

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



110
111
112
113
 
# File 'lib/llm/message.rb', line 110

def tool_return?
  LLM::Function::Return === content ||
    [*content].grep(LLM::Function::Return).any?
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



121
122
123
 
# File 'lib/llm/message.rb', line 121

def response
  extra[:response]
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:



131
132
133
 
# File 'lib/llm/message.rb', line 131

def annotations
  @annotations ||= LLM::Object.from(extra["annotations"] || [])
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:



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

def usage
  return nil unless response
  @usage ||= response.usage
end

#model ⇒ String?

Returns the model associated with a message

Returns:

  • (String, nil) —

    Returns the model associated with a message



150
151
152
 
# File 'lib/llm/message.rb', line 150

def model
  response&.model
end