Class: OpenApiOpenAIClient::ChatCompletionStreamOptions

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

Overview

Options for streaming response. Only set this when you set ‘stream: true`.

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 = {}) ⇒ ChatCompletionStreamOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/openapi_openai/models/chat_completion_stream_options.rb', line 54

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

Instance Attribute Details

#include_usage ⇒ Object

If set, an additional chunk will be streamed before the ‘data: [DONE]` message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array. All other chunks will also include a usage field, but with a null value.



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

def include_usage
  @include_usage
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



30
31
32
 
# File 'lib/openapi_openai/models/chat_completion_stream_options.rb', line 30

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



35
36
37
 
# File 'lib/openapi_openai/models/chat_completion_stream_options.rb', line 35

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



23
24
25
26
27
 
# File 'lib/openapi_openai/models/chat_completion_stream_options.rb', line 23

def self.attribute_map
  {
    :'include_usage' => :'include_usage'
  }
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



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

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



47
48
49
50
 
# File 'lib/openapi_openai/models/chat_completion_stream_options.rb', line 47

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

.openapi_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
 
# File 'lib/openapi_openai/models/chat_completion_stream_options.rb', line 40

def self.openapi_types
  {
    :'include_usage' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



90
91
92
93
94
 
# File 'lib/openapi_openai/models/chat_completion_stream_options.rb', line 90

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      include_usage == o.include_usage
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


98
99
100
 
# File 'lib/openapi_openai/models/chat_completion_stream_options.rb', line 98

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



104
105
106
 
# File 'lib/openapi_openai/models/chat_completion_stream_options.rb', line 104

def hash
  [include_usage].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



75
76
77
78
79
 
# File 'lib/openapi_openai/models/chat_completion_stream_options.rb', line 75

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



133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/openapi_openai/models/chat_completion_stream_options.rb', line 133

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



83
84
85
86
 
# File 'lib/openapi_openai/models/chat_completion_stream_options.rb', line 83

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