openapi_openai 1.0.0 → 1.1.0

data/lib/openapi_openai/models/create_completion_request_model.rb

@@ -1,7 +1,7 @@
 =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
 Contact: blah+oapicf@cliffano.com
@@ -17,25 +17,24 @@ 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. 
   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)
@@ -44,7 +43,7 @@ module OpenApiOpenAIClient
           end
         end
 
-        openapi_one_of.include?(:AnyType) ? data : nil
+        openapi_any_of.include?(:AnyType) ? data : nil
       end
 
       private
@@ -83,7 +82,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,7 +1,7 @@
 =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
 Contact: blah+oapicf@cliffano.com

data/lib/openapi_openai/models/create_completion_request_stop.rb

@@ -1,7 +1,7 @@
 =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
 Contact: blah+oapicf@cliffano.com

data/lib/openapi_openai/models/create_completion_response.rb

@@ -1,7 +1,7 @@
 =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
 Contact: blah+oapicf@cliffano.com
@@ -14,27 +14,59 @@ require 'date'
 require 'time'
 
 module OpenApiOpenAIClient
+  # 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
+    # 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
@@ -48,11 +80,12 @@ module OpenApiOpenAIClient
     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
 
@@ -83,10 +116,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 +136,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 +160,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 +172,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 +184,36 @@ 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 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 +226,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

data/lib/openapi_openai/models/create_completion_response_choices_inner.rb

@@ -1,7 +1,7 @@
 =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
 Contact: blah+oapicf@cliffano.com
@@ -15,13 +15,14 @@ require 'time'
 
 module OpenApiOpenAIClient
   class CreateCompletionResponseChoicesInner
-    attr_accessor :text
+    # 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, or `content_filter` if content was omitted due to a flag from our content filters. 
+    attr_accessor :finish_reason
 
     attr_accessor :index
 
     attr_accessor :logprobs
 
-    attr_accessor :finish_reason
+    attr_accessor :text
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -48,10 +49,10 @@ module OpenApiOpenAIClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'text' => :'text',
+        :'finish_reason' => :'finish_reason',
         :'index' => :'index',
         :'logprobs' => :'logprobs',
-        :'finish_reason' => :'finish_reason'
+        :'text' => :'text'
       }
     end
 
@@ -63,10 +64,10 @@ module OpenApiOpenAIClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'text' => :'String',
+        :'finish_reason' => :'String',
         :'index' => :'Integer',
         :'logprobs' => :'CreateCompletionResponseChoicesInnerLogprobs',
-        :'finish_reason' => :'String'
+        :'text' => :'String'
       }
     end
 
@@ -92,10 +93,10 @@ module OpenApiOpenAIClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'text')
-        self.text = attributes[:'text']
+      if attributes.key?(:'finish_reason')
+        self.finish_reason = attributes[:'finish_reason']
       else
-        self.text = nil
+        self.finish_reason = nil
       end
 
       if attributes.key?(:'index')
@@ -110,10 +111,10 @@ module OpenApiOpenAIClient
         self.logprobs = nil
       end
 
-      if attributes.key?(:'finish_reason')
-        self.finish_reason = attributes[:'finish_reason']
+      if attributes.key?(:'text')
+        self.text = attributes[:'text']
       else
-        self.finish_reason = nil
+        self.text = nil
       end
     end
 
@@ -122,16 +123,16 @@ module OpenApiOpenAIClient
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @text.nil?
-        invalid_properties.push('invalid value for "text", text cannot be nil.')
+      if @finish_reason.nil?
+        invalid_properties.push('invalid value for "finish_reason", finish_reason cannot be nil.')
       end
 
       if @index.nil?
         invalid_properties.push('invalid value for "index", index cannot be nil.')
       end
 
-      if @finish_reason.nil?
-        invalid_properties.push('invalid value for "finish_reason", finish_reason cannot be nil.')
+      if @text.nil?
+        invalid_properties.push('invalid value for "text", text cannot be nil.')
       end
 
       invalid_properties
@@ -141,18 +142,18 @@ module OpenApiOpenAIClient
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @text.nil?
-      return false if @index.nil?
       return false if @finish_reason.nil?
