carbon_ruby_sdk 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf47c03b0e27651aa516a1b57c87c83324e769fb98dd2d983d0bd89c9c7e87d3
-  data.tar.gz: f36807e5b7c143e385e0420641ebf791bef641314eae726214446bcfd6c97a7f
+  metadata.gz: c209fcd399aa1413a587d8fb3bc56ab173b56052522fdb5aa6f180a5bec9b5d3
+  data.tar.gz: 43aceb3e7bb7ac9dd9ad1a5e16746acc79d90a7de5fd907fbcc26ff3b6f1e2d1
 SHA512:
-  metadata.gz: b3a842c472397b3708a9a5517763cdcb3f6cea3dbcbc5af4c5d7f4648f07dae1e2dcd637ba5cdc3b6d1aa2a100483cdcc091cc27f8e4ffbc5e0fd8b066e92fa8
-  data.tar.gz: fc30a060950f4e7b0e8a30463f5c8529de9edf8e4257ea5e4933b451747e79e1cd375e6b29c34047dd716807a3c804f053863e7a5427d067dfdd09c2ad51b35f
+  metadata.gz: 28401ee97a6b8271954bac68c85cc0bdbc2ff5c75f6489f7d588fde1842745ddde812f9e969f4d7d3b9837af6ff5eaa2e53480e3cba4928bc2d4e2d76131a4fa
+  data.tar.gz: fdc346900eb6f16ecf77464d9d2b08d80b3a22464dec67c218a501f2410685fe578c4870577d62bceb9d7dc918e03c50840135c65dc43c8060f230084c1b20e6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    carbon_ruby_sdk (0.1.6)
+    carbon_ruby_sdk (0.1.8)
       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.8-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.1.8)
 
 </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.8'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -980,7 +981,7 @@ the file to be a candidate for hybrid search.
 Whether or not to prepend the file's name to chunks.
 
 ##### max_items_per_chunk: `Integer`<a id="max_items_per_chunk-integer"></a>
-Number of objects per chunk. For json files only.
+Number of objects per chunk. For csv, tsv, xlsx, and json files only.
 
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -1031,6 +1032,8 @@ p result
 ##### use_textract: `Boolean`<a id="use_textract-boolean"></a>
 ##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
 ##### max_items_per_chunk: `Integer`<a id="max_items_per_chunk-integer"></a>
+Number of objects per chunk. For csv, tsv, xlsx, and json files only.
+
 #### 🔄 Return<a id="🔄-return"></a>
 
 [UserFile](./lib/carbon_ruby_sdk/models/user_file.rb)
@@ -1116,6 +1119,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.
@@ -1304,6 +1350,8 @@ p result
 ##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
 ##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
 ##### max_items_per_chunk: `Integer`<a id="max_items_per_chunk-integer"></a>
+Number of objects per chunk. For csv, tsv, xlsx, and json files only.
+
 ##### salesforce_domain: `String`<a id="salesforce_domain-string"></a>
 ##### sync_files_on_connection: `Boolean`<a id="sync_files_on_connection-boolean"></a>
 Used to specify whether Carbon should attempt to sync all your files
@@ -1550,6 +1598,8 @@ p result
 ##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
 ##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
 ##### max_items_per_chunk: `Integer`<a id="max_items_per_chunk-integer"></a>
+Number of objects per chunk. For csv, tsv, xlsx, and json files only.
+
 ##### set_page_as_boundary: `Boolean`<a id="set_page_as_boundary-boolean"></a>
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -1633,6 +1683,8 @@ p result
 ##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
 ##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
 ##### max_items_per_chunk: `Integer`<a id="max_items_per_chunk-integer"></a>
+Number of objects per chunk. For csv, tsv, xlsx, and json files only.
+
 ##### set_page_as_boundary: `Boolean`<a id="set_page_as_boundary-boolean"></a>
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -1973,6 +2025,8 @@ p result
 ##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
 ##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
 ##### max_items_per_chunk: `Integer`<a id="max_items_per_chunk-integer"></a>
