carbon_ruby_sdk 0.1.6 → 0.1.8

data/lib/carbon_ruby_sdk/models/sync_options.rb

@@ -0,0 +1,323 @@
+=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 SyncOptions
+    attr_accessor :tags
+
+    attr_accessor :chunk_size
+
+    attr_accessor :chunk_overlap
+
+    attr_accessor :skip_embedding_generation
+
+    attr_accessor :embedding_model
+
+    attr_accessor :generate_sparse_vectors
+
+    attr_accessor :prepend_filename_to_chunks
+
+    # Number of objects per chunk. For csv, tsv, xlsx, and json files only.
+    attr_accessor :max_items_per_chunk
+
+    # Used to specify whether Carbon should attempt to sync all your files automatically when authorization         is complete. This is only supported for a subset of connectors and will be ignored for the rest. Supported         connectors: Intercom, Zendesk, Gitbook, Confluence, Salesforce, Freshdesk
+    attr_accessor :sync_files_on_connection
+
+    attr_accessor :set_page_as_boundary
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'tags' => :'tags',
+        :'chunk_size' => :'chunk_size',
+        :'chunk_overlap' => :'chunk_overlap',
+        :'skip_embedding_generation' => :'skip_embedding_generation',
+        :'embedding_model' => :'embedding_model',
+        :'generate_sparse_vectors' => :'generate_sparse_vectors',
+        :'prepend_filename_to_chunks' => :'prepend_filename_to_chunks',
+        :'max_items_per_chunk' => :'max_items_per_chunk',
+        :'sync_files_on_connection' => :'sync_files_on_connection',
+        :'set_page_as_boundary' => :'set_page_as_boundary'
+      }
+    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
+      {
+        :'tags' => :'Object',
+        :'chunk_size' => :'Integer',
+        :'chunk_overlap' => :'Integer',
+        :'skip_embedding_generation' => :'Boolean',
+        :'embedding_model' => :'EmbeddingGeneratorsNullable',
+        :'generate_sparse_vectors' => :'Boolean',
+        :'prepend_filename_to_chunks' => :'Boolean',
+        :'max_items_per_chunk' => :'Integer',
+        :'sync_files_on_connection' => :'Boolean',
+        :'set_page_as_boundary' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'tags',
+        :'chunk_size',
+        :'chunk_overlap',
+        :'skip_embedding_generation',
+        :'embedding_model',
+        :'generate_sparse_vectors',
+        :'prepend_filename_to_chunks',
+        :'max_items_per_chunk',
+        :'sync_files_on_connection',
+      ])
+    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::SyncOptions` 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::SyncOptions`. 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?(:'tags')
+        self.tags = attributes[:'tags']
+      end
+
+      if attributes.key?(:'chunk_size')
+        self.chunk_size = attributes[:'chunk_size']
+      else
+        self.chunk_size = 1500
+      end
+
+      if attributes.key?(:'chunk_overlap')
+        self.chunk_overlap = attributes[:'chunk_overlap']
+      else
+        self.chunk_overlap = 20
+      end
+
+      if attributes.key?(:'skip_embedding_generation')
+        self.skip_embedding_generation = attributes[:'skip_embedding_generation']
+      else
+        self.skip_embedding_generation = false
+      end
+
+      if attributes.key?(:'embedding_model')
+        self.embedding_model = attributes[:'embedding_model']
+      else
+        self.embedding_model = 'OPENAI'
+      end
+
+      if attributes.key?(:'generate_sparse_vectors')
+        self.generate_sparse_vectors = attributes[:'generate_sparse_vectors']
+      else
+        self.generate_sparse_vectors = false
+      end
+
+      if attributes.key?(:'prepend_filename_to_chunks')
+        self.prepend_filename_to_chunks = attributes[:'prepend_filename_to_chunks']
+      else
+        self.prepend_filename_to_chunks = false
+      end
+
+      if attributes.key?(:'max_items_per_chunk')
+        self.max_items_per_chunk = attributes[:'max_items_per_chunk']
+      end
+
+      if attributes.key?(:'sync_files_on_connection')
+        self.sync_files_on_connection = attributes[:'sync_files_on_connection']
+      else
+        self.sync_files_on_connection = true
+      end
+
+      if attributes.key?(:'set_page_as_boundary')
+        self.set_page_as_boundary = attributes[:'set_page_as_boundary']
+      else
+        self.set_page_as_boundary = false
+      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 &&
+          tags == o.tags &&
+          chunk_size == o.chunk_size &&
+          chunk_overlap == o.chunk_overlap &&
+          skip_embedding_generation == o.skip_embedding_generation &&
+          embedding_model == o.embedding_model &&
+          generate_sparse_vectors == o.generate_sparse_vectors &&
+          prepend_filename_to_chunks == o.prepend_filename_to_chunks &&
+          max_items_per_chunk == o.max_items_per_chunk &&
+          sync_files_on_connection == o.sync_files_on_connection &&
+          set_page_as_boundary == o.set_page_as_boundary
+    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
+      [tags, chunk_size, chunk_overlap, skip_embedding_generation, embedding_model, generate_sparse_vectors, prepend_filename_to_chunks, max_items_per_chunk, sync_files_on_connection, set_page_as_boundary].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/upload_file_from_url_input.rb

