carbon_ruby_sdk 0.2.19 → 0.2.21

data/lib/carbon_ruby_sdk/models/cold_storage_props.rb

@@ -0,0 +1,229 @@
+=begin
+#Carbon
+
+#Connect external data to LLMs, no matter the source.
+
+The version of the OpenAPI document: 1.0.0
+=end
+
+require 'date'
+require 'time'
+
+module Carbon
+  class ColdStorageProps
+    # Enable cold storage for the file. If set to true, the file will be moved to cold storage after a certain period of inactivity. Default is false.
+    attr_accessor :enable_cold_storage
+
+    # Time in seconds after which the file will be moved to cold storage.
+    attr_accessor :hot_storage_time_to_live
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'enable_cold_storage' => :'enable_cold_storage',
+        :'hot_storage_time_to_live' => :'hot_storage_time_to_live'
+      }
+    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
+      {
+        :'enable_cold_storage' => :'Boolean',
+        :'hot_storage_time_to_live' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'hot_storage_time_to_live'
+      ])
+    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 `Carbon::ColdStorageProps` 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 `Carbon::ColdStorageProps`. 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?(:'enable_cold_storage')
+        self.enable_cold_storage = attributes[:'enable_cold_storage']
+      else
+        self.enable_cold_storage = false
+      end
+
+      if attributes.key?(:'hot_storage_time_to_live')
+        self.hot_storage_time_to_live = attributes[:'hot_storage_time_to_live']
+      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
+      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?
+      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 &&
+          enable_cold_storage == o.enable_cold_storage &&
+          hot_storage_time_to_live == o.hot_storage_time_to_live
+    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
+      [enable_cold_storage, hot_storage_time_to_live].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _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 = Carbon.const_get(type)
+        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/carbon_ruby_sdk/models/embedding_storage_status.rb

@@ -0,0 +1,38 @@
+=begin
+#Carbon
+
+#Connect external data to LLMs, no matter the source.
+
+The version of the OpenAPI document: 1.0.0
+=end
+
+require 'date'
+require 'time'
+
+module Carbon
+  class EmbeddingStorageStatus
+    HOT_STORAGE = "HOT_STORAGE".freeze
+    HOT_TO_COLD = "HOT_TO_COLD".freeze
+    COLD_STORAGE = "COLD_STORAGE".freeze
+    COLD_TO_HOT = "COLD_TO_HOT".freeze
+
+    def self.all_vars
+      @all_vars ||= [HOT_STORAGE, HOT_TO_COLD, COLD_STORAGE, COLD_TO_HOT].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 EmbeddingStorageStatus.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #EmbeddingStorageStatus"
+    end
+  end
+end

data/lib/carbon_ruby_sdk/models/file_sync_config.rb

@@ -22,6 +22,9 @@ module Carbon
 
     attr_accessor :transcription_service
 
+    # Detect multiple speakers and label segments of speech by speaker for audio files.
+    attr_accessor :include_speaker_labels
+
     # Whether to split tabular rows into chunks. Currently only valid for CSV, TSV, and XLSX files.
     attr_accessor :split_rows
 
@@ -32,6 +35,7 @@ module Carbon
         :'sync_attachments' => :'sync_attachments',
         :'detect_audio_language' => :'detect_audio_language',
         :'transcription_service' => :'transcription_service',
+        :'include_speaker_labels' => :'include_speaker_labels',
         :'split_rows' => :'split_rows'
       }
     end
@@ -48,6 +52,7 @@ module Carbon
         :'sync_attachments' => :'Boolean',
         :'detect_audio_language' => :'Boolean',
         :'transcription_service' => :'TranscriptionServiceNullable',
+        :'include_speaker_labels' => :'Boolean',
         :'split_rows' => :'Boolean'
       }
     end
@@ -96,6 +101,12 @@ module Carbon
         self.transcription_service = attributes[:'transcription_service']
       end
 