+Number of objects per chunk. For csv, tsv, xlsx, and json files only.
+
 ##### set_page_as_boundary: `Boolean`<a id="set_page_as_boundary-boolean"></a>
 ##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
 #### 🔄 Return<a id="🔄-return"></a>

data/lib/carbon_ruby_sdk/api/files_api.rb

@@ -1074,7 +1074,7 @@ module Carbon
     # @param use_ocr [Boolean] Whether or not to use OCR when processing files. Only valid for PDFs. Useful for documents with tables, images, and/or scanned text.
     # @param generate_sparse_vectors [Boolean] Whether or not to generate sparse vectors for the file. This is *required* for the file to be a candidate for hybrid search.
     # @param prepend_filename_to_chunks [Boolean] Whether or not to prepend the file's name to chunks.
-    # @param max_items_per_chunk [Integer] Number of objects per chunk. For json files only.
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param body [BodyCreateUploadFileUploadfilePost] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def upload(file:, chunk_size: SENTINEL, chunk_overlap: SENTINEL, skip_embedding_generation: false, set_page_as_boundary: false, embedding_model: SENTINEL, use_ocr: false, generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, extra: {})
@@ -1131,7 +1131,7 @@ module Carbon
     # @param use_ocr [Boolean] Whether or not to use OCR when processing files. Only valid for PDFs. Useful for documents with tables, images, and/or scanned text.
     # @param generate_sparse_vectors [Boolean] Whether or not to generate sparse vectors for the file. This is *required* for the file to be a candidate for hybrid search.
     # @param prepend_filename_to_chunks [Boolean] Whether or not to prepend the file's name to chunks.
-    # @param max_items_per_chunk [Integer] Number of objects per chunk. For json files only.
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param body [BodyCreateUploadFileUploadfilePost] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def upload_with_http_info(file:, chunk_size: SENTINEL, chunk_overlap: SENTINEL, skip_embedding_generation: false, set_page_as_boundary: false, embedding_model: SENTINEL, use_ocr: false, generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, extra: {})
@@ -1163,7 +1163,7 @@ module Carbon
     # @option opts [Boolean] :use_ocr Whether or not to use OCR when processing files. Only valid for PDFs. Useful for documents with             tables, images, and/or scanned text. (default to false)
     # @option opts [Boolean] :generate_sparse_vectors Whether or not to generate sparse vectors for the file. This is *required* for the file to be a             candidate for hybrid search. (default to false)
     # @option opts [Boolean] :prepend_filename_to_chunks Whether or not to prepend the file's name to chunks. (default to false)
-    # @option opts [Integer] :max_items_per_chunk Number of objects per chunk. For json files only.
+    # @option opts [Integer] :max_items_per_chunk Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @return [UserFile]
     private def upload_impl(file, body_create_upload_file_uploadfile_post, opts = {})
       data, _status_code, _headers = upload_with_http_info(file, body_create_upload_file_uploadfile_post, opts)
@@ -1183,7 +1183,7 @@ module Carbon
     # @option opts [Boolean] :use_ocr Whether or not to use OCR when processing files. Only valid for PDFs. Useful for documents with             tables, images, and/or scanned text. (default to false)
     # @option opts [Boolean] :generate_sparse_vectors Whether or not to generate sparse vectors for the file. This is *required* for the file to be a             candidate for hybrid search. (default to false)
     # @option opts [Boolean] :prepend_filename_to_chunks Whether or not to prepend the file's name to chunks. (default to false)
-    # @option opts [Integer] :max_items_per_chunk Number of objects per chunk. For json files only.
+    # @option opts [Integer] :max_items_per_chunk Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @return [APIResponse] data is UserFile, status code, headers and response
     private def upload_with_http_info_impl(file, body_create_upload_file_uploadfile_post, opts = {})
       if @api_client.config.debugging
@@ -1265,7 +1265,7 @@ module Carbon
     # @param generate_sparse_vectors [Boolean] 
     # @param use_textract [Boolean] 
     # @param prepend_filename_to_chunks [Boolean] 
