openapi_openai 1.0.0 → 1.2.0

data/lib/openapi_openai/models/create_completion_request_model.rb

@@ -1,12 +1,12 @@
 =begin
 #OpenAI API
 
-#APIs for sampling from and fine-tuning language models
+#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,37 +14,35 @@ require 'date'
 require 'time'
 
 module OpenApiOpenAIClient
-  # ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them. 
+  # ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models) for descriptions of them. 
   module CreateCompletionRequestModel
     class << self
-      # List of class defined in oneOf (OpenAPI v3)
-      def openapi_one_of
+      # List of class defined in anyOf (OpenAPI v3)
+      def openapi_any_of
         [
           :'String'
         ]
       end
 
       # Builds the object
-      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @param [Mixed] Data to be matched against the list of anyOf items
       # @return [Object] Returns the model or the data itself
       def build(data)
-        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Go through the list of anyOf items and attempt to identify the appropriate one.
         # Note:
-        # - We do not attempt to check whether exactly one item matches.
         # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
         #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
         # - TODO: scalar values are de facto behaving as if they were nullable.
         # - TODO: logging when debugging is set.
-        openapi_one_of.each do |klass|
+        openapi_any_of.each do |klass|
           begin
             next if klass == :AnyType # "nullable: true"
-            typed_data = find_and_cast_into_type(klass, data)
-            return typed_data if typed_data
+            return find_and_cast_into_type(klass, data)
           rescue # rescue all errors so we keep iterating even if the current item lookup raises
           end
         end
 
-        openapi_one_of.include?(:AnyType) ? data : nil
+        openapi_any_of.include?(:AnyType) ? data : nil
       end
 
       private
@@ -65,7 +63,7 @@ module OpenApiOpenAIClient
         when 'Time'
           return Time.parse(data)
         when 'Date'
-          return Date.parse(data)
+          return Date.iso8601(data)
         when 'String'
           return data if data.instance_of?(String)
         when 'Object' # "type: object"
@@ -83,7 +81,7 @@ module OpenApiOpenAIClient
         else # model
           const = OpenApiOpenAIClient.const_get(klass)
           if const
-            if const.respond_to?(:openapi_one_of) # nested oneOf model
+            if const.respond_to?(:openapi_any_of) # nested anyOf model
               model = const.build(data)
               return model if model
             else

data/lib/openapi_openai/models/create_completion_request_prompt.rb

@@ -1,12 +1,12 @@
 =begin
 #OpenAI API
 
-#APIs for sampling from and fine-tuning language models
+#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
 
@@ -41,8 +41,7 @@ module OpenApiOpenAIClient
         openapi_one_of.each do |klass|
           begin
             next if klass == :AnyType # "nullable: true"
-            typed_data = find_and_cast_into_type(klass, data)
-            return typed_data if typed_data
+            return find_and_cast_into_type(klass, data)
           rescue # rescue all errors so we keep iterating even if the current item lookup raises
           end
         end
@@ -68,7 +67,7 @@ module OpenApiOpenAIClient
         when 'Time'
           return Time.parse(data)
         when 'Date'
-          return Date.parse(data)
+          return Date.iso8601(data)
         when 'String'
           return data if data.instance_of?(String)
         when 'Object' # "type: object"

data/lib/openapi_openai/models/create_completion_request_stop.rb

@@ -1,12 +1,12 @@
 =begin
 #OpenAI API
 
-#APIs for sampling from and fine-tuning language models
+#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
 
@@ -39,8 +39,7 @@ module OpenApiOpenAIClient
         openapi_one_of.each do |klass|
           begin
             next if klass == :AnyType # "nullable: true"
-            typed_data = find_and_cast_into_type(klass, data)
-            return typed_data if typed_data
+            return find_and_cast_into_type(klass, data)
           rescue # rescue all errors so we keep iterating even if the current item lookup raises
           end
         end
@@ -66,7 +65,7 @@ module OpenApiOpenAIClient
         when 'Time'
           return Time.parse(data)
         when 'Date'
-          return Date.parse(data)
+          return Date.iso8601(data)
         when 'String'
           return data if data.instance_of?(String)
         when 'Object' # "type: object"

data/lib/openapi_openai/models/create_completion_response.rb

@@ -1,12 +1,12 @@
 =begin
 #OpenAI API
 
-#APIs for sampling from and fine-tuning language models
+#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,45 +14,83 @@ require 'date'
 require 'time'
 
 module OpenApiOpenAIClient
