openapi_openai 1.1.0 → 1.2.0

data/lib/openapi_openai/models/create_chat_completion_stream_response.rb

@@ -3,10 +3,10 @@
 
 #The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
 
-The version of the OpenAPI document: 2.0.0
+The version of the OpenAPI document: 2.3.0
 Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.4.0
+Generator version: 7.18.0
 
 =end
 
@@ -15,11 +15,11 @@ require 'time'
 
 module OpenApiOpenAIClient
   # Represents a streamed chunk of a chat completion response returned by model, based on the provided input.
-  class CreateChatCompletionStreamResponse
+  class CreateChatCompletionStreamResponse < ApiModelBase
     # A unique identifier for the chat completion. Each chunk has the same ID.
     attr_accessor :id
 
-    # A list of chat completion choices. Can be more than one if `n` is greater than 1.
+    # A list of chat completion choices. Can contain more than one elements if `n` is greater than 1. Can also be empty for the last chunk if you set `stream_options: {\"include_usage\": true}`. 
     attr_accessor :choices
 
     # The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp.
@@ -28,12 +28,17 @@ module OpenApiOpenAIClient
     # The model to generate the completion.
     attr_accessor :model
 
+    # The service tier used for processing the request. This field is only included if the `service_tier` parameter is specified in the request.
+    attr_accessor :service_tier
+
     # This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. 
     attr_accessor :system_fingerprint
 
     # The object type, which is always `chat.completion.chunk`.
     attr_accessor :object
 
+    attr_accessor :usage
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -63,14 +68,21 @@ module OpenApiOpenAIClient
         :'choices' => :'choices',
         :'created' => :'created',
         :'model' => :'model',
+        :'service_tier' => :'service_tier',
         :'system_fingerprint' => :'system_fingerprint',
-        :'object' => :'object'
+        :'object' => :'object',
+        :'usage' => :'usage'
       }
     end
 
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
     # Returns all the JSON keys this model knows about
     def self.acceptable_attributes
-      attribute_map.values
+      acceptable_attribute_map.values
     end
 
     # Attribute type mapping.
@@ -80,14 +92,18 @@ module OpenApiOpenAIClient
         :'choices' => :'Array<CreateChatCompletionStreamResponseChoicesInner>',
         :'created' => :'Integer',
         :'model' => :'String',
+        :'service_tier' => :'String',
         :'system_fingerprint' => :'String',
-        :'object' => :'String'
+        :'object' => :'String',
+        :'usage' => :'CreateChatCompletionStreamResponseUsage'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'service_tier',
+        :'usage'
       ])
     end
 
@@ -99,9 +115,10 @@ module OpenApiOpenAIClient
       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 (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `OpenApiOpenAIClient::CreateChatCompletionStreamResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `OpenApiOpenAIClient::CreateChatCompletionStreamResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -132,6 +149,10 @@ module OpenApiOpenAIClient
         self.model = nil
       end
 
+      if attributes.key?(:'service_tier')
+        self.service_tier = attributes[:'service_tier']
+      end
+
       if attributes.key?(:'system_fingerprint')
         self.system_fingerprint = attributes[:'system_fingerprint']
       end
@@ -141,6 +162,10 @@ module OpenApiOpenAIClient
       else
         self.object = nil
       end
+
+      if attributes.key?(:'usage')
+        self.usage = attributes[:'usage']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -179,12 +204,64 @@ module OpenApiOpenAIClient
       return false if @choices.nil?
       return false if @created.nil?
       return false if @model.nil?
+      service_tier_validator = EnumAttributeValidator.new('String', ["scale", "default"])
+      return false unless service_tier_validator.valid?(@service_tier)
       return false if @object.nil?
       object_validator = EnumAttributeValidator.new('String', ["chat.completion.chunk"])
       return false unless object_validator.valid?(@object)
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] choices Value to be assigned
+    def choices=(choices)
+      if choices.nil?
+        fail ArgumentError, 'choices cannot be nil'
+      end
+
+      @choices = choices
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created Value to be assigned
+    def created=(created)
+      if created.nil?
+        fail ArgumentError, 'created cannot be nil'
+      end
+
+      @created = created
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] model Value to be assigned
+    def model=(model)
+      if model.nil?
+        fail ArgumentError, 'model cannot be nil'
+      end
+
+      @model = model
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] service_tier Object to be assigned
+    def service_tier=(service_tier)
+      validator = EnumAttributeValidator.new('String', ["scale", "default"])
+      unless validator.valid?(service_tier)
+        fail ArgumentError, "invalid value for \"service_tier\", must be one of #{validator.allowable_values}."
+      end
+      @service_tier = service_tier
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] object Object to be assigned
     def object=(object)
@@ -204,8 +281,10 @@ module OpenApiOpenAIClient
           choices == o.choices &&
           created == o.created &&
           model == o.model &&
+          service_tier == o.service_tier &&
           system_fingerprint == o.system_fingerprint &&
-          object == o.object
+          object == o.object &&
+          usage == o.usage
     end
 
     # @see the `==` method
@@ -217,7 +296,7 @@ module OpenApiOpenAIClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, choices, created, model, system_fingerprint, object].hash
+      [id, choices, created, model, service_tier, system_fingerprint, object, usage].hash
     end
 
     # Builds the object from hash
@@ -243,61 +322,6 @@ module OpenApiOpenAIClient
       new(transformed_hash)
     end
 
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    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
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
     def to_hash
