Class: OpenApiOpenAIClient::CreateCompletionResponseChoicesInner

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/openapi_openai/models/create_completion_response_choices_inner.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ CreateCompletionResponseChoicesInner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
121
122
123
124
125
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner.rb', line 88

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenApiOpenAIClient::CreateCompletionResponseChoicesInner` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OpenApiOpenAIClient::CreateCompletionResponseChoicesInner`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'finish_reason')
    self.finish_reason = attributes[:'finish_reason']
  else
    self.finish_reason = nil
  end

  if attributes.key?(:'index')
    self.index = attributes[:'index']
  else
    self.index = nil
  end

  if attributes.key?(:'logprobs')
    self.logprobs = attributes[:'logprobs']
  else
    self.logprobs = nil
  end

  if attributes.key?(:'text')
    self.text = attributes[:'text']
  else
    self.text = nil
  end
end

Instance Attribute Details

#finish_reason ⇒ Object

The reason the model stopped generating tokens. This will be stop if the model hit a natural stop point or a provided stop sequence, length if the maximum number of tokens specified in the request was reached, or content_filter if content was omitted due to a flag from our content filters.



19
20
21
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner.rb', line 19

def finish_reason
  @finish_reason
end

#index ⇒ Object

Returns the value of attribute index.



21
22
23
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner.rb', line 21

def index
  @index
end

#logprobs ⇒ Object

Returns the value of attribute logprobs.



23
24
25
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner.rb', line 23

def logprobs
  @logprobs
end

#text ⇒ Object

Returns the value of attribute text.



25
26
27
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner.rb', line 25

def text
  @text
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



60
61
62
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner.rb', line 60

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



65
66
67
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner.rb', line 65

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner.rb', line 50

def self.attribute_map
  {
    :'finish_reason' => :'finish_reason',
    :'index' => :'index',
    :'logprobs' => :'logprobs',
    :'text' => :'text'
  }
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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner.rb', line 215

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



80
81
82
83
84
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner.rb', line 80

def self.openapi_nullable
  Set.new([
    :'logprobs',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner.rb', line 70

def self.openapi_types
  {
    :'finish_reason' => :'String',
    :'index' => :'Integer',
    :'logprobs' => :'CreateCompletionResponseChoicesInnerLogprobs',
    :'text' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



191
192
193
194
195
196
197
198
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner.rb', line 191

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      finish_reason == o.finish_reason &&
      index == o.index &&
      logprobs == o.logprobs &&
      text == o.text
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


202
203
204
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner.rb', line 202

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



208
209
210
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner.rb', line 208

def hash
  [finish_reason, index, logprobs, text].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner.rb', line 129

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @finish_reason.nil?
    invalid_properties.push('invalid value for "finish_reason", finish_reason cannot be nil.')
  end

  if @index.nil?
    invalid_properties.push('invalid value for "index", index cannot be nil.')
  end

  if @text.nil?
    invalid_properties.push('invalid value for "text", text cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner.rb', line 237

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



149
150
151
152
153
154
155
156
157
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner.rb', line 149

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @finish_reason.nil?
  finish_reason_validator = EnumAttributeValidator.new('String', ["stop", "length", "content_filter"])
  return false unless finish_reason_validator.valid?(@finish_reason)
  return false if @index.nil?
  return false if @text.nil?
  true
end