Class: OCI::GenerativeAiInference::Models::CohereLlmInferenceResponse

Inherits:
LlmInferenceResponse show all
Defined in:
lib/oci/generative_ai_inference/models/cohere_llm_inference_response.rb

Overview

The generated text result to return.

Constant Summary

Constants inherited from LlmInferenceResponse

LlmInferenceResponse::RUNTIME_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from LlmInferenceResponse

#runtime_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from LlmInferenceResponse

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CohereLlmInferenceResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/generative_ai_inference/models/cohere_llm_inference_response.rb', line 57

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

  attributes['runtimeType'] = 'COHERE'

  super(attributes)

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

  self.generated_texts = attributes[:'generatedTexts'] if attributes[:'generatedTexts']

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

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

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

Instance Attribute Details

#generated_texts ⇒ Array<OCI::GenerativeAiInference::Models::GeneratedText>

[Required] Each prompt in the input array has an array of GeneratedText, controlled by numGenerations parameter in the request.

Returns:



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

def generated_texts
  @generated_texts
end

#prompt ⇒ String

Represents the original prompt. Applies only to non-stream responses.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/generative_ai_inference/models/cohere_llm_inference_response.rb', line 22

def prompt
  @prompt
end

#time_created ⇒ DateTime

[Required] The date and time that the model was created in an RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



25
26
27
28
29
30
31
32
33
34
 
# File 'lib/oci/generative_ai_inference/models/cohere_llm_inference_response.rb', line 25

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'runtime_type': :'runtimeType',
    'generated_texts': :'generatedTexts',
    'time_created': :'timeCreated',
    'prompt': :'prompt'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/oci/generative_ai_inference/models/cohere_llm_inference_response.rb', line 37

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'runtime_type': :'String',
    'generated_texts': :'Array<OCI::GenerativeAiInference::Models::GeneratedText>',
    'time_created': :'DateTime',
    'prompt': :'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



89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/generative_ai_inference/models/cohere_llm_inference_response.rb', line 89

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

  self.class == other.class &&
    runtime_type == other.runtime_type &&
    generated_texts == other.generated_texts &&
    time_created == other.time_created &&
    prompt == other.prompt
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



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/oci/generative_ai_inference/models/cohere_llm_inference_response.rb', line 122

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


102
103
104
 
# File 'lib/oci/generative_ai_inference/models/cohere_llm_inference_response.rb', line 102

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [runtime_type, generated_texts, time_created, prompt].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oci/generative_ai_inference/models/cohere_llm_inference_response.rb', line 155

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



149
150
151
 
# File 'lib/oci/generative_ai_inference/models/cohere_llm_inference_response.rb', line 149

def to_s
  to_hash.to_s
end