openapi_openai 1.1.0 → 1.2.0

data/lib/openapi_openai/models/vector_store_file_batch_object_file_counts.rb

@@ -0,0 +1,273 @@
+=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.3.0
+Contact: blah+oapicf@cliffano.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.18.0
+
+=end
+
+require 'date'
+require 'time'
+
+module OpenApiOpenAIClient
+  class VectorStoreFileBatchObjectFileCounts < ApiModelBase
+    # The number of files that are currently being processed.
+    attr_accessor :in_progress
+
+    # The number of files that have been processed.
+    attr_accessor :completed
+
+    # The number of files that have failed to process.
+    attr_accessor :failed
+
+    # The number of files that where cancelled.
+    attr_accessor :cancelled
+
+    # The total number of files.
+    attr_accessor :total
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'in_progress' => :'in_progress',
+        :'completed' => :'completed',
+        :'failed' => :'failed',
+        :'cancelled' => :'cancelled',
+        :'total' => :'total'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'in_progress' => :'Integer',
+        :'completed' => :'Integer',
+        :'failed' => :'Integer',
+        :'cancelled' => :'Integer',
+        :'total' => :'Integer'
+      }
+    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::VectorStoreFileBatchObjectFileCounts` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `OpenApiOpenAIClient::VectorStoreFileBatchObjectFileCounts`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'in_progress')
+        self.in_progress = attributes[:'in_progress']
+      else
+        self.in_progress = nil
+      end
+
+      if attributes.key?(:'completed')
+        self.completed = attributes[:'completed']
+      else
+        self.completed = nil
+      end
+
+      if attributes.key?(:'failed')
+        self.failed = attributes[:'failed']
+      else
+        self.failed = nil
+      end
+
+      if attributes.key?(:'cancelled')
+        self.cancelled = attributes[:'cancelled']
+      else
+        self.cancelled = nil
+      end
+
+      if attributes.key?(:'total')
+        self.total = attributes[:'total']
+      else
+        self.total = nil
+      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 @in_progress.nil?
+        invalid_properties.push('invalid value for "in_progress", in_progress cannot be nil.')
+      end
+
+      if @completed.nil?
+        invalid_properties.push('invalid value for "completed", completed cannot be nil.')
+      end
+
+      if @failed.nil?
+        invalid_properties.push('invalid value for "failed", failed cannot be nil.')
+      end
+
+      if @cancelled.nil?
+        invalid_properties.push('invalid value for "cancelled", cancelled cannot be nil.')
+      end
+
+      if @total.nil?
+        invalid_properties.push('invalid value for "total", total cannot be nil.')
+      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 @in_progress.nil?
+      return false if @completed.nil?
+      return false if @failed.nil?
+      return false if @cancelled.nil?
+      return false if @total.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] in_progress Value to be assigned
+    def in_progress=(in_progress)
+      if in_progress.nil?
+        fail ArgumentError, 'in_progress cannot be nil'
+      end
+
+      @in_progress = in_progress
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] completed Value to be assigned
+    def completed=(completed)
+      if completed.nil?
+        fail ArgumentError, 'completed cannot be nil'
+      end
+
+      @completed = completed
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] failed Value to be assigned
+    def failed=(failed)
+      if failed.nil?
+        fail ArgumentError, 'failed cannot be nil'
+      end
+
+      @failed = failed
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] cancelled Value to be assigned
+    def cancelled=(cancelled)
+      if cancelled.nil?
+        fail ArgumentError, 'cancelled cannot be nil'
+      end
+
+      @cancelled = cancelled
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] total Value to be assigned
+    def total=(total)
+      if total.nil?
+        fail ArgumentError, 'total cannot be nil'
+      end
+
+      @total = total
+    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 &&
+          in_progress == o.in_progress &&
+          completed == o.completed &&
+          failed == o.failed &&
+          cancelled == o.cancelled &&
+          total == o.total
+    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
+      [in_progress, completed, failed, cancelled, total].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
+
+    # 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
+
+  end
+
+end

data/lib/openapi_openai/models/vector_store_file_object.rb

@@ -0,0 +1,348 @@
+=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.3.0
+Contact: blah+oapicf@cliffano.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.18.0
+
+=end
+
+require 'date'
+require 'time'
+
+module OpenApiOpenAIClient
+  # A list of files attached to a vector store.
+  class VectorStoreFileObject < ApiModelBase
+    # The identifier, which can be referenced in API endpoints.
+    attr_accessor :id
+
+    # The object type, which is always `vector_store.file`.
+    attr_accessor :object
+
+    # The total vector store usage in bytes. Note that this may be different from the original file size.
+    attr_accessor :usage_bytes
+
+    # The Unix timestamp (in seconds) for when the vector store file was created.
+    attr_accessor :created_at
+
+    # The ID of the [vector store](/docs/api-reference/vector-stores/object) that the [File](/docs/api-reference/files) is attached to.
+    attr_accessor :vector_store_id
+
+    # The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use.
+    attr_accessor :status
+
+    attr_accessor :last_error
+
+    attr_accessor :chunking_strategy
+
+    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',
+        :'usage_bytes' => :'usage_bytes',
+        :'created_at' => :'created_at',
+        :'vector_store_id' => :'vector_store_id',
+        :'status' => :'status',
+        :'last_error' => :'last_error',
+        :'chunking_strategy' => :'chunking_strategy'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'object' => :'String',
+        :'usage_bytes' => :'Integer',
+        :'created_at' => :'Integer',
+        :'vector_store_id' => :'String',
+        :'status' => :'String',
+        :'last_error' => :'VectorStoreFileObjectLastError',
+        :'chunking_strategy' => :'VectorStoreFileObjectChunkingStrategy'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'last_error',
+      ])
+    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::VectorStoreFileObject` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `OpenApiOpenAIClient::VectorStoreFileObject`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'object')
+        self.object = attributes[:'object']
+      else
+        self.object = nil
+      end
+
+      if attributes.key?(:'usage_bytes')
+        self.usage_bytes = attributes[:'usage_bytes']
+      else
+        self.usage_bytes = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'vector_store_id')
+        self.vector_store_id = attributes[:'vector_store_id']
+      else
+        self.vector_store_id = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'last_error')
+        self.last_error = attributes[:'last_error']
+      else
+        self.last_error = nil
+      end
+
+      if attributes.key?(:'chunking_strategy')
+        self.chunking_strategy = attributes[:'chunking_strategy']
+      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 @id.nil?
+        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.')
+      end
+
+      if @usage_bytes.nil?
+        invalid_properties.push('invalid value for "usage_bytes", usage_bytes cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @vector_store_id.nil?
+        invalid_properties.push('invalid value for "vector_store_id", vector_store_id cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      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 @id.nil?
+      return false if @object.nil?
+      object_validator = EnumAttributeValidator.new('String', ["vector_store.file"])
+      return false unless object_validator.valid?(@object)
+      return false if @usage_bytes.nil?
+      return false if @created_at.nil?
+      return false if @vector_store_id.nil?
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["in_progress", "completed", "cancelled", "failed"])
+      return false unless status_validator.valid?(@status)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] object Object to be assigned
+    def object=(object)
+      validator = EnumAttributeValidator.new('String', ["vector_store.file"])
+      unless validator.valid?(object)
+        fail ArgumentError, "invalid value for \"object\", must be one of #{validator.allowable_values}."
+      end
+      @object = object
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] usage_bytes Value to be assigned
+    def usage_bytes=(usage_bytes)
+      if usage_bytes.nil?
+        fail ArgumentError, 'usage_bytes cannot be nil'
+      end
+
+      @usage_bytes = usage_bytes
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] vector_store_id Value to be assigned
+    def vector_store_id=(vector_store_id)
+      if vector_store_id.nil?
+        fail ArgumentError, 'vector_store_id cannot be nil'
+      end
+
+      @vector_store_id = vector_store_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["in_progress", "completed", "cancelled", "failed"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    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 &&
+          usage_bytes == o.usage_bytes &&
+          created_at == o.created_at &&
+          vector_store_id == o.vector_store_id &&
+          status == o.status &&
+          last_error == o.last_error &&
+          chunking_strategy == o.chunking_strategy
+    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
+      [id, object, usage_bytes, created_at, vector_store_id, status, last_error, chunking_strategy].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
+
+    # 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
+
+  end
+
+end