openapi_openai 1.0.0 → 1.1.0

data/lib/openapi_openai/models/chat_completion_response_message.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,17 @@ require 'date'
 require 'time'
 
 module OpenApiOpenAIClient
+  # A chat completion message generated by the model.
   class ChatCompletionResponseMessage
-    # The role of the author of this message.
-    attr_accessor :role
-
     # The contents of the message.
     attr_accessor :content
 
+    # The tool calls generated by the model, such as function calls.
+    attr_accessor :tool_calls
+
+    # The role of the author of this message.
+    attr_accessor :role
+
     attr_accessor :function_call
 
     class EnumAttributeValidator
@@ -48,8 +52,9 @@ module OpenApiOpenAIClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'role' => :'role',
         :'content' => :'content',
+        :'tool_calls' => :'tool_calls',
+        :'role' => :'role',
         :'function_call' => :'function_call'
       }
     end
@@ -62,9 +67,10 @@ module OpenApiOpenAIClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'role' => :'String',
         :'content' => :'String',
-        :'function_call' => :'ChatCompletionRequestMessageFunctionCall'
+        :'tool_calls' => :'Array<ChatCompletionMessageToolCall>',
+        :'role' => :'String',
+        :'function_call' => :'ChatCompletionRequestAssistantMessageFunctionCall'
       }
     end
 
@@ -90,16 +96,24 @@ module OpenApiOpenAIClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'content')
+        self.content = attributes[:'content']
+      else
+        self.content = nil
+      end
+
+      if attributes.key?(:'tool_calls')
+        if (value = attributes[:'tool_calls']).is_a?(Array)
+          self.tool_calls = value
+        end
+      end
+
       if attributes.key?(:'role')
         self.role = attributes[:'role']
       else
         self.role = nil
       end
 
-      if attributes.key?(:'content')
-        self.content = attributes[:'content']
-      end
-
       if attributes.key?(:'function_call')
         self.function_call = attributes[:'function_call']
       end
@@ -122,7 +136,7 @@ module OpenApiOpenAIClient
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @role.nil?
-      role_validator = EnumAttributeValidator.new('String', ["system", "user", "assistant", "function"])
+      role_validator = EnumAttributeValidator.new('String', ["assistant"])
       return false unless role_validator.valid?(@role)
       true
     end
@@ -130,7 +144,7 @@ module OpenApiOpenAIClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] role Object to be assigned
     def role=(role)
-      validator = EnumAttributeValidator.new('String', ["system", "user", "assistant", "function"])
+      validator = EnumAttributeValidator.new('String', ["assistant"])
       unless validator.valid?(role)
         fail ArgumentError, "invalid value for \"role\", must be one of #{validator.allowable_values}."
       end
@@ -142,8 +156,9 @@ module OpenApiOpenAIClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          role == o.role &&
           content == o.content &&
+          tool_calls == o.tool_calls &&
+          role == o.role &&
           function_call == o.function_call
     end
 
@@ -156,7 +171,7 @@ module OpenApiOpenAIClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [role, content, function_call].hash
+      [content, tool_calls, role, function_call].hash
     end
 
     # Builds the object from hash

data/lib/openapi_openai/models/chat_completion_role.rb

@@ -0,0 +1,43 @@
+=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
+  class ChatCompletionRole
+    SYSTEM = "system".freeze
+    USER = "user".freeze
+    ASSISTANT = "assistant".freeze
+    TOOL = "tool".freeze
+    FUNCTION = "function".freeze
+
+    def self.all_vars
+      @all_vars ||= [SYSTEM, USER, ASSISTANT, TOOL, FUNCTION].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if ChatCompletionRole.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #ChatCompletionRole"
+    end
+  end
+end

data/lib/openapi_openai/models/chat_completion_stream_response_delta.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,15 +14,18 @@ require 'date'
 require 'time'
 
 module OpenApiOpenAIClient
+  # A chat completion delta generated by streamed model responses.
   class ChatCompletionStreamResponseDelta
-    # The role of the author of this message.
-    attr_accessor :role
-
     # The contents of the chunk message.
     attr_accessor :content
 
     attr_accessor :function_call
 
+    attr_accessor :tool_calls
+
+    # The role of the author of this message.
+    attr_accessor :role
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -48,9 +51,10 @@ module OpenApiOpenAIClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'role' => :'role',
         :'content' => :'content',
-        :'function_call' => :'function_call'
+        :'function_call' => :'function_call',
+        :'tool_calls' => :'tool_calls',
+        :'role' => :'role'
       }
     end
 
@@ -62,9 +66,10 @@ module OpenApiOpenAIClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'role' => :'String',
         :'content' => :'String',
-        :'function_call' => :'ChatCompletionRequestMessageFunctionCall'
+        :'function_call' => :'ChatCompletionStreamResponseDeltaFunctionCall',
+        :'tool_calls' => :'Array<ChatCompletionMessageToolCallChunk>',
+        :'role' => :'String'
       }
     end
 
@@ -90,10 +95,6 @@ module OpenApiOpenAIClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'role')
-        self.role = attributes[:'role']
-      end
-
       if attributes.key?(:'content')
         self.content = attributes[:'content']
       end
@@ -101,6 +102,16 @@ module OpenApiOpenAIClient
       if attributes.key?(:'function_call')
         self.function_call = attributes[:'function_call']
       end
+
+      if attributes.key?(:'tool_calls')
+        if (value = attributes[:'tool_calls']).is_a?(Array)
+          self.tool_calls = value
+        end
+      end
+
+      if attributes.key?(:'role')
+        self.role = attributes[:'role']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -115,7 +126,7 @@ module OpenApiOpenAIClient
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      role_validator = EnumAttributeValidator.new('String', ["system", "user", "assistant", "function"])
+      role_validator = EnumAttributeValidator.new('String', ["system", "user", "assistant", "tool"])
       return false unless role_validator.valid?(@role)
       true
     end
@@ -123,7 +134,7 @@ module OpenApiOpenAIClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] role Object to be assigned
     def role=(role)
-      validator = EnumAttributeValidator.new('String', ["system", "user", "assistant", "function"])
+      validator = EnumAttributeValidator.new('String', ["system", "user", "assistant", "tool"])
       unless validator.valid?(role)
         fail ArgumentError, "invalid value for \"role\", must be one of #{validator.allowable_values}."
       end
@@ -135,9 +146,10 @@ module OpenApiOpenAIClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          role == o.role &&
           content == o.content &&
-          function_call == o.function_call
+          function_call == o.function_call &&
+          tool_calls == o.tool_calls &&
+          role == o.role
     end
 
     # @see the `==` method
@@ -149,7 +161,7 @@ module OpenApiOpenAIClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [role, content, function_call].hash
+      [content, function_call, tool_calls, role].hash
     end
 
     # Builds the object from hash

data/lib/openapi_openai/models/chat_completion_stream_response_delta_function_call.rb

@@ -0,0 +1,226 @@
+=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
+  # Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.
+  class ChatCompletionStreamResponseDeltaFunctionCall
+    # The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.
+    attr_accessor :arguments
+
+    # The name of the function to call.
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'arguments' => :'arguments',
+        :'name' => :'name'
+      }
+    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
+      {
+        :'arguments' => :'String',
+        :'name' => :'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::ChatCompletionStreamResponseDeltaFunctionCall` 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::ChatCompletionStreamResponseDeltaFunctionCall`. 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?(:'arguments')
+        self.arguments = attributes[:'arguments']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      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'
+      true
+    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 &&
+          arguments == o.arguments &&
+          name == o.name
+    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
+      [arguments, name].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