Class: OpenApiOpenAIClient::ChatCompletionTokenLogprob

Inherits:
ApiModelBase
  • 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

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ ChatCompletionTokenLogprob

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
105
106
107
108
109
110
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 69

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
  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::ChatCompletionTokenLogprob`. 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?(:'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

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



46
47
48
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 46

def self.acceptable_attributes
  acceptable_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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 198

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



61
62
63
64
65
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 61

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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



174
175
176
177
178
179
180
181
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 174

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


185
186
187
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 185

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



191
192
193
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 191

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



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 114

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_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 220

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



134
135
136
137
138
139
140
 
# File 'lib/openapi_openai/models/chat_completion_token_logprob.rb', line 134

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