carbon_ruby_sdk 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58958795ddfad5666367afc517c5d3f538823c2d6a3b29cfa5a6b5adc7d775bb
-  data.tar.gz: 169f320f74f9c1ab73bf5b6855ff45be3df795a3347fc07a05b291354af2b2fe
+  metadata.gz: fd7974b2da45db33f2f9b12525479855314a2a4c894ba085df0e7743052b0e85
+  data.tar.gz: 12583c34578f4a0dfe0ea096f471a3d7329305afca38d255bc0f5f1c97f8a6b6
 SHA512:
-  metadata.gz: 5fd551a710809c3f5907508f27b5ebbf9a63ec9accedb216f30c26143487d7a2acbd37023ec5eb15a8041fe9b7c479f8aa473870d52cb83070aefd1fba1ee2a8
-  data.tar.gz: fa80b65792aec38897c35061c72dcd9d82740ede5968abc64fc1dfc72771e301846fd7aa7bbcd31fae503fe8e16b5a9f6477a76a549474e9a0efa3b065ac4f63
+  metadata.gz: 9be2791c4adac413d756ef78aa17e7ad0851293ad7b5ef6ed6ad530e80e6d5e14e97759028870bc04c16e7f5d15bca0a548b4b9710f1c807740b03aa8aae474d
+  data.tar.gz: 1e139cb78829fe2757e2b629a08146d7b899e7b542f93ca57b4224200cead60ec641a1152b5339eed9e7353015123545d937f4930b8e5b6444dff186d6906739

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    carbon_ruby_sdk (0.1.5)
+    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.5-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.1.5)
+[![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.5'
+gem 'carbon_ruby_sdk', '~> 0.1.7'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -492,14 +493,13 @@ result = carbon.embeddings.upload_chunks_and_embeddings(
                 {
                     "chunk_number" => 1,
                     "chunk" => "chunk_example",
-                    "embedding" => [
-                        3.14
-                    ],
                 }
             ],
         }
     ],
   overwrite_existing: false,
+  chunks_only: false,
+  custom_credentials: {},
 )
 p result
 ```
@@ -509,6 +509,8 @@ p result
 ##### embedding_model: [`EmbeddingGenerators`](./lib/carbon_ruby_sdk/models/embedding_generators.rb)<a id="embedding_model-embeddinggeneratorslibcarbon_ruby_sdkmodelsembedding_generatorsrb"></a>
 ##### chunks_and_embeddings: Array<[`SingleChunksAndEmbeddingsUploadInput`](./lib/carbon_ruby_sdk/models/single_chunks_and_embeddings_upload_input.rb)><a id="chunks_and_embeddings-array"></a>
 ##### overwrite_existing: `Boolean`<a id="overwrite_existing-boolean"></a>
+##### chunks_only: `Boolean`<a id="chunks_only-boolean"></a>
+##### custom_credentials: `Object`<a id="custom_credentials-object"></a>
 #### 🔄 Return<a id="🔄-return"></a>
 
 [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
@@ -876,6 +878,7 @@ result = carbon.files.resync(
   file_id: 1,
   chunk_size: 1,
   chunk_overlap: 1,
+  force_embedding_generation: false,
 )
 p result
 ```
@@ -885,6 +888,7 @@ p result
 ##### file_id: `Integer`<a id="file_id-integer"></a>
 ##### chunk_size: `Integer`<a id="chunk_size-integer"></a>
 ##### chunk_overlap: `Integer`<a id="chunk_overlap-integer"></a>
+##### force_embedding_generation: `Boolean`<a id="force_embedding_generation-boolean"></a>
 #### 🔄 Return<a id="🔄-return"></a>
 
 [UserFile](./lib/carbon_ruby_sdk/models/user_file.rb)
@@ -1113,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.
@@ -1253,7 +1300,10 @@ p result
 
 ### `carbon.integrations.get_oauth_url`<a id="carbonintegrationsget_oauth_url"></a>
 
