openapi_openai 1.0.0 → 1.1.0

data/lib/openapi_openai/models/create_embedding_request.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,18 +15,48 @@ require 'time'
 
 module OpenApiOpenAIClient
   class CreateEmbeddingRequest
+    attr_accessor :input
+
     attr_accessor :model
 
-    attr_accessor :input
+    # The format to return the embeddings in. Can be either `float` or [`base64`](https://pypi.org/project/pybase64/).
+    attr_accessor :encoding_format
+
+    # The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models. 
+    attr_accessor :dimensions
 
     # A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids). 
     attr_accessor :user
 
+    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
       {
-        :'model' => :'model',
         :'input' => :'input',
+        :'model' => :'model',
+        :'encoding_format' => :'encoding_format',
+        :'dimensions' => :'dimensions',
         :'user' => :'user'
       }
     end
@@ -39,8 +69,10 @@ module OpenApiOpenAIClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'model' => :'CreateEmbeddingRequestModel',
         :'input' => :'CreateEmbeddingRequestInput',
+        :'model' => :'CreateEmbeddingRequestModel',
+        :'encoding_format' => :'String',
+        :'dimensions' => :'Integer',
         :'user' => :'String'
       }
     end
@@ -66,16 +98,26 @@ module OpenApiOpenAIClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'input')
+        self.input = attributes[:'input']
+      else
+        self.input = nil
+      end
+
       if attributes.key?(:'model')
         self.model = attributes[:'model']
       else
         self.model = nil
       end
 
-      if attributes.key?(:'input')
-        self.input = attributes[:'input']
+      if attributes.key?(:'encoding_format')
+        self.encoding_format = attributes[:'encoding_format']
       else
-        self.input = nil
+        self.encoding_format = 'float'
+      end
+
+      if attributes.key?(:'dimensions')
+        self.dimensions = attributes[:'dimensions']
       end
 
       if attributes.key?(:'user')
@@ -88,12 +130,16 @@ module OpenApiOpenAIClient
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if @input.nil?
+        invalid_properties.push('invalid value for "input", input cannot be nil.')
+      end
+
       if @model.nil?
         invalid_properties.push('invalid value for "model", model cannot be nil.')
       end
 
-      if @input.nil?
-        invalid_properties.push('invalid value for "input", input cannot be nil.')
+      if !@dimensions.nil? && @dimensions < 1
+        invalid_properties.push('invalid value for "dimensions", must be greater than or equal to 1.')
       end
 
       invalid_properties
@@ -103,18 +149,47 @@ module OpenApiOpenAIClient
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @model.nil?
       return false if @input.nil?
+      return false if @model.nil?
+      encoding_format_validator = EnumAttributeValidator.new('String', ["float", "base64"])
+      return false unless encoding_format_validator.valid?(@encoding_format)
+      return false if !@dimensions.nil? && @dimensions < 1
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] encoding_format Object to be assigned
+    def encoding_format=(encoding_format)
+      validator = EnumAttributeValidator.new('String', ["float", "base64"])
+      unless validator.valid?(encoding_format)
+        fail ArgumentError, "invalid value for \"encoding_format\", must be one of #{validator.allowable_values}."
+      end
+      @encoding_format = encoding_format
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] dimensions Value to be assigned
+    def dimensions=(dimensions)
+      if dimensions.nil?
+        fail ArgumentError, 'dimensions cannot be nil'
+      end
+
+      if dimensions < 1
+        fail ArgumentError, 'invalid value for "dimensions", must be greater than or equal to 1.'
+      end
+
+      @dimensions = dimensions
+    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 &&
-          model == o.model &&
           input == o.input &&
+          model == o.model &&
+          encoding_format == o.encoding_format &&
+          dimensions == o.dimensions &&
           user == o.user
     end
 
@@ -127,7 +202,7 @@ module OpenApiOpenAIClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [model, input, user].hash
+      [input, model, encoding_format, dimensions, user].hash
     end
 
     # Builds the object from hash

data/lib/openapi_openai/models/create_embedding_request_input.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,7 +14,7 @@ require 'date'
 require 'time'
 
 module OpenApiOpenAIClient
