Class: OpenApiOpenAIClient::ChatCompletionTokenLogprob

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChatCompletionTokenLogprob

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
96
97
98
99
100
101
102
103
104
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 64

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenApiOpenAIClient::ChatCompletionTokenLogprob` 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::ChatCompletionTokenLogprob`. 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?(:'token')
    self.token = attributes[:'token']
  else
    self.token = nil
  end

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

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

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

Instance Attribute Details

#bytes ⇒ Object

A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be ‘null` if there is no bytes representation for the token.



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

def bytes
  @bytes
end

#logprob ⇒ Object

The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value ‘-9999.0` is used to signify that the token is very unlikely.



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

def logprob
  @logprob
end

#token ⇒ Object

The token.



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

def token
  @token
end

#top_logprobs ⇒ Object

List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested ‘top_logprobs` returned.



28
29
30
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 28

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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 186

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



41
42
43
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 41

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 31

def self.attribute_map
  {
    :'token' => :'token',
    :'logprob' => :'logprob',
    :'bytes' => :'bytes',
    :'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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 162

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



56
57
58
59
60
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 56

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

.openapi_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 46

def self.openapi_types
  {
    :'token' => :'String',
    :'logprob' => :'Float',
    :'bytes' => :'Array<Integer>',
    :'top_logprobs' => :'Array<ChatCompletionTokenLogprobTopLogprobsInner>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



138
139
140
141
142
143
144
145
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 138

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      token == o.token &&
      logprob == o.logprob &&
      bytes == o.bytes &&
      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



257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 257

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


149
150
151
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 149

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



155
156
157
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 155

def hash
  [token, logprob, bytes, 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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 108

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

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

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

  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



233
234
235
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 233

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



239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 239

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



227
228
229
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 227

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



128
129
130
131
132
133
134
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 128

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @token.nil?
  return false if @logprob.nil?
  return false if @top_logprobs.nil?
  true
end