Class: OCI::GenerativeAiInference::Models::BaseChatResponse

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

Overview

Base class for chat inference response 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

Direct Known Subclasses

CohereChatResponse, GenericChatResponse

Constant Summary collapse

API_FORMAT_ENUM = 
[
  API_FORMAT_COHERE = 'COHERE'.freeze,
  API_FORMAT_GENERIC = 'GENERIC'.freeze,
  API_FORMAT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BaseChatResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :api_format (String) —

    The value to assign to the #api_format property



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/oci/generative_ai_inference/models/base_chat_response.rb', line 64

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.api_format = attributes[:'apiFormat'] if attributes[:'apiFormat']

  raise 'You cannot provide both :apiFormat and :api_format' if attributes.key?(:'apiFormat') && attributes.key?(:'api_format')

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

Instance Attribute Details

#api_format ⇒ String

[Required] The api format for the model's response

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/generative_ai_inference/models/base_chat_response.rb', line 21

def api_format
  @api_format
end

Class Method Details

.attribute_map ⇒ Object

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



24
25
26
27
28
29
30
 
# File 'lib/oci/generative_ai_inference/models/base_chat_response.rb', line 24

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'api_format': :'apiFormat'
    # 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.



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

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

  return 'OCI::GenerativeAiInference::Models::GenericChatResponse' if type == 'GENERIC'
  return 'OCI::GenerativeAiInference::Models::CohereChatResponse' if type == 'COHERE'

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

.swagger_types ⇒ Object

Attribute type mapping.



33
34
35
36
37
38
39
 
# File 'lib/oci/generative_ai_inference/models/base_chat_response.rb', line 33

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'api_format': :'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



97
98
99
100
101
102
 
# File 'lib/oci/generative_ai_inference/models/base_chat_response.rb', line 97

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

  self.class == other.class &&
    api_format == other.api_format
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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/generative_ai_inference/models/base_chat_response.rb', line 127

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


107
108
109
 
# File 'lib/oci/generative_ai_inference/models/base_chat_response.rb', line 107

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



116
117
118
 
# File 'lib/oci/generative_ai_inference/models/base_chat_response.rb', line 116

def hash
  [api_format].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/generative_ai_inference/models/base_chat_response.rb', line 160

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



154
155
156
 
# File 'lib/oci/generative_ai_inference/models/base_chat_response.rb', line 154

def to_s
  to_hash.to_s
end