Class: OCI::GenerativeAiInference::Models::DeveloperMessage

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

Overview

Developer-provided instructions that the model should follow, regardless of messages sent by the user. With o1 models and newer, developer messages replace the previous system messages.

Constant Summary

Constants inherited from Message

Message::ROLE_ENUM

Instance Attribute Summary collapse

Attributes inherited from Message

#content, #role

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Message

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ DeveloperMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/generative_ai_inference/models/developer_message.rb', line 46

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

  attributes['role'] = 'DEVELOPER'

  super(attributes)

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

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

Instance Attribute Details

#name ⇒ String

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/generative_ai_inference/models/developer_message.rb', line 14

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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



17
18
19
20
21
22
23
24
25
 
# File 'lib/oci/generative_ai_inference/models/developer_message.rb', line 17

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

.swagger_types ⇒ Object

Attribute type mapping.



28
29
30
31
32
33
34
35
36
 
# File 'lib/oci/generative_ai_inference/models/developer_message.rb', line 28

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'role': :'String',
    'content': :'Array<OCI::GenerativeAiInference::Models::ChatContent>',
    'name': :'String'
    # 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



66
67
68
69
70
71
72
73
 
# File 'lib/oci/generative_ai_inference/models/developer_message.rb', line 66

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

  self.class == other.class &&
    role == other.role &&
    content == other.content &&
    name == other.name
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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/oci/generative_ai_inference/models/developer_message.rb', line 98

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


78
79
80
 
# File 'lib/oci/generative_ai_inference/models/developer_message.rb', line 78

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



87
88
89
 
# File 'lib/oci/generative_ai_inference/models/developer_message.rb', line 87

def hash
  [role, content, name].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



131
132
133
134
135
136
137
138
139
140
 
# File 'lib/oci/generative_ai_inference/models/developer_message.rb', line 131

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



125
126
127
 
# File 'lib/oci/generative_ai_inference/models/developer_message.rb', line 125

def to_s
  to_hash.to_s
end