Class: OpenApiOpenAIClient::CreateCompletionResponseChoicesInnerLogprobs

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateCompletionResponseChoicesInnerLogprobs

Initializes the object

Parameters:

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

    Model attributes in the form of hash



59
60
61
62
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
89
90
91
92
93
94
95
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 59

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

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

  if attributes.key?(:'text_offset')
    if (value = attributes[:'text_offset']).is_a?(Array)
      self.text_offset = value
    end
  end

  if attributes.key?(:'token_logprobs')
    if (value = attributes[:'token_logprobs']).is_a?(Array)
      self.token_logprobs = value
    end
  end

  if attributes.key?(:'tokens')
    if (value = attributes[:'tokens']).is_a?(Array)
      self.tokens = value
    end
  end

  if attributes.key?(:'top_logprobs')
    if (value = attributes[:'top_logprobs']).is_a?(Array)
      self.top_logprobs = value
    end
  end
end

Instance Attribute Details

#text_offset ⇒ Object

Returns the value of attribute text_offset.



18
19
20
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 18

def text_offset
  @text_offset
end

#token_logprobs ⇒ Object

Returns the value of attribute token_logprobs.



20
21
22
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 20

def token_logprobs
  @token_logprobs
end

#tokens ⇒ Object

Returns the value of attribute tokens.



22
23
24
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 22

def tokens
  @tokens
end

#top_logprobs ⇒ Object

Returns the value of attribute top_logprobs.



24
25
26
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 24

def top_logprobs
  @top_logprobs
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 162

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = OpenApiOpenAIClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



37
38
39
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 37

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 27

def self.attribute_map
  {
    :'text_offset' => :'text_offset',
    :'token_logprobs' => :'token_logprobs',
    :'tokens' => :'tokens',
    :'top_logprobs' => :'top_logprobs'
  }
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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 138

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



52
53
54
55
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 52

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



42
43
44
45
46
47
48
49
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 42

def self.openapi_types
  {
    :'text_offset' => :'Array<Integer>',
    :'token_logprobs' => :'Array<Float>',
    :'tokens' => :'Array<String>',
    :'top_logprobs' => :'Array<Hash<String, Float>>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



114
115
116
117
118
119
120
121
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 114

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      text_offset == o.text_offset &&
      token_logprobs == o.token_logprobs &&
      tokens == o.tokens &&
      top_logprobs == o.top_logprobs
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 233

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


125
126
127
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 125

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



131
132
133
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 131

def hash
  [text_offset, token_logprobs, tokens, top_logprobs].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



99
100
101
102
103
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 99

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



209
210
211
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 209

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 215

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



203
204
205
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 203

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



107
108
109
110
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 107

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end