openapi_openai 1.0.0 → 1.1.0

data/lib/openapi_openai/models/create_run_request.rb

@@ -0,0 +1,433 @@
+=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 CreateRunRequest
+    # The ID of the [assistant](/docs/api-reference/assistants) to use to execute this run.
+    attr_accessor :assistant_id
+
+    attr_accessor :model
+
+    # Overrides the [instructions](/docs/api-reference/assistants/createAssistant) of the assistant. This is useful for modifying the behavior on a per-run basis.
+    attr_accessor :instructions
+
+    # Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions.
+    attr_accessor :additional_instructions
+
+    # Adds additional messages to the thread before creating the run.
+    attr_accessor :additional_messages
+
+    # Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.
+    attr_accessor :tools
+
+    # Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. 
+    attr_accessor :metadata
+
+    # What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. 
+    attr_accessor :temperature
+
+    # If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. 
+    attr_accessor :stream
+
+    # The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `complete`. See `incomplete_details` for more info. 
+    attr_accessor :max_prompt_tokens
+
+    # The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `complete`. See `incomplete_details` for more info. 
+    attr_accessor :max_completion_tokens
+
+    attr_accessor :truncation_strategy
+
+    attr_accessor :tool_choice
+
+    attr_accessor :response_format
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'assistant_id' => :'assistant_id',
+        :'model' => :'model',
+        :'instructions' => :'instructions',
+        :'additional_instructions' => :'additional_instructions',
+        :'additional_messages' => :'additional_messages',
+        :'tools' => :'tools',
+        :'metadata' => :'metadata',
+        :'temperature' => :'temperature',
+        :'stream' => :'stream',
+        :'max_prompt_tokens' => :'max_prompt_tokens',
+        :'max_completion_tokens' => :'max_completion_tokens',
+        :'truncation_strategy' => :'truncation_strategy',
+        :'tool_choice' => :'tool_choice',
+        :'response_format' => :'response_format'
+      }
+    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
+      {
+        :'assistant_id' => :'String',
+        :'model' => :'CreateRunRequestModel',
+        :'instructions' => :'String',
+        :'additional_instructions' => :'String',
+        :'additional_messages' => :'Array<CreateMessageRequest>',
+        :'tools' => :'Array<AssistantObjectToolsInner>',
+        :'metadata' => :'Object',
+        :'temperature' => :'Float',
+        :'stream' => :'Boolean',
+        :'max_prompt_tokens' => :'Integer',
+        :'max_completion_tokens' => :'Integer',
+        :'truncation_strategy' => :'TruncationObject',
+        :'tool_choice' => :'AssistantsApiToolChoiceOption',
+        :'response_format' => :'AssistantsApiResponseFormatOption'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'model',
+        :'instructions',
+        :'additional_instructions',
+        :'additional_messages',
+        :'tools',
+        :'metadata',
+        :'temperature',
+        :'stream',
+        :'max_prompt_tokens',
+        :'max_completion_tokens',
+      ])
+    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::CreateRunRequest` 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::CreateRunRequest`. 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?(:'assistant_id')
+        self.assistant_id = attributes[:'assistant_id']
+      else
+        self.assistant_id = nil
+      end
+
+      if attributes.key?(:'model')
+        self.model = attributes[:'model']
+      end
+
+      if attributes.key?(:'instructions')
+        self.instructions = attributes[:'instructions']
+      end
+
+      if attributes.key?(:'additional_instructions')
+        self.additional_instructions = attributes[:'additional_instructions']
+      end
+
+      if attributes.key?(:'additional_messages')
+        if (value = attributes[:'additional_messages']).is_a?(Array)
+          self.additional_messages = value
+        end
+      end
+
+      if attributes.key?(:'tools')
+        if (value = attributes[:'tools']).is_a?(Array)
+          self.tools = value
+        end
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'temperature')
+        self.temperature = attributes[:'temperature']
+      else
+        self.temperature = 1
+      end
+
+      if attributes.key?(:'stream')
+        self.stream = attributes[:'stream']
+      end
+
+      if attributes.key?(:'max_prompt_tokens')
+        self.max_prompt_tokens = attributes[:'max_prompt_tokens']
+      end
+
+      if attributes.key?(:'max_completion_tokens')
+        self.max_completion_tokens = attributes[:'max_completion_tokens']
+      end
+
+      if attributes.key?(:'truncation_strategy')
+        self.truncation_strategy = attributes[:'truncation_strategy']
+      end
+
+      if attributes.key?(:'tool_choice')
+        self.tool_choice = attributes[:'tool_choice']
+      end
+
+      if attributes.key?(:'response_format')
+        self.response_format = attributes[:'response_format']
+      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
+      if @assistant_id.nil?
+        invalid_properties.push('invalid value for "assistant_id", assistant_id cannot be nil.')
+      end
+
+      if !@tools.nil? && @tools.length > 20
+        invalid_properties.push('invalid value for "tools", number of items must be less than or equal to 20.')
+      end
+
+      if !@temperature.nil? && @temperature > 2
+        invalid_properties.push('invalid value for "temperature", must be smaller than or equal to 2.')
+      end
+
+      if !@temperature.nil? && @temperature < 0
+        invalid_properties.push('invalid value for "temperature", must be greater than or equal to 0.')
+      end
+
+      if !@max_prompt_tokens.nil? && @max_prompt_tokens < 256
+        invalid_properties.push('invalid value for "max_prompt_tokens", must be greater than or equal to 256.')
+      end
+
+      if !@max_completion_tokens.nil? && @max_completion_tokens < 256
+        invalid_properties.push('invalid value for "max_completion_tokens", must be greater than or equal to 256.')
+      end
+
+      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'
+      return false if @assistant_id.nil?
+      return false if !@tools.nil? && @tools.length > 20
+      return false if !@temperature.nil? && @temperature > 2
+      return false if !@temperature.nil? && @temperature < 0
+      return false if !@max_prompt_tokens.nil? && @max_prompt_tokens < 256
+      return false if !@max_completion_tokens.nil? && @max_completion_tokens < 256
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tools Value to be assigned
+    def tools=(tools)
+      if !tools.nil? && tools.length > 20
+        fail ArgumentError, 'invalid value for "tools", number of items must be less than or equal to 20.'
+      end
+
+      @tools = tools
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] temperature Value to be assigned
+    def temperature=(temperature)
+      if !temperature.nil? && temperature > 2
+        fail ArgumentError, 'invalid value for "temperature", must be smaller than or equal to 2.'
+      end
+
+      if !temperature.nil? && temperature < 0
+        fail ArgumentError, 'invalid value for "temperature", must be greater than or equal to 0.'
+      end
+
+      @temperature = temperature
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_prompt_tokens Value to be assigned
+    def max_prompt_tokens=(max_prompt_tokens)
+      if !max_prompt_tokens.nil? && max_prompt_tokens < 256
+        fail ArgumentError, 'invalid value for "max_prompt_tokens", must be greater than or equal to 256.'
+      end
+
+      @max_prompt_tokens = max_prompt_tokens
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_completion_tokens Value to be assigned
+    def max_completion_tokens=(max_completion_tokens)
+      if !max_completion_tokens.nil? && max_completion_tokens < 256
+        fail ArgumentError, 'invalid value for "max_completion_tokens", must be greater than or equal to 256.'
+      end
+
+      @max_completion_tokens = max_completion_tokens
+    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 &&
+          assistant_id == o.assistant_id &&
+          model == o.model &&
+          instructions == o.instructions &&
+          additional_instructions == o.additional_instructions &&
+          additional_messages == o.additional_messages &&
+          tools == o.tools &&
+          metadata == o.metadata &&
+          temperature == o.temperature &&
+          stream == o.stream &&
+          max_prompt_tokens == o.max_prompt_tokens &&
+          max_completion_tokens == o.max_completion_tokens &&
+          truncation_strategy == o.truncation_strategy &&
+          tool_choice == o.tool_choice &&
+          response_format == o.response_format
+    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
+      [assistant_id, model, instructions, additional_instructions, additional_messages, tools, metadata, temperature, stream, max_prompt_tokens, max_completion_tokens, truncation_strategy, tool_choice, response_format].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_run_request_model.rb

@@ -0,0 +1,104 @@
+=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
+  # The ID of the [Model](/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.
+  module CreateRunRequestModel
+    class << self
+      # 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 anyOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of anyOf items and attempt to identify the appropriate one.
+        # Note:
+        # - 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_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
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_any_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.parse(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = OpenApiOpenAIClient.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_any_of) # nested anyOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end