+      if attributes.key?(:'include_speaker_labels')
+        self.include_speaker_labels = attributes[:'include_speaker_labels']
+      else
+        self.include_speaker_labels = false
+      end
+
       if attributes.key?(:'split_rows')
         self.split_rows = attributes[:'split_rows']
       else
@@ -125,6 +136,7 @@ module Carbon
           sync_attachments == o.sync_attachments &&
           detect_audio_language == o.detect_audio_language &&
           transcription_service == o.transcription_service &&
+          include_speaker_labels == o.include_speaker_labels &&
           split_rows == o.split_rows
     end
 
@@ -137,7 +149,7 @@ module Carbon
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [auto_synced_source_types, sync_attachments, detect_audio_language, transcription_service, split_rows].hash
+      [auto_synced_source_types, sync_attachments, detect_audio_language, transcription_service, include_speaker_labels, split_rows].hash
     end
 
     # Builds the object from hash

data/lib/carbon_ruby_sdk/models/file_sync_config_nullable.rb

@@ -23,6 +23,9 @@ module Carbon
 
     attr_accessor :transcription_service
 
+    # Detect multiple speakers and label segments of speech by speaker for audio files.
+    attr_accessor :include_speaker_labels
+
     # Whether to split tabular rows into chunks. Currently only valid for CSV, TSV, and XLSX files.
     attr_accessor :split_rows
 
@@ -33,6 +36,7 @@ module Carbon
         :'sync_attachments' => :'sync_attachments',
         :'detect_audio_language' => :'detect_audio_language',
         :'transcription_service' => :'transcription_service',
+        :'include_speaker_labels' => :'include_speaker_labels',
         :'split_rows' => :'split_rows'
       }
     end
@@ -49,6 +53,7 @@ module Carbon
         :'sync_attachments' => :'Boolean',
         :'detect_audio_language' => :'Boolean',
         :'transcription_service' => :'TranscriptionServiceNullable',
+        :'include_speaker_labels' => :'Boolean',
         :'split_rows' => :'Boolean'
       }
     end
@@ -97,6 +102,12 @@ module Carbon
         self.transcription_service = attributes[:'transcription_service']
       end
 
+      if attributes.key?(:'include_speaker_labels')
+        self.include_speaker_labels = attributes[:'include_speaker_labels']
+      else
+        self.include_speaker_labels = false
+      end
+
       if attributes.key?(:'split_rows')
         self.split_rows = attributes[:'split_rows']
       else
@@ -126,6 +137,7 @@ module Carbon
           sync_attachments == o.sync_attachments &&
           detect_audio_language == o.detect_audio_language &&
           transcription_service == o.transcription_service &&
+          include_speaker_labels == o.include_speaker_labels &&
           split_rows == o.split_rows
     end
 
@@ -138,7 +150,7 @@ module Carbon
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [auto_synced_source_types, sync_attachments, detect_audio_language, transcription_service, split_rows].hash
+      [auto_synced_source_types, sync_attachments, detect_audio_language, transcription_service, include_speaker_labels, split_rows].hash
     end
 
     # Builds the object from hash

data/lib/carbon_ruby_sdk/models/get_embedding_documents_body.rb

@@ -64,6 +64,9 @@ module Carbon
     # Filter files based on their type at the source (for example help center tickets and articles)
     attr_accessor :file_types_at_source
 
+    # Flag to control whether or not to exclude files that are not in hot storage. If set to False, then an error will be returned if any filtered         files are in cold storage.
+    attr_accessor :exclude_cold_storage_files
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -85,7 +88,8 @@ module Carbon
         :'include_file_level_metadata' => :'include_file_level_metadata',
         :'high_accuracy' => :'high_accuracy',
         :'rerank' => :'rerank',
-        :'file_types_at_source' => :'file_types_at_source'
+        :'file_types_at_source' => :'file_types_at_source',
+        :'exclude_cold_storage_files' => :'exclude_cold_storage_files'
       }
     end
 