-    # @param max_items_per_chunk [Integer] 
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param body [UploadFileFromUrlInput] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def upload_from_url(url:, file_name: SENTINEL, chunk_size: SENTINEL, chunk_overlap: SENTINEL, skip_embedding_generation: false, set_page_as_boundary: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, use_textract: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, extra: {})
@@ -1298,7 +1298,7 @@ module Carbon
     # @param generate_sparse_vectors [Boolean] 
     # @param use_textract [Boolean] 
     # @param prepend_filename_to_chunks [Boolean] 
-    # @param max_items_per_chunk [Integer] 
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param body [UploadFileFromUrlInput] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
     def upload_from_url_with_http_info(url:, file_name: SENTINEL, chunk_size: SENTINEL, chunk_overlap: SENTINEL, skip_embedding_generation: false, set_page_as_boundary: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, use_textract: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, extra: {})

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.
@@ -432,7 +528,7 @@ module Carbon
     # @param confluence_subdomain [String] 
     # @param generate_sparse_vectors [Boolean] 
     # @param prepend_filename_to_chunks [Boolean] 
-    # @param max_items_per_chunk [Integer] 
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param salesforce_domain [String] 
     # @param sync_files_on_connection [Boolean] 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
     # @param set_page_as_boundary [Boolean] 
@@ -486,7 +582,7 @@ module Carbon
     # @param confluence_subdomain [String] 
     # @param generate_sparse_vectors [Boolean] 
     # @param prepend_filename_to_chunks [Boolean] 
-    # @param max_items_per_chunk [Integer] 
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param salesforce_domain [String] 
     # @param sync_files_on_connection [Boolean] 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
     # @param set_page_as_boundary [Boolean] 
@@ -1162,7 +1258,7 @@ module Carbon
     # @param embedding_model [EmbeddingGeneratorsNullable] 
     # @param generate_sparse_vectors [Boolean] 
     # @param prepend_filename_to_chunks [Boolean] 
-    # @param max_items_per_chunk [Integer] 
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param set_page_as_boundary [Boolean] 
     # @param body [SyncFilesRequest] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -1200,7 +1296,7 @@ module Carbon
     # @param embedding_model [EmbeddingGeneratorsNullable] 
     # @param generate_sparse_vectors [Boolean] 
     # @param prepend_filename_to_chunks [Boolean] 
-    # @param max_items_per_chunk [Integer] 
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param set_page_as_boundary [Boolean] 
     # @param body [SyncFilesRequest] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -1398,7 +1494,7 @@ module Carbon
     # @param embedding_model [EmbeddingGeneratorsNullable] 
     # @param generate_sparse_vectors [Boolean] 
     # @param prepend_filename_to_chunks [Boolean] 
-    # @param max_items_per_chunk [Integer] 
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param set_page_as_boundary [Boolean] 
     # @param body [SyncFilesRequest] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -1436,7 +1532,7 @@ module Carbon
     # @param embedding_model [EmbeddingGeneratorsNullable] 
     # @param generate_sparse_vectors [Boolean] 
     # @param prepend_filename_to_chunks [Boolean] 
-    # @param max_items_per_chunk [Integer] 
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param set_page_as_boundary [Boolean] 
     # @param body [SyncFilesRequest] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -2272,7 +2368,7 @@ module Carbon
     # @param embedding_model [EmbeddingGenerators] 
     # @param generate_sparse_vectors [Boolean] 
     # @param prepend_filename_to_chunks [Boolean] 
-    # @param max_items_per_chunk [Integer] 
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param set_page_as_boundary [Boolean] 
     # @param data_source_id [Integer] 
     # @param body [S3FileSyncInput] 
@@ -2309,7 +2405,7 @@ module Carbon
     # @param embedding_model [EmbeddingGenerators] 
     # @param generate_sparse_vectors [Boolean] 
     # @param prepend_filename_to_chunks [Boolean] 
-    # @param max_items_per_chunk [Integer] 
+    # @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
     # @param set_page_as_boundary [Boolean] 
     # @param data_source_id [Integer] 
     # @param body [S3FileSyncInput]