Class: OpenApiOpenAIClient::CreateChatCompletionStreamResponseChoicesInner

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/openapi_openai/models/create_chat_completion_stream_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 = {}) ⇒ CreateChatCompletionStreamResponseChoicesInner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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_chat_completion_stream_response_choices_inner.rb', line 90

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

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

  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
end

Instance Attribute Details

#delta ⇒ Object

Returns the value of attribute delta.



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

def delta
  @delta
end

#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, content_filter if content was omitted due to a flag from our content filters, tool_calls if the model called a tool, or function_call (deprecated) if the model called a function.



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

def finish_reason
  @finish_reason
end

#index ⇒ Object

The index of the choice in the list of choices.



26
27
28
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response_choices_inner.rb', line 26

def index
  @index
end

#logprobs ⇒ Object

Returns the value of attribute logprobs.



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

def logprobs
  @logprobs
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



61
62
63
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response_choices_inner.rb', line 61

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



66
67
68
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response_choices_inner.rb', line 66

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response_choices_inner.rb', line 210

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



81
82
83
84
85
86
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response_choices_inner.rb', line 81

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'delta' => :'ChatCompletionStreamResponseDelta',
    :'logprobs' => :'CreateChatCompletionResponseChoicesInnerLogprobs',
    :'finish_reason' => :'String',
    :'index' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



186
187
188
189
190
191
192
193
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response_choices_inner.rb', line 186

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


197
198
199
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response_choices_inner.rb', line 197

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [delta, logprobs, finish_reason, index].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
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response_choices_inner.rb', line 129

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

  if @index.nil?
    invalid_properties.push('invalid value for "index", index 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



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

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



145
146
147
148
149
150
151
152
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response_choices_inner.rb', line 145

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