-  # Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. Each input must not exceed the max input tokens for the model (8191 tokens for `text-embedding-ada-002`). [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_count_tokens_with_tiktoken.ipynb) for counting tokens. 
+  # Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for `text-embedding-ada-002`), cannot be an empty string, and any array must be 2048 dimensions or less. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens. 
   module CreateEmbeddingRequestInput
     class << self
       # List of class defined in oneOf (OpenAPI v3)

data/lib/openapi_openai/models/create_embedding_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 CreateEmbeddingRequestModel
     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_embedding_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
@@ -15,20 +15,45 @@ require 'time'
 
 module OpenApiOpenAIClient
   class CreateEmbeddingResponse
-    attr_accessor :object
+    # The list of embeddings generated by the model.
+    attr_accessor :data
 
+    # The name of the model used to generate the embedding.
     attr_accessor :model
 
-    attr_accessor :data
+    # The object type, which is always \"list\".
+    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
       {
-        :'object' => :'object',
-        :'model' => :'model',
         :'data' => :'data',
+        :'model' => :'model',
+        :'object' => :'object',
         :'usage' => :'usage'
       }
     end
@@ -41,9 +66,9 @@ module OpenApiOpenAIClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'object' => :'String',
+        :'data' => :'Array<Embedding>',
         :'model' => :'String',
-        :'data' => :'Array<CreateEmbeddingResponseDataInner>',
+        :'object' => :'String',
         :'usage' => :'CreateEmbeddingResponseUsage'
       }
     end
@@ -69,10 +94,12 @@ module OpenApiOpenAIClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'object')
-        self.object = attributes[:'object']
+      if attributes.key?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
       else
-        self.object = nil
+        self.data = nil
       end
 
       if attributes.key?(:'model')
@@ -81,12 +108,10 @@ module OpenApiOpenAIClient
         self.model = nil
       end
 
-      if attributes.key?(:'data')
-        if (value = attributes[:'data']).is_a?(Array)
-          self.data = value
-        end
+      if attributes.key?(:'object')
+        self.object = attributes[:'object']
       else
-        self.data = nil
+        self.object = nil
       end
 
       if attributes.key?(:'usage')
@@ -101,16 +126,16 @@ module OpenApiOpenAIClient
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @object.nil?
-        invalid_properties.push('invalid value for "object", object cannot be nil.')
+      if @data.nil?
+        invalid_properties.push('invalid value for "data", data cannot be nil.')
       end
 
       if @model.nil?
         invalid_properties.push('invalid value for "model", model cannot be nil.')
       end
 
-      if @data.nil?
-        invalid_properties.push('invalid value for "data", data cannot be nil.')
+      if @object.nil?
+        invalid_properties.push('invalid value for "object", object cannot be nil.')
       end
 
       if @usage.nil?
@@ -124,21 +149,33 @@ module OpenApiOpenAIClient
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @object.nil?
-      return false if @model.nil?
       return false if @data.nil?
+      return false if @model.nil?
+      return false if @object.nil?
+      object_validator = EnumAttributeValidator.new('String', ["list"])
+      return false unless object_validator.valid?(@object)
       return false if @usage.nil?
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] object Object to be assigned
+    def object=(object)
+      validator = EnumAttributeValidator.new('String', ["list"])
+      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 &&
-          object == o.object &&
-          model == o.model &&
           data == o.data &&
+          model == o.model &&
+          object == o.object &&
           usage == o.usage
     end
 
@@ -151,7 +188,7 @@ module OpenApiOpenAIClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [object, model, data, usage].hash
+      [data, model, object, usage].hash
     end
 
     # Builds the object from hash

data/lib/openapi_openai/models/create_embedding_response_usage.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,9 +14,12 @@ require 'date'
 require 'time'
 
 module OpenApiOpenAIClient
+  # The usage information for the request.
   class CreateEmbeddingResponseUsage
+    # The number of tokens used by the prompt.
     attr_accessor :prompt_tokens
 
+    # The total number of tokens used by the request.
     attr_accessor :total_tokens
 
     # Attribute mapping from ruby-style variable name to JSON key.