-      finish_reason_validator = EnumAttributeValidator.new('String', ["stop", "length"])
+      finish_reason_validator = EnumAttributeValidator.new('String', ["stop", "length", "content_filter"])
       return false unless finish_reason_validator.valid?(@finish_reason)
+      return false if @index.nil?
+      return false if @text.nil?
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] finish_reason Object to be assigned
     def finish_reason=(finish_reason)
-      validator = EnumAttributeValidator.new('String', ["stop", "length"])
+      validator = EnumAttributeValidator.new('String', ["stop", "length", "content_filter"])
       unless validator.valid?(finish_reason)
         fail ArgumentError, "invalid value for \"finish_reason\", must be one of #{validator.allowable_values}."
       end
@@ -164,10 +165,10 @@ module OpenApiOpenAIClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          text == o.text &&
+          finish_reason == o.finish_reason &&
           index == o.index &&
           logprobs == o.logprobs &&
-          finish_reason == o.finish_reason
+          text == o.text
     end
 
     # @see the `==` method
@@ -179,7 +180,7 @@ module OpenApiOpenAIClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [text, index, logprobs, finish_reason].hash
+      [finish_reason, index, logprobs, text].hash
     end
 
     # Builds the object from hash

data/lib/openapi_openai/models/create_completion_response_choices_inner_logprobs.rb

@@ -1,7 +1,7 @@
 =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
 Contact: blah+oapicf@cliffano.com
@@ -15,21 +15,21 @@ require 'time'
 
 module OpenApiOpenAIClient
   class CreateCompletionResponseChoicesInnerLogprobs
-    attr_accessor :tokens
+    attr_accessor :text_offset
 
     attr_accessor :token_logprobs
 
-    attr_accessor :top_logprobs
+    attr_accessor :tokens
 
-    attr_accessor :text_offset
+    attr_accessor :top_logprobs
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'tokens' => :'tokens',
+        :'text_offset' => :'text_offset',
         :'token_logprobs' => :'token_logprobs',
-        :'top_logprobs' => :'top_logprobs',
-        :'text_offset' => :'text_offset'
+        :'tokens' => :'tokens',
+        :'top_logprobs' => :'top_logprobs'
       }
     end
 
@@ -41,10 +41,10 @@ module OpenApiOpenAIClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'tokens' => :'Array<String>',
+        :'text_offset' => :'Array<Integer>',
         :'token_logprobs' => :'Array<Float>',
-        :'top_logprobs' => :'Array<Object>',
-        :'text_offset' => :'Array<Integer>'
+        :'tokens' => :'Array<String>',
+        :'top_logprobs' => :'Array<Hash<String, Float>>'
       }
     end
 
@@ -69,9 +69,9 @@ module OpenApiOpenAIClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'tokens')
-        if (value = attributes[:'tokens']).is_a?(Array)
-          self.tokens = value
+      if attributes.key?(:'text_offset')
+        if (value = attributes[:'text_offset']).is_a?(Array)
+          self.text_offset = value
         end
       end
 
@@ -81,15 +81,15 @@ module OpenApiOpenAIClient
         end
       end
 
-      if attributes.key?(:'top_logprobs')
-        if (value = attributes[:'top_logprobs']).is_a?(Array)
-          self.top_logprobs = value
+      if attributes.key?(:'tokens')
+        if (value = attributes[:'tokens']).is_a?(Array)
+          self.tokens = value
         end
       end
 
-      if attributes.key?(:'text_offset')
-        if (value = attributes[:'text_offset']).is_a?(Array)
-          self.text_offset = value
+      if attributes.key?(:'top_logprobs')
+        if (value = attributes[:'top_logprobs']).is_a?(Array)
+          self.top_logprobs = value
         end
       end
     end
@@ -114,10 +114,10 @@ module OpenApiOpenAIClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          tokens == o.tokens &&
+          text_offset == o.text_offset &&
           token_logprobs == o.token_logprobs &&
-          top_logprobs == o.top_logprobs &&
-          text_offset == o.text_offset
+          tokens == o.tokens &&
+          top_logprobs == o.top_logprobs
     end
 
     # @see the `==` method
@@ -129,7 +129,7 @@ module OpenApiOpenAIClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [tokens, token_logprobs, top_logprobs, text_offset].hash
+      [text_offset, token_logprobs, tokens, top_logprobs].hash
     end
 
     # Builds the object from hash