-Get Oauth Url
+This endpoint can be used to generate the following URLs
+- An OAuth URL for OAuth based connectors
+- A file syncing URL which skips the OAuth flow if the user already has a valid access token and takes them to the
+success state.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1276,6 +1326,8 @@ result = carbon.integrations.get_oauth_url(
   salesforce_domain: "string_example",
   sync_files_on_connection: true,
   set_page_as_boundary: false,
+  data_source_id: 1,
+  connecting_new_account: false,
 )
 p result
 ```
@@ -1298,7 +1350,25 @@ p result
 ##### max_items_per_chunk: `Integer`<a id="max_items_per_chunk-integer"></a>
 ##### 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
+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
+
 ##### set_page_as_boundary: `Boolean`<a id="set_page_as_boundary-boolean"></a>
+##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
+Used to specify a data source to sync from if you have multiple connected. It
+can be skipped if you only have one data source of that type connected or are
+connecting a new account.
+
+##### connecting_new_account: `Boolean`<a id="connecting_new_account-boolean"></a>
+Used to connect a new data source. If not specified, we will attempt to create a
+sync URL for an existing data source based on type and ID.
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[OuthURLResponse](./lib/carbon_ruby_sdk/models/outh_url_response.rb)
+
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
 
 `/integrations/oauth_url` `POST`
@@ -1389,10 +1459,15 @@ both system folders like "inbox" and user created folders.
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
 ```ruby
-result = carbon.integrations.list_folders
+result = carbon.integrations.list_folders(
+  data_source_id: 1,
+)
 p result
 ```
 
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
 
 `/integrations/outlook/user_folders` `GET`
@@ -1435,10 +1510,15 @@ will have the type "user" and Gmail's default labels will have the type "system"
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
 ```ruby
-result = carbon.integrations.list_labels
+result = carbon.integrations.list_labels(
+  data_source_id: 1,
+)
 p result
 ```
 
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
 
 `/integrations/gmail/user_labels` `GET`
@@ -1456,10 +1536,15 @@ support listing up to 250 categories.
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
 ```ruby
-result = carbon.integrations.list_outlook_categories
+result = carbon.integrations.list_outlook_categories(
+  data_source_id: 1,
+)
 p result
 ```
 
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
 
 `/integrations/outlook/user_categories` `GET`
@@ -1715,6 +1800,7 @@ result = carbon.integrations.sync_gmail(
   embedding_model: "OPENAI",
   generate_sparse_vectors: false,
   prepend_filename_to_chunks: false,
+  data_source_id: 1,
 )
 p result
 ```
@@ -1729,6 +1815,7 @@ p result
 ##### embedding_model: [`EmbeddingGenerators`](./lib/carbon_ruby_sdk/models/embedding_generators.rb)<a id="embedding_model-embeddinggeneratorslibcarbon_ruby_sdkmodelsembedding_generatorsrb"></a>
 ##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
 ##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
