carbon_ruby_sdk 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf47c03b0e27651aa516a1b57c87c83324e769fb98dd2d983d0bd89c9c7e87d3
-  data.tar.gz: f36807e5b7c143e385e0420641ebf791bef641314eae726214446bcfd6c97a7f
+  metadata.gz: fd7974b2da45db33f2f9b12525479855314a2a4c894ba085df0e7743052b0e85
+  data.tar.gz: 12583c34578f4a0dfe0ea096f471a3d7329305afca38d255bc0f5f1c97f8a6b6
 SHA512:
-  metadata.gz: b3a842c472397b3708a9a5517763cdcb3f6cea3dbcbc5af4c5d7f4648f07dae1e2dcd637ba5cdc3b6d1aa2a100483cdcc091cc27f8e4ffbc5e0fd8b066e92fa8
-  data.tar.gz: fc30a060950f4e7b0e8a30463f5c8529de9edf8e4257ea5e4933b451747e79e1cd375e6b29c34047dd716807a3c804f053863e7a5427d067dfdd09c2ad51b35f
+  metadata.gz: 9be2791c4adac413d756ef78aa17e7ad0851293ad7b5ef6ed6ad530e80e6d5e14e97759028870bc04c16e7f5d15bca0a548b4b9710f1c807740b03aa8aae474d
+  data.tar.gz: 1e139cb78829fe2757e2b629a08146d7b899e7b542f93ca57b4224200cead60ec641a1152b5339eed9e7353015123545d937f4930b8e5b6444dff186d6906739

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    carbon_ruby_sdk (0.1.6)
+    carbon_ruby_sdk (0.1.7)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 

data/README.md

@@ -6,7 +6,7 @@
 
 Connect external data to LLMs, no matter the source.
 