@@ -31,6 +31,7 @@ module Carbon
 
     attr_accessor :prepend_filename_to_chunks
 
+    # Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     attr_accessor :max_items_per_chunk
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/carbon_ruby_sdk/models/webscrape_request.rb

@@ -208,6 +208,14 @@ module Carbon
         invalid_properties.push('invalid value for "url", url cannot be nil.')
       end
 
+      if !@recursion_depth.nil? && @recursion_depth < 0
+        invalid_properties.push('invalid value for "recursion_depth", must be greater than or equal to 0.')
+      end
+
+      if !@max_pages_to_scrape.nil? && @max_pages_to_scrape < 1
+        invalid_properties.push('invalid value for "max_pages_to_scrape", must be greater than or equal to 1.')
+      end
+
       invalid_properties
     end
 
@@ -215,9 +223,31 @@ module Carbon
     # @return true if the model is valid
     def valid?
       return false if @url.nil?
+      return false if !@recursion_depth.nil? && @recursion_depth < 0
+      return false if !@max_pages_to_scrape.nil? && @max_pages_to_scrape < 1
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] recursion_depth Value to be assigned
+    def recursion_depth=(recursion_depth)
+      if !recursion_depth.nil? && recursion_depth < 0
+        fail ArgumentError, 'invalid value for "recursion_depth", must be greater than or equal to 0.'
+      end
+
+      @recursion_depth = recursion_depth
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_pages_to_scrape Value to be assigned
+    def max_pages_to_scrape=(max_pages_to_scrape)
+      if !max_pages_to_scrape.nil? && max_pages_to_scrape < 1
+        fail ArgumentError, 'invalid value for "max_pages_to_scrape", must be greater than or equal to 1.'
+      end
+
+      @max_pages_to_scrape = max_pages_to_scrape
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/carbon_ruby_sdk/models/zendesk_authentication.rb

@@ -0,0 +1,244 @@
+=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 ZendeskAuthentication
+    attr_accessor :source
+
+    attr_accessor :access_token
+
+    attr_accessor :subdomain
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'source' => :'source',
+        :'access_token' => :'access_token',
+        :'subdomain' => :'subdomain'
+      }
+    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
+      {
+        :'source' => :'Object',
+        :'access_token' => :'String',
+        :'subdomain' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'source',
+      ])
+    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::ZendeskAuthentication` 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::ZendeskAuthentication`. 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?(:'source')
+        self.source = attributes[:'source']
+      end
+
+      if attributes.key?(:'access_token')
+        self.access_token = attributes[:'access_token']
+      end
+
+      if attributes.key?(:'subdomain')
+        self.subdomain = attributes[:'subdomain']
+      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
+      if @access_token.nil?
+        invalid_properties.push('invalid value for "access_token", access_token cannot be nil.')
+      end
+
+      if @subdomain.nil?
+        invalid_properties.push('invalid value for "subdomain", subdomain 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?
+      return false if @access_token.nil?
+      return false if @subdomain.nil?
+      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 &&
+          source == o.source &&
+          access_token == o.access_token &&
+          subdomain == o.subdomain
+    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
+      [source, access_token, subdomain].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