@@ -115,7 +119,8 @@ module Carbon
         :'include_file_level_metadata' => :'Boolean',
         :'high_accuracy' => :'Boolean',
         :'rerank' => :'RerankParamsNullable',
-        :'file_types_at_source' => :'Array<HelpdeskFileTypes>'
+        :'file_types_at_source' => :'Array<HelpdeskFileTypes>',
+        :'exclude_cold_storage_files' => :'Boolean'
       }
     end
 
@@ -137,7 +142,7 @@ module Carbon
         :'include_file_level_metadata',
         :'high_accuracy',
         :'rerank',
-        :'file_types_at_source'
+        :'file_types_at_source',
       ])
     end
 
@@ -249,6 +254,12 @@ module Carbon
           self.file_types_at_source = value
         end
       end
+
+      if attributes.key?(:'exclude_cold_storage_files')
+        self.exclude_cold_storage_files = attributes[:'exclude_cold_storage_files']
+      else
+        self.exclude_cold_storage_files = false
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -335,7 +346,8 @@ module Carbon
           include_file_level_metadata == o.include_file_level_metadata &&
           high_accuracy == o.high_accuracy &&
           rerank == o.rerank &&
-          file_types_at_source == o.file_types_at_source
+          file_types_at_source == o.file_types_at_source &&
+          exclude_cold_storage_files == o.exclude_cold_storage_files
     end
 
     # @see the `==` method
@@ -347,7 +359,7 @@ module Carbon
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [tags, query, query_vector, k, file_ids, parent_file_ids, include_all_children, tags_v2, include_tags, include_vectors, include_raw_file, hybrid_search, hybrid_search_tuning_parameters, media_type, embedding_model, include_file_level_metadata, high_accuracy, rerank, file_types_at_source].hash
+      [tags, query, query_vector, k, file_ids, parent_file_ids, include_all_children, tags_v2, include_tags, include_vectors, include_raw_file, hybrid_search, hybrid_search_tuning_parameters, media_type, embedding_model, include_file_level_metadata, high_accuracy, rerank, file_types_at_source, exclude_cold_storage_files].hash
     end
 
     # Builds the object from hash

data/lib/carbon_ruby_sdk/models/modify_cold_storage_parameters_query_input.rb

@@ -0,0 +1,235 @@
+=begin
+#Carbon
+
+#Connect external data to LLMs, no matter the source.
+
+The version of the OpenAPI document: 1.0.0
+=end
+
+require 'date'
+require 'time'
+
+module Carbon
+  class ModifyColdStorageParametersQueryInput
+    attr_accessor :filters
+
+    attr_accessor :enable_cold_storage
+
+    attr_accessor :hot_storage_time_to_live
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'filters' => :'filters',
+        :'enable_cold_storage' => :'enable_cold_storage',
+        :'hot_storage_time_to_live' => :'hot_storage_time_to_live'
+      }
+    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
+      {
+        :'filters' => :'OrganizationUserFilesToSyncFilters',
+        :'enable_cold_storage' => :'Boolean',
+        :'hot_storage_time_to_live' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'enable_cold_storage',
+        :'hot_storage_time_to_live'
+      ])
+    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 `Carbon::ModifyColdStorageParametersQueryInput` 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 `Carbon::ModifyColdStorageParametersQueryInput`. 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?(:'filters')
+        self.filters = attributes[:'filters']
+      end
+
+      if attributes.key?(:'enable_cold_storage')
+        self.enable_cold_storage = attributes[:'enable_cold_storage']
+      end
+
+      if attributes.key?(:'hot_storage_time_to_live')
+        self.hot_storage_time_to_live = attributes[:'hot_storage_time_to_live']
+      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
+      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?
+      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 &&
+          filters == o.filters &&
+          enable_cold_storage == o.enable_cold_storage &&
+          hot_storage_time_to_live == o.hot_storage_time_to_live
+    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
+      [filters, enable_cold_storage, hot_storage_time_to_live].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _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 = Carbon.const_get(type)
+        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