Class: OCI::GenerativeAiInference::Models::GenericChatResponse

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

Overview

The response for a chat conversation.

Constant Summary

Constants inherited from BaseChatResponse

BaseChatResponse::API_FORMAT_ENUM

Instance Attribute Summary collapse

Attributes inherited from BaseChatResponse

#api_format

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseChatResponse

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ GenericChatResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/generative_ai_inference/models/generic_chat_response.rb', line 63

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

  attributes['apiFormat'] = 'GENERIC'

  super(attributes)

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

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

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

  self.service_tier = attributes[:'serviceTier'] if attributes[:'serviceTier']

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

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

Instance Attribute Details

#choices ⇒ Array<OCI::GenerativeAiInference::Models::ChatChoice>

[Required] A list of generated texts. Can be more than one if n is greater than 1.

Returns:



18
19
20
 
# File 'lib/oci/generative_ai_inference/models/generic_chat_response.rb', line 18

def choices
  @choices
end

#service_tier ⇒ String

Specifies the processing type used for serving the request.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/generative_ai_inference/models/generic_chat_response.rb', line 25

def service_tier
  @service_tier
end

#time_created ⇒ DateTime

[Required] The Unix timestamp (in seconds) of when the response text was generated.

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#usage ⇒ OCI::GenerativeAiInference::Models::Usage

Returns:



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

def usage
  @usage
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'api_format': :'apiFormat',
    'time_created': :'timeCreated',
    'choices': :'choices',
    'usage': :'usage',
    'service_tier': :'serviceTier'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/oci/generative_ai_inference/models/generic_chat_response.rb', line 41

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'api_format': :'String',
    'time_created': :'DateTime',
    'choices': :'Array<OCI::GenerativeAiInference::Models::ChatChoice>',
    'usage': :'OCI::GenerativeAiInference::Models::Usage',
    'service_tier': :'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
103
104
105
106
 
# File 'lib/oci/generative_ai_inference/models/generic_chat_response.rb', line 97

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

  self.class == other.class &&
    api_format == other.api_format &&
    time_created == other.time_created &&
    choices == other.choices &&
    usage == other.usage &&
    service_tier == other.service_tier
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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/generative_ai_inference/models/generic_chat_response.rb', line 131

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


111
112
113
 
# File 'lib/oci/generative_ai_inference/models/generic_chat_response.rb', line 111

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



120
121
122
 
# File 'lib/oci/generative_ai_inference/models/generic_chat_response.rb', line 120

def hash
  [api_format, time_created, choices, usage, service_tier].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/generative_ai_inference/models/generic_chat_response.rb', line 164

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



158
159
160
 
# File 'lib/oci/generative_ai_inference/models/generic_chat_response.rb', line 158

def to_s
  to_hash.to_s
end