Class: OpenApiOpenAIClient::CreateCompletionResponseChoicesInnerLogprobs

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

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ CreateCompletionResponseChoicesInnerLogprobs

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
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 64

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

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



42
43
44
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 42

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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 144

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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



120
121
122
123
124
125
126
127
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 120

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



137
138
139
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 137

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



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

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 166

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



113
114
115
116
 
# File 'lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb', line 113

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