Class: OmniAI::Chat::Message

Inherits:
Object
  • Object
show all
Defined in:
lib/omniai/chat/message.rb,
lib/omniai/chat/message/builder.rb

Overview

Used to standardize the process of building message within a prompt:

completion = client.chat do |prompt|
  prompt.user do |message|
    message.text 'What are these photos of?'
    message.url 'https://example.com/cat.jpg', type: "image/jpeg"
    message.url 'https://example.com/dog.jpg', type: "image/jpeg"
    message.file File.open('hamster.jpg'), type: "image/jpeg"
    message.
  end
end

Direct Known Subclasses

ToolCallMessage

Defined Under Namespace

Classes: Builder

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(content:, role: Role::USER, tool_call_list: nil) ⇒ Message

Returns a new instance of Message.

Parameters:

  • content (String, nil)
  • role (String) (defaults to: Role::USER)
  • tool_call_list (ToolCallList, nil) (defaults to: nil) 


56
57
58
59
60
 
# File 'lib/omniai/chat/message.rb', line 56

def initialize(content:, role: Role::USER, tool_call_list: nil)
  @content = content
  @role = role
  @tool_call_list = tool_call_list
end

Instance Attribute Details

#content ⇒ Array<Content>, String

Returns:



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

def content
  @content
end

#role ⇒ String

Returns:

  • (String) 


47
48
49
 
# File 'lib/omniai/chat/message.rb', line 47

def role
  @role
end

#tool_call_list ⇒ ToolCallList?

Returns:



51
52
53
 
# File 'lib/omniai/chat/message.rb', line 51

def tool_call_list
  @tool_call_list
end

Class Method Details

.build(content = nil, role: Role::USER) {|builder| ... } ⇒ Message

Examples:

prompt.build('What is the capital of Canada?')
prompt.build(role: 'user') do |message|
  message.text 'What is the capital of Canada?'
end

Parameters:

  • content (String, nil) (defaults to: nil)
  • role (Symbol) (defaults to: Role::USER)

Yields:

  • (builder)

Yield Parameters:

Returns:

Raises:

  • (ArgumentError) 


32
33
34
35
36
37
38
39
 
# File 'lib/omniai/chat/message.rb', line 32

def self.build(content = nil, role: Role::USER, &block)
  raise ArgumentError, "content or block is required" if content.nil? && block.nil?

  Builder.build(role:) do |builder|
    builder.text(content) if content
    block&.call(builder)
  end
end

.deserialize(data, context: nil) ⇒ Message

Usage:

Message.deserialize({ role: :user, content: 'Hello!' }) # => #<Message ...>

Parameters:

  • data (Hash)
  • context (Context) (defaults to: nil) —

    optional

Returns:



83
84
85
86
87
88
89
90
91
92
 
# File 'lib/omniai/chat/message.rb', line 83

def self.deserialize(data, context: nil)
  deserialize = context&.deserializer(:message)
  return deserialize.call(data, context:) if deserialize

  role = data["role"]
  content = Content.deserialize(data["content"], context:)
  tool_call_list = ToolCallList.deserialize(data["tool_calls"], context:)

  new(content:, role:, tool_call_list:)
end

Instance Method Details

#arrayify(object) ⇒ Array

Parameters:

  • object (Object)

Returns:

  • (Array) 


148
149
150
151
152
153
 
# File 'lib/omniai/chat/message.rb', line 148

def arrayify(object)
  return if object.nil?
  return object if object.is_a?(Array)

  [object]
end

#inspect ⇒ String

Returns:

  • (String) 


63
64
65
 
# File 'lib/omniai/chat/message.rb', line 63

def inspect
  "#<#{self.class} role=#{@role.inspect} content=#{@content.inspect}>"
end

#role?(role) ⇒ Boolean

Returns:

  • (Boolean) 


113
114
115
 
# File 'lib/omniai/chat/message.rb', line 113

def role?(role)
  String(@role).eql?(String(role))
end

#serialize(context: nil) ⇒ Hash

Usage:

message.serialize # => { role: :user, content: 'Hello!' }
message.serialize # => { role: :user, content: [{ type: 'text', text: 'Hello!' }] }

Parameters:

  • context (Context) (defaults to: nil) —

    optional

Returns:

  • (Hash) 


102
103
104
105
106
107
108
109
110
 
# File 'lib/omniai/chat/message.rb', line 102

def serialize(context: nil)
  serializer = context&.serializer(:message)
  return serializer.call(self, context:) if serializer

  content = @content.is_a?(Array) ? @content.map { |content| content.serialize(context:) } : @content
  tool_calls = @tool_call_list&.serialize(context:)

  { role: @role, content:, tool_calls: }.compact
end

#summarize ⇒ String

Returns:

  • (String) 


68
69
70
71
72
73
 
# File 'lib/omniai/chat/message.rb', line 68

def summarize
  <<~TEXT
    #{@role}
    #{Content.summarize(@content)}
  TEXT
end

#system? ⇒ Boolean

Returns:

  • (Boolean) 


118
119
120
 
# File 'lib/omniai/chat/message.rb', line 118

def system?
  role?(Role::SYSTEM)
end

#text ⇒ String?

Returns:

  • (String, nil) 


138
139
140
141
142
143
144
 
# File 'lib/omniai/chat/message.rb', line 138

def text
  return if @content.nil?
  return @content if @content.is_a?(String)

  parts = arrayify(@content).filter { |content| content.is_a?(Text) }
  parts.map(&:text).join("\n") unless parts.empty?
end

#text? ⇒ Boolean

Returns:

  • (Boolean) 


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

def text?
  !text.nil?
end

#tool? ⇒ Boolean

Returns:

  • (Boolean) 


128
129
130
 
# File 'lib/omniai/chat/message.rb', line 128

def tool?
  role?(Role::TOOL)
end

#user? ⇒ Boolean

Returns:

  • (Boolean) 


123
124
125
 
# File 'lib/omniai/chat/message.rb', line 123

def user?
  role?(Role::USER)
end