-  class CreateCompletionResponse
+  # Represents a completion response from the API. Note: both the streamed and non-streamed response objects share the same shape (unlike the chat endpoint). 
+  class CreateCompletionResponse < ApiModelBase
+    # A unique identifier for the completion.
     attr_accessor :id
 
-    attr_accessor :object
+    # The list of completion choices the model generated for the input prompt.
+    attr_accessor :choices
 
+    # The Unix timestamp (in seconds) of when the completion was created.
     attr_accessor :created
 
+    # The model used for completion.
     attr_accessor :model
 
-    attr_accessor :choices
+    # 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 \"text_completion\"
+    attr_accessor :object
 
     attr_accessor :usage
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
-        :'object' => :'object',
+        :'choices' => :'choices',
         :'created' => :'created',
         :'model' => :'model',
-        :'choices' => :'choices',
+        :'system_fingerprint' => :'system_fingerprint',
+        :'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.
     def self.openapi_types
       {
         :'id' => :'String',
-        :'object' => :'String',
+        :'choices' => :'Array<CreateCompletionResponseChoicesInner>',
         :'created' => :'Integer',
         :'model' => :'String',
-        :'choices' => :'Array<CreateCompletionResponseChoicesInner>',
-        :'usage' => :'CreateCompletionResponseUsage'
+        :'system_fingerprint' => :'String',
+        :'object' => :'String',
+        :'usage' => :'CompletionUsage'
       }
     end
 
@@ -70,9 +108,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::CreateCompletionResponse`. 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::CreateCompletionResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -83,10 +122,12 @@ module OpenApiOpenAIClient
         self.id = nil
       end
 
-      if attributes.key?(:'object')
-        self.object = attributes[:'object']
+      if attributes.key?(:'choices')
+        if (value = attributes[:'choices']).is_a?(Array)
+          self.choices = value
+        end
       else
-        self.object = nil
+        self.choices = nil
       end
 
       if attributes.key?(:'created')
@@ -101,12 +142,14 @@ module OpenApiOpenAIClient
         self.model = nil
       end
 
-      if attributes.key?(:'choices')
-        if (value = attributes[:'choices']).is_a?(Array)
-          self.choices = value
-        end
+      if attributes.key?(:'system_fingerprint')
+        self.system_fingerprint = attributes[:'system_fingerprint']
+      end
+
+      if attributes.key?(:'object')
+        self.object = attributes[:'object']
       else
-        self.choices = nil
+        self.object = nil
       end
 
       if attributes.key?(:'usage')
@@ -123,8 +166,8 @@ module OpenApiOpenAIClient
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
-      if @object.nil?
-        invalid_properties.push('invalid value for "object", object cannot be nil.')
+      if @choices.nil?
+        invalid_properties.push('invalid value for "choices", choices cannot be nil.')
       end
 
       if @created.nil?
@@ -135,8 +178,8 @@ module OpenApiOpenAIClient
         invalid_properties.push('invalid value for "model", model cannot be nil.')
       end
 
-      if @choices.nil?
-        invalid_properties.push('invalid value for "choices", choices cannot be nil.')
+      if @object.nil?
+        invalid_properties.push('invalid value for "object", object cannot be nil.')
       end
 
       invalid_properties
@@ -147,23 +190,76 @@ module OpenApiOpenAIClient
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @id.nil?
-      return false if @object.nil?
+      return false if @choices.nil?
       return false if @created.nil?
       return false if @model.nil?
-      return false if @choices.nil?
+      return false if @object.nil?
+      object_validator = EnumAttributeValidator.new('String', ["text_completion"])
+      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] object Object to be assigned
+    def object=(object)
+      validator = EnumAttributeValidator.new('String', ["text_completion"])
+      unless validator.valid?(object)
+        fail ArgumentError, "invalid value for \"object\", must be one of #{validator.allowable_values}."
+      end
+      @object = object
+    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 &&
           id == o.id &&
-          object == o.object &&
+          choices == o.choices &&
           created == o.created &&
           model == o.model &&
-          choices == o.choices &&
+          system_fingerprint == o.system_fingerprint &&
+          object == o.object &&
           usage == o.usage
     end
 
@@ -176,7 +272,7 @@ module OpenApiOpenAIClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, object, created, model, choices, usage].hash
+      [id, choices, created, model, system_fingerprint, object, usage].hash
     end
 
     # Builds the object from hash
@@ -202,61 +298,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
@@ -273,24 +314,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