Class: OCI::GenerativeAiInference::Models::CohereChatResponseV2

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

Overview

The response to the chat conversation.

Constant Summary collapse

FINISH_REASON_ENUM = 
[
  FINISH_REASON_COMPLETE = 'COMPLETE'.freeze,
  FINISH_REASON_STOP_SEQUENCE = 'STOP_SEQUENCE'.freeze,
  FINISH_REASON_MAX_TOKENS = 'MAX_TOKENS'.freeze,
  FINISH_REASON_TOOL_CALL = 'TOOL_CALL'.freeze,
  FINISH_REASON_ERROR = 'ERROR'.freeze,
  FINISH_REASON_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

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 = {}) ⇒ CohereChatResponseV2

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
114
115
116
117
118
119
120
 
# File 'lib/oci/generative_ai_inference/models/cohere_chat_response_v2.rb', line 87

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

  attributes['apiFormat'] = 'COHEREV2'

  super(attributes)

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

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

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

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

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

  self.error_message = attributes[:'errorMessage'] if attributes[:'errorMessage']

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

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

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

Instance Attribute Details

#error_message ⇒ String

If there is an error during the streaming scenario, then the errorMessage parameter contains details for the error.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/generative_ai_inference/models/cohere_chat_response_v2.rb', line 40

def error_message
  @error_message
end

#finish_reason ⇒ String

[Required] Why the generation stopped.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/generative_ai_inference/models/cohere_chat_response_v2.rb', line 32

def finish_reason
  @finish_reason
end

#id ⇒ String

[Required] Unique identifier for the generated reply

Returns:

  • (String) 


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

def id
  @id
end

#log_probabilities ⇒ Array<OCI::GenerativeAiInference::Models::LogProbability>

The log probabilities of the generated tokens.

Returns:



36
37
38
 
# File 'lib/oci/generative_ai_inference/models/cohere_chat_response_v2.rb', line 36

def log_probabilities
  @log_probabilities
end

#message ⇒ OCI::GenerativeAiInference::Models::CohereAssistantMessageV2

This attribute is required.

Returns:



28
29
30
 
# File 'lib/oci/generative_ai_inference/models/cohere_chat_response_v2.rb', line 28

def message
  @message
end

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

Returns:



43
44
45
 
# File 'lib/oci/generative_ai_inference/models/cohere_chat_response_v2.rb', line 43

def usage
  @usage
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'api_format': :'apiFormat',
    'id': :'id',
    'message': :'message',
    'finish_reason': :'finishReason',
    'log_probabilities': :'logProbabilities',
    'error_message': :'errorMessage',
    'usage': :'usage'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/generative_ai_inference/models/cohere_chat_response_v2.rb', line 61

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'api_format': :'String',
    'id': :'String',
    'message': :'OCI::GenerativeAiInference::Models::CohereAssistantMessageV2',
    'finish_reason': :'String',
    'log_probabilities': :'Array<OCI::GenerativeAiInference::Models::LogProbability>',
    'error_message': :'String',
    'usage': :'OCI::GenerativeAiInference::Models::Usage'
    # 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



142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/generative_ai_inference/models/cohere_chat_response_v2.rb', line 142

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

  self.class == other.class &&
    api_format == other.api_format &&
    id == other.id &&
    message == other.message &&
    finish_reason == other.finish_reason &&
    log_probabilities == other.log_probabilities &&
    error_message == other.error_message &&
    usage == other.usage
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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/oci/generative_ai_inference/models/cohere_chat_response_v2.rb', line 178

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



167
168
169
 
# File 'lib/oci/generative_ai_inference/models/cohere_chat_response_v2.rb', line 167

def hash
  [api_format, id, message, finish_reason, log_probabilities, error_message, usage].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



211
212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/generative_ai_inference/models/cohere_chat_response_v2.rb', line 211

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



205
206
207
 
# File 'lib/oci/generative_ai_inference/models/cohere_chat_response_v2.rb', line 205

def to_s
  to_hash.to_s
end