Class: OCI::GenerativeAiInference::Models::Message

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai_inference/models/message.rb

Overview

A message that represents a single chat dialog. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

ROLE_ENUM = 
[
  ROLE_SYSTEM = 'SYSTEM'.freeze,
  ROLE_USER = 'USER'.freeze,
  ROLE_ASSISTANT = 'ASSISTANT'.freeze,
  ROLE_TOOL = 'TOOL'.freeze,
  ROLE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Message

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



75
76
77
78
79
80
81
82
83
84
 
# File 'lib/oci/generative_ai_inference/models/message.rb', line 75

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.role = attributes[:'role'] if attributes[:'role']

  self.content = attributes[:'content'] if attributes[:'content']
end

Instance Attribute Details

#content ⇒ Array<OCI::GenerativeAiInference::Models::ChatContent>

Contents of the chat message.

Returns:



27
28
29
 
# File 'lib/oci/generative_ai_inference/models/message.rb', line 27

def content
  @content
end

#role ⇒ String

[Required] Indicates who is writing the current chat message.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/generative_ai_inference/models/message.rb', line 23

def role
  @role
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



30
31
32
33
34
35
36
37
 
# File 'lib/oci/generative_ai_inference/models/message.rb', line 30

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'role': :'role',
    'content': :'content'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/oci/generative_ai_inference/models/message.rb', line 54

def self.get_subtype(object_hash)
  type = object_hash[:'role'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::GenerativeAiInference::Models::SystemMessage' if type == 'SYSTEM'
  return 'OCI::GenerativeAiInference::Models::AssistantMessage' if type == 'ASSISTANT'
  return 'OCI::GenerativeAiInference::Models::UserMessage' if type == 'USER'
  return 'OCI::GenerativeAiInference::Models::ToolMessage' if type == 'TOOL'

  # TODO: Log a warning when the subtype is not found.
  'OCI::GenerativeAiInference::Models::Message'
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
 
# File 'lib/oci/generative_ai_inference/models/message.rb', line 40

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'role': :'String',
    'content': :'Array<OCI::GenerativeAiInference::Models::ChatContent>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



106
107
108
109
110
111
112
 
# File 'lib/oci/generative_ai_inference/models/message.rb', line 106

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    role == other.role &&
    content == other.content
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/generative_ai_inference/models/message.rb', line 137

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


117
118
119
 
# File 'lib/oci/generative_ai_inference/models/message.rb', line 117

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



126
127
128
 
# File 'lib/oci/generative_ai_inference/models/message.rb', line 126

def hash
  [role, content].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



170
171
172
173
174
175
176
177
178
179
 
# File 'lib/oci/generative_ai_inference/models/message.rb', line 170

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



164
165
166
 
# File 'lib/oci/generative_ai_inference/models/message.rb', line 164

def to_s
  to_hash.to_s
end