Class: OCI::GenerativeAiInference::Models::ChatChoice

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

Overview

Represents a single instance of the chat response.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChatChoice

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/generative_ai_inference/models/chat_choice.rb', line 82

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

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

  self.finish_reason = attributes[:'finishReason'] if attributes[:'finishReason']

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

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

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

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

  self.grounding_metadata = attributes[:'groundingMetadata'] if attributes[:'groundingMetadata']

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

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

  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

#finish_reason ⇒ String

[Required] The reason why the model stopped generating tokens.

Stops if the model hits a natural stop point or a provided stop sequence. Returns the length if the tokens reach the specified maximum number of tokens.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/generative_ai_inference/models/chat_choice.rb', line 24

def finish_reason
  @finish_reason
end

#grounding_metadata ⇒ OCI::GenerativeAiInference::Models::GroundingMetadata

Returns:



33
34
35
 
# File 'lib/oci/generative_ai_inference/models/chat_choice.rb', line 33

def grounding_metadata
  @grounding_metadata
end

#index ⇒ Integer

[Required] The index of the chat.

Returns:

  • (Integer) 


13
14
15
 
# File 'lib/oci/generative_ai_inference/models/chat_choice.rb', line 13

def index
  @index
end

#logprobs ⇒ OCI::GenerativeAiInference::Models::Logprobs

Returns:



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

def logprobs
  @logprobs
end

#message ⇒ OCI::GenerativeAiInference::Models::Message

This attribute is required.

Returns:



17
18
19
 
# File 'lib/oci/generative_ai_inference/models/chat_choice.rb', line 17

def message
  @message
end

#service_tier ⇒ String

Specifies the processing type used for serving the request.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/generative_ai_inference/models/chat_choice.rb', line 37

def service_tier
  @service_tier
end

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

Returns:



30
31
32
 
# File 'lib/oci/generative_ai_inference/models/chat_choice.rb', line 30

def usage
  @usage
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'index': :'index',
    'message': :'message',
    'finish_reason': :'finishReason',
    'logprobs': :'logprobs',
    'usage': :'usage',
    'grounding_metadata': :'groundingMetadata',
    'service_tier': :'serviceTier'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/oci/generative_ai_inference/models/chat_choice.rb', line 55

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'index': :'Integer',
    'message': :'OCI::GenerativeAiInference::Models::Message',
    'finish_reason': :'String',
    'logprobs': :'OCI::GenerativeAiInference::Models::Logprobs',
    'usage': :'OCI::GenerativeAiInference::Models::Usage',
    'grounding_metadata': :'OCI::GenerativeAiInference::Models::GroundingMetadata',
    '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



122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/generative_ai_inference/models/chat_choice.rb', line 122

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

  self.class == other.class &&
    index == other.index &&
    message == other.message &&
    finish_reason == other.finish_reason &&
    logprobs == other.logprobs &&
    usage == other.usage &&
    grounding_metadata == other.grounding_metadata &&
    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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/generative_ai_inference/models/chat_choice.rb', line 158

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


138
139
140
 
# File 'lib/oci/generative_ai_inference/models/chat_choice.rb', line 138

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



147
148
149
 
# File 'lib/oci/generative_ai_inference/models/chat_choice.rb', line 147

def hash
  [index, message, finish_reason, logprobs, usage, grounding_metadata, 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



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/oci/generative_ai_inference/models/chat_choice.rb', line 191

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



185
186
187
 
# File 'lib/oci/generative_ai_inference/models/chat_choice.rb', line 185

def to_s
  to_hash.to_s
end