+##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
 #### 🔄 Return<a id="🔄-return"></a>
 
 [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
@@ -1818,6 +1905,7 @@ result = carbon.integrations.sync_outlook(
   embedding_model: "OPENAI",
   generate_sparse_vectors: false,
   prepend_filename_to_chunks: false,
+  data_source_id: 1,
 )
 p result
 ```
@@ -1833,6 +1921,7 @@ p result
 ##### embedding_model: [`EmbeddingGenerators`](./lib/carbon_ruby_sdk/models/embedding_generators.rb)<a id="embedding_model-embeddinggeneratorslibcarbon_ruby_sdkmodelsembedding_generatorsrb"></a>
 ##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
 ##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
+##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
 #### 🔄 Return<a id="🔄-return"></a>
 
 [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
@@ -1912,6 +2001,7 @@ result = carbon.integrations.sync_s3_files(
   prepend_filename_to_chunks: false,
   max_items_per_chunk: 1,
   set_page_as_boundary: false,
+  data_source_id: 1,
 )
 p result
 ```
@@ -1928,6 +2018,7 @@ p result
 ##### 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>
 ##### 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>
 
 [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)

data/lib/carbon_ruby_sdk/api/embeddings_api.rb

@@ -465,13 +465,17 @@ module Carbon
     # @param embedding_model [EmbeddingGenerators] 
     # @param chunks_and_embeddings [Array<SingleChunksAndEmbeddingsUploadInput>] 
     # @param overwrite_existing [Boolean] 
+    # @param chunks_only [Boolean] 
+    # @param custom_credentials [Object] 
     # @param body [ChunksAndEmbeddingsUploadInput] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def upload_chunks_and_embeddings(embedding_model:, chunks_and_embeddings:, overwrite_existing: false, extra: {})
+    def upload_chunks_and_embeddings(embedding_model:, chunks_and_embeddings:, overwrite_existing: false, chunks_only: false, custom_credentials: SENTINEL, extra: {})
       _body = {}
       _body[:embedding_model] = embedding_model if embedding_model != SENTINEL
       _body[:chunks_and_embeddings] = chunks_and_embeddings if chunks_and_embeddings != SENTINEL
       _body[:overwrite_existing] = overwrite_existing if overwrite_existing != SENTINEL
+      _body[:chunks_only] = chunks_only if chunks_only != SENTINEL
+      _body[:custom_credentials] = custom_credentials if custom_credentials != SENTINEL
       chunks_and_embeddings_upload_input = _body
       api_response = upload_chunks_and_embeddings_with_http_info_impl(chunks_and_embeddings_upload_input, extra)
       api_response.data
@@ -482,13 +486,17 @@ module Carbon
     # @param embedding_model [EmbeddingGenerators] 
     # @param chunks_and_embeddings [Array<SingleChunksAndEmbeddingsUploadInput>] 
     # @param overwrite_existing [Boolean] 
+    # @param chunks_only [Boolean] 
+    # @param custom_credentials [Object] 
     # @param body [ChunksAndEmbeddingsUploadInput] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def upload_chunks_and_embeddings_with_http_info(embedding_model:, chunks_and_embeddings:, overwrite_existing: false, extra: {})
+    def upload_chunks_and_embeddings_with_http_info(embedding_model:, chunks_and_embeddings:, overwrite_existing: false, chunks_only: false, custom_credentials: SENTINEL, extra: {})
       _body = {}
       _body[:embedding_model] = embedding_model if embedding_model != SENTINEL
       _body[:chunks_and_embeddings] = chunks_and_embeddings if chunks_and_embeddings != SENTINEL
       _body[:overwrite_existing] = overwrite_existing if overwrite_existing != SENTINEL
+      _body[:chunks_only] = chunks_only if chunks_only != SENTINEL
+      _body[:custom_credentials] = custom_credentials if custom_credentials != SENTINEL
       chunks_and_embeddings_upload_input = _body
       upload_chunks_and_embeddings_with_http_info_impl(chunks_and_embeddings_upload_input, extra)
     end

data/lib/carbon_ruby_sdk/api/files_api.rb

@@ -938,13 +938,15 @@ module Carbon
     # @param file_id [Integer] 
     # @param chunk_size [Integer] 
     # @param chunk_overlap [Integer] 
+    # @param force_embedding_generation [Boolean] 
     # @param body [ResyncFileQueryInput] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def resync(file_id:, chunk_size: SENTINEL, chunk_overlap: SENTINEL, extra: {})
+    def resync(file_id:, chunk_size: SENTINEL, chunk_overlap: SENTINEL, force_embedding_generation: false, extra: {})
       _body = {}
       _body[:file_id] = file_id if file_id != SENTINEL
       _body[:chunk_size] = chunk_size if chunk_size != SENTINEL
       _body[:chunk_overlap] = chunk_overlap if chunk_overlap != SENTINEL
+      _body[:force_embedding_generation] = force_embedding_generation if force_embedding_generation != SENTINEL
       resync_file_query_input = _body
       api_response = resync_with_http_info_impl(resync_file_query_input, extra)
       api_response.data
@@ -955,13 +957,15 @@ module Carbon
     # @param file_id [Integer] 
     # @param chunk_size [Integer] 
     # @param chunk_overlap [Integer] 
+    # @param force_embedding_generation [Boolean] 
     # @param body [ResyncFileQueryInput] 
     # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
-    def resync_with_http_info(file_id:, chunk_size: SENTINEL, chunk_overlap: SENTINEL, extra: {})
+    def resync_with_http_info(file_id:, chunk_size: SENTINEL, chunk_overlap: SENTINEL, force_embedding_generation: false, extra: {})
       _body = {}
       _body[:file_id] = file_id if file_id != SENTINEL
       _body[:chunk_size] = chunk_size if chunk_size != SENTINEL
       _body[:chunk_overlap] = chunk_overlap if chunk_overlap != SENTINEL
+      _body[:force_embedding_generation] = force_embedding_generation if force_embedding_generation != SENTINEL
       resync_file_query_input = _body
       resync_with_http_info_impl(resync_file_query_input, extra)
     end