@@ -314,24 +338,6 @@ module OpenApiOpenAIClient
       hash
     end
 
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    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
-
   end
 
 end

data/lib/openapi_openai/models/create_chat_completion_stream_response_choices_inner.rb

@@ -3,10 +3,10 @@
 
 #The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
 
-The version of the OpenAPI document: 2.0.0
+The version of the OpenAPI document: 2.3.0
 Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.4.0
+Generator version: 7.18.0
 
 =end
 
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module OpenApiOpenAIClient
-  class CreateChatCompletionStreamResponseChoicesInner
+  class CreateChatCompletionStreamResponseChoicesInner < ApiModelBase
     attr_accessor :delta
 
     attr_accessor :logprobs
@@ -57,9 +57,14 @@ module OpenApiOpenAIClient
       }
     end
 
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
     # Returns all the JSON keys this model knows about
     def self.acceptable_attributes
-      attribute_map.values
+      acceptable_attribute_map.values
     end
 
     # Attribute type mapping.
@@ -88,9 +93,10 @@ module OpenApiOpenAIClient
       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 (!self.class.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: " + self.class.attribute_map.keys.inspect
+        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
       }
@@ -145,6 +151,16 @@ module OpenApiOpenAIClient
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] delta Value to be assigned
+    def delta=(delta)
+      if delta.nil?
+        fail ArgumentError, 'delta cannot be nil'
+      end
+
+      @delta = delta
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] finish_reason Object to be assigned
     def finish_reason=(finish_reason)
@@ -155,6 +171,16 @@ module OpenApiOpenAIClient
       @finish_reason = finish_reason
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] index Value to be assigned
+    def index=(index)
+      if index.nil?
+        fail ArgumentError, 'index cannot be nil'
+      end
+
+      @index = index
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -201,61 +227,6 @@ module OpenApiOpenAIClient
       new(transformed_hash)
     end
 
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    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
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
     def to_hash
@@ -272,24 +243,6 @@ module OpenApiOpenAIClient
       hash
     end
 
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    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
-
   end
 
 end

data/lib/openapi_openai/models/create_chat_completion_stream_response_usage.rb

@@ -0,0 +1,220 @@
+=begin
+#OpenAI API
+
+#The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
+
+The version of the OpenAPI document: 2.3.0
+Contact: blah+oapicf@cliffano.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.18.0
+
+=end
+
+require 'date'
+require 'time'
+
+module OpenApiOpenAIClient
+  # An optional field that will only be present when you set `stream_options: {\"include_usage\": true}` in your request. When present, it contains a null value except for the last chunk which contains the token usage statistics for the entire request. 
+  class CreateChatCompletionStreamResponseUsage < ApiModelBase
+    # Number of tokens in the generated completion.
+    attr_accessor :completion_tokens
+
+    # Number of tokens in the prompt.
+    attr_accessor :prompt_tokens
+
+    # Total number of tokens used in the request (prompt + completion).
+    attr_accessor :total_tokens
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'completion_tokens' => :'completion_tokens',
+        :'prompt_tokens' => :'prompt_tokens',
+        :'total_tokens' => :'total_tokens'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'completion_tokens' => :'Integer',
+        :'prompt_tokens' => :'Integer',
+        :'total_tokens' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `OpenApiOpenAIClient::CreateChatCompletionStreamResponseUsage` 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::CreateChatCompletionStreamResponseUsage`. 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?(:'completion_tokens')
+        self.completion_tokens = attributes[:'completion_tokens']
+      else
+        self.completion_tokens = nil
+      end
+
+      if attributes.key?(:'prompt_tokens')
+        self.prompt_tokens = attributes[:'prompt_tokens']
+      else
+        self.prompt_tokens = nil
+      end
+
+      if attributes.key?(:'total_tokens')
+        self.total_tokens = attributes[:'total_tokens']
+      else
+        self.total_tokens = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @completion_tokens.nil?
+        invalid_properties.push('invalid value for "completion_tokens", completion_tokens cannot be nil.')
+      end
+
+      if @prompt_tokens.nil?
+        invalid_properties.push('invalid value for "prompt_tokens", prompt_tokens cannot be nil.')
+      end
+
+      if @total_tokens.nil?
+        invalid_properties.push('invalid value for "total_tokens", total_tokens cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @completion_tokens.nil?
+      return false if @prompt_tokens.nil?
+      return false if @total_tokens.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] completion_tokens Value to be assigned
+    def completion_tokens=(completion_tokens)
+      if completion_tokens.nil?
+        fail ArgumentError, 'completion_tokens cannot be nil'
+      end
+
+      @completion_tokens = completion_tokens
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] prompt_tokens Value to be assigned
+    def prompt_tokens=(prompt_tokens)
+      if prompt_tokens.nil?
+        fail ArgumentError, 'prompt_tokens cannot be nil'
+      end
+
+      @prompt_tokens = prompt_tokens
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] total_tokens Value to be assigned
+    def total_tokens=(total_tokens)
+      if total_tokens.nil?
+        fail ArgumentError, 'total_tokens cannot be nil'
+      end
+
+      @total_tokens = total_tokens
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          completion_tokens == o.completion_tokens &&
+          prompt_tokens == o.prompt_tokens &&
+          total_tokens == o.total_tokens
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [completion_tokens, prompt_tokens, total_tokens].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+  end
+
+end