openapi_openai 1.0.0 → 1.1.0

data/lib/openapi_openai/models/create_chat_completion_request_function_call.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,13 +14,13 @@ require 'date'
 require 'time'
 
 module OpenApiOpenAIClient
-  # Controls how the model responds to function calls. \"none\" means the model does not call a function, and responds to the end-user. \"auto\" means the model can pick between an end-user or calling a function.  Specifying a particular function via `{\"name\":\\ \"my_function\"}` forces the model to call that function. \"none\" is the default when no functions are present. \"auto\" is the default if functions are present.
+  # Deprecated in favor of `tool_choice`.  Controls which (if any) function is called by the model. `none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function. Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.  `none` is the default when no functions are present. `auto` is the default if functions are present. 
   module CreateChatCompletionRequestFunctionCall
     class << self
       # List of class defined in oneOf (OpenAPI v3)
       def openapi_one_of
         [
-          :'CreateChatCompletionRequestFunctionCallOneOf',
+          :'ChatCompletionFunctionCallOption',
           :'String'
         ]
       end

data/lib/openapi_openai/models/create_chat_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. See the [model endpoint compatibility](/docs/models/model-endpoint-compatibility) table for details on which models work with the Chat API.
   module CreateChatCompletionRequestModel
     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_chat_completion_request_response_format.rb

@@ -0,0 +1,252 @@
+=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.0.0
+Contact: blah+oapicf@cliffano.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'date'
+require 'time'
+
+module OpenApiOpenAIClient
+  # An object specifying the format that the model must output. Compatible with [GPT-4 Turbo](/docs/models/gpt-4-and-gpt-4-turbo) and all GPT-3.5 Turbo models newer than `gpt-3.5-turbo-1106`.  Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is valid JSON.  **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. 
+  class CreateChatCompletionRequestResponseFormat
+    # Must be one of `text` or `json_object`.
+    attr_accessor :type
+
+    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
+      {
+        :'type' => :'type'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'String'
+      }
+    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::CreateChatCompletionRequestResponseFormat` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      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::CreateChatCompletionRequestResponseFormat`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = 'text'
+      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
+      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'
+      type_validator = EnumAttributeValidator.new('String', ["text", "json_object"])
+      return false unless type_validator.valid?(@type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["text", "json_object"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    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 &&
+          type == o.type
+    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
+      [type].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
+
+    # 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
+      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
+
+    # 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_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_chat_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 chat completion response returned by model, based on the provided input.
   class CreateChatCompletionResponse
+    # A unique identifier for the chat completion.
     attr_accessor :id
 
-    attr_accessor :object
+    # A list of chat completion choices. Can be more than one if `n` is greater than 1.
+    attr_accessor :choices
 
+    # The Unix timestamp (in seconds) of when the chat completion was created.
     attr_accessor :created
 
+    # The model used for the chat 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 `chat.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<CreateChatCompletionResponseChoicesInner>',
         :'created' => :'Integer',
         :'model' => :'String',
-        :'choices' => :'Array<CreateChatCompletionResponseChoicesInner>',
-        :'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', ["chat.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', ["chat.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_chat_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,11 +15,15 @@ require 'time'
 
 module OpenApiOpenAIClient
   class CreateChatCompletionResponseChoicesInner
+    # 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, `content_filter` if content was omitted due to a flag from our content filters, `tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function. 
+    attr_accessor :finish_reason
+
+    # The index of the choice in the list of choices.
     attr_accessor :index
 
     attr_accessor :message
 
-    attr_accessor :finish_reason
+    attr_accessor :logprobs
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -46,9 +50,10 @@ module OpenApiOpenAIClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'finish_reason' => :'finish_reason',
         :'index' => :'index',
         :'message' => :'message',
-        :'finish_reason' => :'finish_reason'
+        :'logprobs' => :'logprobs'
       }
     end
 
@@ -60,15 +65,17 @@ module OpenApiOpenAIClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'finish_reason' => :'String',
         :'index' => :'Integer',
         :'message' => :'ChatCompletionResponseMessage',
-        :'finish_reason' => :'String'
+        :'logprobs' => :'CreateChatCompletionResponseChoicesInnerLogprobs'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'logprobs'
       ])
     end
 
@@ -87,16 +94,28 @@ module OpenApiOpenAIClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'finish_reason')
+        self.finish_reason = attributes[:'finish_reason']
+      else
+        self.finish_reason = nil
+      end
+
       if attributes.key?(:'index')
         self.index = attributes[:'index']
+      else
+        self.index = nil
       end
 
       if attributes.key?(:'message')
         self.message = attributes[:'message']
+      else
+        self.message = nil
       end
 
-      if attributes.key?(:'finish_reason')
-        self.finish_reason = attributes[:'finish_reason']
+      if attributes.key?(:'logprobs')
+        self.logprobs = attributes[:'logprobs']
+      else
+        self.logprobs = nil
       end
     end
 
@@ -105,6 +124,18 @@ module OpenApiOpenAIClient
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      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 @message.nil?
+        invalid_properties.push('invalid value for "message", message cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -112,15 +143,18 @@ module OpenApiOpenAIClient
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      finish_reason_validator = EnumAttributeValidator.new('String', ["stop", "length", "function_call"])
+      return false if @finish_reason.nil?
+      finish_reason_validator = EnumAttributeValidator.new('String', ["stop", "length", "tool_calls", "content_filter", "function_call"])
       return false unless finish_reason_validator.valid?(@finish_reason)
+      return false if @index.nil?
+      return false if @message.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", "function_call"])
+      validator = EnumAttributeValidator.new('String', ["stop", "length", "tool_calls", "content_filter", "function_call"])
       unless validator.valid?(finish_reason)
         fail ArgumentError, "invalid value for \"finish_reason\", must be one of #{validator.allowable_values}."
       end
@@ -132,9 +166,10 @@ module OpenApiOpenAIClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          finish_reason == o.finish_reason &&
           index == o.index &&
           message == o.message &&
-          finish_reason == o.finish_reason
+          logprobs == o.logprobs
     end
 
     # @see the `==` method
@@ -146,7 +181,7 @@ module OpenApiOpenAIClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [index, message, finish_reason].hash
+      [finish_reason, index, message, logprobs].hash
     end
 
     # Builds the object from hash