-[![npm](https://img.shields.io/badge/gem-v0.1.6-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.1.6)
+[![npm](https://img.shields.io/badge/gem-v0.1.7-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.1.7)
 
 </div>
 
@@ -38,6 +38,7 @@ Connect external data to LLMs, no matter the source.
   * [`carbon.files.upload_from_url`](#carbonfilesupload_from_url)
   * [`carbon.files.upload_text`](#carbonfilesupload_text)
   * [`carbon.health.check`](#carbonhealthcheck)
+  * [`carbon.integrations.connect_data_source`](#carbonintegrationsconnect_data_source)
   * [`carbon.integrations.connect_freshdesk`](#carbonintegrationsconnect_freshdesk)
   * [`carbon.integrations.connect_gitbook`](#carbonintegrationsconnect_gitbook)
   * [`carbon.integrations.create_aws_iam_user`](#carbonintegrationscreate_aws_iam_user)
@@ -77,7 +78,7 @@ Connect external data to LLMs, no matter the source.
 Add to Gemfile:
 
 ```ruby
-gem 'carbon_ruby_sdk', '~> 0.1.6'
+gem 'carbon_ruby_sdk', '~> 0.1.7'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -1116,6 +1117,49 @@ p result
 ---
 
 
+### `carbon.integrations.connect_data_source`<a id="carbonintegrationsconnect_data_source"></a>
+
+Connect Data Source
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = carbon.integrations.connect_data_source(
+  authentication: {
+        "source" => "GOOGLE_DRIVE",
+        "access_token" => "access_token_example",
+    },
+  sync_options: {
+        "chunk_size" => 1500,
+        "chunk_overlap" => 20,
+        "skip_embedding_generation" => false,
+        "embedding_model" => "OPENAI",
+        "generate_sparse_vectors" => false,
+        "prepend_filename_to_chunks" => false,
+        "sync_files_on_connection" => true,
+        "set_page_as_boundary" => false,
+    },
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### authentication: [`AuthenticationProperty`](./lib/carbon_ruby_sdk/models/authentication_property.rb)<a id="authentication-authenticationpropertylibcarbon_ruby_sdkmodelsauthentication_propertyrb"></a>
+##### sync_options: [`SyncOptions`](./lib/carbon_ruby_sdk/models/sync_options.rb)<a id="sync_options-syncoptionslibcarbon_ruby_sdkmodelssync_optionsrb"></a>
+#### 🔄 Return<a id="🔄-return"></a>
+
+[ConnectDataSourceResponse](./lib/carbon_ruby_sdk/models/connect_data_source_response.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/integrations/connect` `POST`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
 ### `carbon.integrations.connect_freshdesk`<a id="carbonintegrationsconnect_freshdesk"></a>
 
 Refer this article to obtain an API key https://support.freshdesk.com/en/support/solutions/articles/215517.

data/lib/carbon_ruby_sdk/api/integrations_api.rb

@@ -16,6 +16,102 @@ module Carbon
       @api_client = api_client
     end
 
+    # Connect Data Source
+    #
+    # @param authentication [AuthenticationProperty] 
+    # @param sync_options [SyncOptions] 
+    # @param body [ConnectDataSourceInput] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def connect_data_source(authentication:, sync_options: SENTINEL, extra: {})
+      _body = {}
+      _body[:authentication] = authentication if authentication != SENTINEL
+      _body[:sync_options] = sync_options if sync_options != SENTINEL
+      connect_data_source_input = _body
+      api_response = connect_data_source_with_http_info_impl(connect_data_source_input, extra)
+      api_response.data
+    end
+
+    # Connect Data Source
+    #
+    # @param authentication [AuthenticationProperty] 
+    # @param sync_options [SyncOptions] 
+    # @param body [ConnectDataSourceInput] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def connect_data_source_with_http_info(authentication:, sync_options: SENTINEL, extra: {})
+      _body = {}
+      _body[:authentication] = authentication if authentication != SENTINEL
+      _body[:sync_options] = sync_options if sync_options != SENTINEL
+      connect_data_source_input = _body
+      connect_data_source_with_http_info_impl(connect_data_source_input, extra)
+    end
+
+    # Connect Data Source
+    # @param connect_data_source_input [ConnectDataSourceInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [ConnectDataSourceResponse]
+    private def connect_data_source_impl(connect_data_source_input, opts = {})
+      data, _status_code, _headers = connect_data_source_with_http_info(connect_data_source_input, opts)
+      data
+    end
+
+    # Connect Data Source
+    # @param connect_data_source_input [ConnectDataSourceInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [APIResponse] data is ConnectDataSourceResponse, status code, headers and response
+    private def connect_data_source_with_http_info_impl(connect_data_source_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IntegrationsApi.connect_data_source ...'
+      end
+      # verify the required parameter 'connect_data_source_input' is set
+      if @api_client.config.client_side_validation && connect_data_source_input.nil?
+        fail ArgumentError, "Missing the required parameter 'connect_data_source_input' when calling IntegrationsApi.connect_data_source"
+      end
+      # resource path
+      local_var_path = '/integrations/connect'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(connect_data_source_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConnectDataSourceResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['accessToken', 'apiKey', 'customerId']
+
+      new_options = opts.merge(
+        :operation => :"IntegrationsApi.connect_data_source",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers, response = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IntegrationsApi#connect_data_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      APIResponse::new(data, status_code, headers, response)
+    end
+
+
     # Freshdesk Connect
     #
     # Refer this article to obtain an API key https://support.freshdesk.com/en/support/solutions/articles/215517.

data/lib/carbon_ruby_sdk/models/authentication_property.rb

@@ -0,0 +1,436 @@
+=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 AuthenticationProperty
+    attr_accessor :source
+
+    attr_accessor :access_token
+
+    attr_accessor :refresh_token
+
+    attr_accessor :workspace_id
+
+    attr_accessor :tenant_name
+
+    attr_accessor :site_name
+
+    attr_accessor :subdomain
+
+    attr_accessor :access_token_secret
+
+    attr_accessor :username
+
+    attr_accessor :zotero_id
+
+    attr_accessor :organization_name
+
+    attr_accessor :domain
+
+    attr_accessor :api_key
+
+    attr_accessor :access_key
+
+    attr_accessor :access_key_secret
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'source' => :'source',
+        :'access_token' => :'access_token',
+        :'refresh_token' => :'refresh_token',
+        :'workspace_id' => :'workspace_id',
+        :'tenant_name' => :'tenant_name',
+        :'site_name' => :'site_name',
+        :'subdomain' => :'subdomain',
+        :'access_token_secret' => :'access_token_secret',
+        :'username' => :'username',
+        :'zotero_id' => :'zotero_id',
+        :'organization_name' => :'organization_name',
+        :'domain' => :'domain',
+        :'api_key' => :'api_key',
+        :'access_key' => :'access_key',
+        :'access_key_secret' => :'access_key_secret'
+      }
+    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',
+        :'refresh_token' => :'String',
+        :'workspace_id' => :'String',
+        :'tenant_name' => :'String',
+        :'site_name' => :'String',
+        :'subdomain' => :'String',
+        :'access_token_secret' => :'String',
+        :'username' => :'String',
+        :'zotero_id' => :'String',
+        :'organization_name' => :'String',
+        :'domain' => :'String',
+        :'api_key' => :'String',
+        :'access_key' => :'String',
+        :'access_key_secret' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'source',
+        :'refresh_token',
+      ])
+    end
+
+    # List of class defined in anyOf (OpenAPI v3)
+    def self.openapi_any_of
+      [
+      :'ConfluenceAuthentication',
+      :'FreskdeskAuthentication',
+      :'GitbookAuthetication',
+      :'NotionAuthentication',
+      :'OAuthAuthentication',
+      :'S3Authentication',
+      :'SalesforceAuthentication',
+      :'SharepointAuthentication',
+      :'ZendeskAuthentication',
+      :'ZoteroAuthentication'
+      ]
+    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::AuthenticationProperty` 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::AuthenticationProperty`. 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?(:'refresh_token')
+        self.refresh_token = attributes[:'refresh_token']
+      end
+
+      if attributes.key?(:'workspace_id')
+        self.workspace_id = attributes[:'workspace_id']
+      end
+
+      if attributes.key?(:'tenant_name')
+        self.tenant_name = attributes[:'tenant_name']
+      end
+
+      if attributes.key?(:'site_name')
+        self.site_name = attributes[:'site_name']
+      end
+
+      if attributes.key?(:'subdomain')
+        self.subdomain = attributes[:'subdomain']
+      end
+
+      if attributes.key?(:'access_token_secret')
+        self.access_token_secret = attributes[:'access_token_secret']
+      end
+
+      if attributes.key?(:'username')
+        self.username = attributes[:'username']
+      end
+
+      if attributes.key?(:'zotero_id')
+        self.zotero_id = attributes[:'zotero_id']
+      end
+
+      if attributes.key?(:'organization_name')
+        self.organization_name = attributes[:'organization_name']
+      end
+
+      if attributes.key?(:'domain')
+        self.domain = attributes[:'domain']
+      end
+
+      if attributes.key?(:'api_key')
+        self.api_key = attributes[:'api_key']
+      end
+
+      if attributes.key?(:'access_key')
+        self.access_key = attributes[:'access_key']
+      end
+
+      if attributes.key?(:'access_key_secret')
+        self.access_key_secret = attributes[:'access_key_secret']
+      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 @workspace_id.nil?
+        invalid_properties.push('invalid value for "workspace_id", workspace_id cannot be nil.')
+      end
+
+      if @tenant_name.nil?
+        invalid_properties.push('invalid value for "tenant_name", tenant_name cannot be nil.')
+      end
+
+      if @site_name.nil?
+        invalid_properties.push('invalid value for "site_name", site_name cannot be nil.')
+      end
+
+      if @subdomain.nil?
+        invalid_properties.push('invalid value for "subdomain", subdomain cannot be nil.')
+      end
+
+      if @access_token_secret.nil?
+        invalid_properties.push('invalid value for "access_token_secret", access_token_secret cannot be nil.')
+      end
+
+      if @username.nil?
+        invalid_properties.push('invalid value for "username", username cannot be nil.')
+      end
+
+      if @zotero_id.nil?
+        invalid_properties.push('invalid value for "zotero_id", zotero_id cannot be nil.')
+      end
+
+      if @organization_name.nil?
+        invalid_properties.push('invalid value for "organization_name", organization_name cannot be nil.')
+      end
+
+      if @domain.nil?
+        invalid_properties.push('invalid value for "domain", domain cannot be nil.')
+      end
+
+      if @api_key.nil?
+        invalid_properties.push('invalid value for "api_key", api_key cannot be nil.')
+      end
+
+      if @access_key.nil?
+        invalid_properties.push('invalid value for "access_key", access_key cannot be nil.')
+      end
+
+      if @access_key_secret.nil?
+        invalid_properties.push('invalid value for "access_key_secret", access_key_secret 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 @workspace_id.nil?
+      return false if @tenant_name.nil?
+      return false if @site_name.nil?
+      return false if @subdomain.nil?
+      return false if @access_token_secret.nil?
+      return false if @username.nil?
+      return false if @zotero_id.nil?
+      return false if @organization_name.nil?
+      return false if @domain.nil?
+      return false if @api_key.nil?
+      return false if @access_key.nil?
+      return false if @access_key_secret.nil?
+      _any_of_found = false
+      self.class.openapi_any_of.each do |_class|
+        _any_of = Carbon.const_get(_class).build_from_hash(self.to_hash)
+        if _any_of.valid?
+          _any_of_found = true
+        end
+      end
+
+      if !_any_of_found
+        return false
+      end
+
+      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 &&
+          refresh_token == o.refresh_token &&
+          workspace_id == o.workspace_id &&
+          tenant_name == o.tenant_name &&
+          site_name == o.site_name &&
+          subdomain == o.subdomain &&
+          access_token_secret == o.access_token_secret &&
+          username == o.username &&
+          zotero_id == o.zotero_id &&
+          organization_name == o.organization_name &&
+          domain == o.domain &&
+          api_key == o.api_key &&
+          access_key == o.access_key &&
+          access_key_secret == o.access_key_secret
+    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, refresh_token, workspace_id, tenant_name, site_name, subdomain, access_token_secret, username, zotero_id, organization_name, domain, api_key, access_key, access_key_secret].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