carbon_ruby_sdk 0.2.50 → 0.2.52

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 835371f6fb44f5dd9e26d7a74873c8d84fe16cfc43120194af7fb443fa76c6e7
-  data.tar.gz: 0b7fc9ab32ab52b1f56ac8e23b512182cb192d78593e93a3eadae6a5c609fa05
+  metadata.gz: 54518051d1fd7fb74f26cf78288de54866a637bc84c0b69fc185e614a7f37a1c
+  data.tar.gz: 8c230adc37573d4d7edee995df6460fa34bb657252223a708982259b862596b4
 SHA512:
-  metadata.gz: 64f3998fd7940d7291f2415ffad5e3c8c369bb0e4dff87807956f6c2f3e5f48f51f23d6b9f244b1a8710242bf5c5bdbf6232cecc2682f93128ed941a9a54185f
-  data.tar.gz: 1c56c8a2712ed40ec34b251a95df7d113471a450d5e51e7b021ad22733a74182449d4dae117d9bab6a50f5199b3dde9d57c91af4084df129bdb36b866108ec40
+  metadata.gz: 52ae687b791d0313ab42c1721932e621fa63f75c533d31c7104e102ef3d77aa761ab14acb5fc6e450f3a71fedb5bc8fb7238064d364408d4e780cb3e6e0bb9cd
+  data.tar.gz: 29db65b47781bcc0f1bd4bbe1d399d6a95ed5906d2cdda8e6168cbc5fd2e4958291b9a7dd81fe722a6919e9fca1f8f6cd1c9791ab2c69870b07af376d6af23fe

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    carbon_ruby_sdk (0.2.50)
+    carbon_ruby_sdk (0.2.52)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (~> 1.0, >= 1.0.4)
 
@@ -67,7 +67,7 @@ GEM
       rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.36.1)
+    rubocop-ast (1.36.2)
       parser (>= 3.3.1.0)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)

data/README.md

@@ -6,7 +6,7 @@
 
 Connect external data to LLMs, no matter the source.
 
-[![npm](https://img.shields.io/badge/gem-v0.2.50-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.2.50)
+[![npm](https://img.shields.io/badge/gem-v0.2.52-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.2.52)
 
 </div>
 
@@ -61,6 +61,7 @@ Connect external data to LLMs, no matter the source.
   * [`carbon.github.get_pull_requests`](#carbongithubget_pull_requests)
   * [`carbon.integrations.cancel`](#carbonintegrationscancel)
   * [`carbon.integrations.connect_data_source`](#carbonintegrationsconnect_data_source)
+  * [`carbon.integrations.connect_document360`](#carbonintegrationsconnect_document360)
   * [`carbon.integrations.connect_freshdesk`](#carbonintegrationsconnect_freshdesk)
   * [`carbon.integrations.connect_gitbook`](#carbonintegrationsconnect_gitbook)
   * [`carbon.integrations.connect_guru`](#carbonintegrationsconnect_guru)
@@ -120,7 +121,7 @@ Connect external data to LLMs, no matter the source.
 Add to Gemfile:
 
 ```ruby
-gem 'carbon_ruby_sdk', '~> 0.2.50'
+gem 'carbon_ruby_sdk', '~> 0.2.52'
 ```
 
 ## Getting Started<a id="getting-started"></a>
@@ -2255,6 +2256,82 @@ p result
 ---
 
 
+### `carbon.integrations.connect_document360`<a id="carbonintegrationsconnect_document360"></a>
+
+You will need an access token to connect your Document360 account. To obtain an access token, follow the steps highlighted 
+here https://apidocs.document360.com/apidocs/api-token.
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```ruby
+result = carbon.integrations.connect_document360(
+  account_email: "string_example",
+  access_token: "string_example",
+  tags: {},
+  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,
+  request_id: "string_example",
+  sync_source_items: true,
+  file_sync_config: {
+        "auto_synced_source_types" => ["ARTICLE"],
+        "sync_attachments" => false,
+        "detect_audio_language" => false,
+        "transcription_service" => "assemblyai",
+        "include_speaker_labels" => false,
+        "split_rows" => false,
+        "generate_chunks_only" => false,
+        "store_file_only" => false,
+        "skip_file_processing" => false,
+        "parsed_text_format" => "PLAIN_TEXT",
+    },
+  data_source_tags: {},
+)
+p result
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### account_email: `String`<a id="account_email-string"></a>
+This email will be used to identify your carbon data source. It should have
+access to the Document360 account you wish to connect.
+
+##### access_token: `String`<a id="access_token-string"></a>
+##### tags: `Object`<a id="tags-object"></a>
+##### chunk_size: `Integer`<a id="chunk_size-integer"></a>
+##### chunk_overlap: `Integer`<a id="chunk_overlap-integer"></a>
+##### skip_embedding_generation: `Boolean`<a id="skip_embedding_generation-boolean"></a>
+##### 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>
+##### sync_files_on_connection: `Boolean`<a id="sync_files_on_connection-boolean"></a>
+##### request_id: `String`<a id="request_id-string"></a>
+##### sync_source_items: `Boolean`<a id="sync_source_items-boolean"></a>
+Enabling this flag will fetch all available content from the source to be listed
+via list items endpoint
+
+##### file_sync_config: [`FileSyncConfigNullable`](./lib/carbon_ruby_sdk/models/file_sync_config_nullable.rb)<a id="file_sync_config-filesyncconfignullablelibcarbon_ruby_sdkmodelsfile_sync_config_nullablerb"></a>
+##### data_source_tags: `Object`<a id="data_source_tags-object"></a>
+Tags to be associated with the data source. If the data source already has tags
+set, then an upsert will be performed.
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/integrations/document360` `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.
@@ -2289,6 +2366,7 @@ result = carbon.integrations.connect_freshdesk(
         "generate_chunks_only" => false,
         "store_file_only" => false,
         "skip_file_processing" => false,
+        "parsed_text_format" => "PLAIN_TEXT",
     },
   data_source_tags: {},
 )
@@ -2363,6 +2441,7 @@ result = carbon.integrations.connect_gitbook(
         "generate_chunks_only" => false,
         "store_file_only" => false,
         "skip_file_processing" => false,
+        "parsed_text_format" => "PLAIN_TEXT",
     },
   data_source_tags: {},
 )
@@ -2435,6 +2514,7 @@ result = carbon.integrations.connect_guru(
         "generate_chunks_only" => false,
         "store_file_only" => false,
         "skip_file_processing" => false,
+        "parsed_text_format" => "PLAIN_TEXT",
     },
   data_source_tags: {},
 )
@@ -2579,6 +2659,7 @@ result = carbon.integrations.get_oauth_url(
         "generate_chunks_only" => false,
         "store_file_only" => false,
         "skip_file_processing" => false,
+        "parsed_text_format" => "PLAIN_TEXT",
     },
   automatically_open_file_picker: true,
   gong_account_email: "string_example",
@@ -3011,6 +3092,7 @@ result = carbon.integrations.sync_azure_blob_files(
         "generate_chunks_only" => false,
         "store_file_only" => false,
         "skip_file_processing" => false,
+        "parsed_text_format" => "PLAIN_TEXT",
     },
 )
 p result
@@ -3144,6 +3226,7 @@ result = carbon.integrations.sync_confluence(
         "generate_chunks_only" => false,
         "store_file_only" => false,
         "skip_file_processing" => false,
+        "parsed_text_format" => "PLAIN_TEXT",
     },
 )
 p result
@@ -3254,6 +3337,7 @@ result = carbon.integrations.sync_files(
         "generate_chunks_only" => false,
         "store_file_only" => false,
         "skip_file_processing" => false,
+        "parsed_text_format" => "PLAIN_TEXT",
     },
 )
 p result
@@ -3371,6 +3455,7 @@ result = carbon.integrations.sync_gitbook(
         "generate_chunks_only" => false,
         "store_file_only" => false,
         "skip_file_processing" => false,
+        "parsed_text_format" => "PLAIN_TEXT",
     },
 )
 p result
@@ -3480,6 +3565,7 @@ result = carbon.integrations.sync_gmail(
         "generate_chunks_only" => false,
         "store_file_only" => false,
         "skip_file_processing" => false,
+        "parsed_text_format" => "PLAIN_TEXT",
     },
   incremental_sync: false,
 )
@@ -3604,6 +3690,7 @@ result = carbon.integrations.sync_outlook(
         "generate_chunks_only" => false,
         "store_file_only" => false,
         "skip_file_processing" => false,
+        "parsed_text_format" => "PLAIN_TEXT",
     },
   incremental_sync: false,
 )
@@ -3757,6 +3844,7 @@ result = carbon.integrations.sync_s3_files(
         "generate_chunks_only" => false,
         "store_file_only" => false,
         "skip_file_processing" => false,
+        "parsed_text_format" => "PLAIN_TEXT",
     },
 )
 p result

data/lib/carbon_ruby_sdk/api/integrations_api.rb

@@ -204,6 +204,158 @@ module Carbon
     end
 
 
+    # Document360 Connect
+    #
+    # You will need an access token to connect your Document360 account. To obtain an access token, follow the steps highlighted 
+    # here https://apidocs.document360.com/apidocs/api-token.
+    #
+    # @param account_email [String] This email will be used to identify your carbon data source. It should have access to the Document360 account you wish to connect.
+    # @param access_token [String] 
+    # @param tags [Object] 
+    # @param chunk_size [Integer] 
+    # @param chunk_overlap [Integer] 
+    # @param skip_embedding_generation [Boolean] 
+    # @param embedding_model [EmbeddingGenerators] 
+    # @param generate_sparse_vectors [Boolean] 
+    # @param prepend_filename_to_chunks [Boolean] 
+    # @param sync_files_on_connection [Boolean] 
+    # @param request_id [String] 
+    # @param sync_source_items [Boolean] Enabling this flag will fetch all available content from the source to be listed via list items endpoint
+    # @param file_sync_config [FileSyncConfigNullable] 
+    # @param data_source_tags [Object] Tags to be associated with the data source. If the data source already has tags set, then an upsert will be performed.
+    # @param body [Document360ConnectRequest] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def connect_document360(account_email:, access_token:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: SENTINEL, generate_sparse_vectors: false, prepend_filename_to_chunks: false, sync_files_on_connection: true, request_id: SENTINEL, sync_source_items: true, file_sync_config: SENTINEL, data_source_tags: SENTINEL, extra: {})
+      _body = {}
+      _body[:tags] = tags if tags != SENTINEL
+      _body[:account_email] = account_email if account_email != SENTINEL
+      _body[:access_token] = access_token if access_token != SENTINEL
+      _body[:chunk_size] = chunk_size if chunk_size != SENTINEL
+      _body[:chunk_overlap] = chunk_overlap if chunk_overlap != SENTINEL
+      _body[:skip_embedding_generation] = skip_embedding_generation if skip_embedding_generation != SENTINEL
+      _body[:embedding_model] = embedding_model if embedding_model != SENTINEL
+      _body[:generate_sparse_vectors] = generate_sparse_vectors if generate_sparse_vectors != SENTINEL
+      _body[:prepend_filename_to_chunks] = prepend_filename_to_chunks if prepend_filename_to_chunks != SENTINEL
+      _body[:sync_files_on_connection] = sync_files_on_connection if sync_files_on_connection != SENTINEL
+      _body[:request_id] = request_id if request_id != SENTINEL
+      _body[:sync_source_items] = sync_source_items if sync_source_items != SENTINEL
+      _body[:file_sync_config] = file_sync_config if file_sync_config != SENTINEL
+      _body[:data_source_tags] = data_source_tags if data_source_tags != SENTINEL
+      document360_connect_request = _body
+      api_response = connect_document360_with_http_info_impl(document360_connect_request, extra)
+      api_response.data
+    end
+
+    # Document360 Connect
+    #
+    # You will need an access token to connect your Document360 account. To obtain an access token, follow the steps highlighted 
+    # here https://apidocs.document360.com/apidocs/api-token.
+    #
+    # @param account_email [String] This email will be used to identify your carbon data source. It should have access to the Document360 account you wish to connect.
+    # @param access_token [String] 
+    # @param tags [Object] 
+    # @param chunk_size [Integer] 
+    # @param chunk_overlap [Integer] 
+    # @param skip_embedding_generation [Boolean] 
+    # @param embedding_model [EmbeddingGenerators] 
+    # @param generate_sparse_vectors [Boolean] 
+    # @param prepend_filename_to_chunks [Boolean] 
+    # @param sync_files_on_connection [Boolean] 
+    # @param request_id [String] 
+    # @param sync_source_items [Boolean] Enabling this flag will fetch all available content from the source to be listed via list items endpoint
+    # @param file_sync_config [FileSyncConfigNullable] 
+    # @param data_source_tags [Object] Tags to be associated with the data source. If the data source already has tags set, then an upsert will be performed.
+    # @param body [Document360ConnectRequest] 
+    # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
+    def connect_document360_with_http_info(account_email:, access_token:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: SENTINEL, generate_sparse_vectors: false, prepend_filename_to_chunks: false, sync_files_on_connection: true, request_id: SENTINEL, sync_source_items: true, file_sync_config: SENTINEL, data_source_tags: SENTINEL, extra: {})
+      _body = {}
+      _body[:tags] = tags if tags != SENTINEL
+      _body[:account_email] = account_email if account_email != SENTINEL
+      _body[:access_token] = access_token if access_token != SENTINEL
+      _body[:chunk_size] = chunk_size if chunk_size != SENTINEL
+      _body[:chunk_overlap] = chunk_overlap if chunk_overlap != SENTINEL
+      _body[:skip_embedding_generation] = skip_embedding_generation if skip_embedding_generation != SENTINEL
+      _body[:embedding_model] = embedding_model if embedding_model != SENTINEL
+      _body[:generate_sparse_vectors] = generate_sparse_vectors if generate_sparse_vectors != SENTINEL
+      _body[:prepend_filename_to_chunks] = prepend_filename_to_chunks if prepend_filename_to_chunks != SENTINEL
+      _body[:sync_files_on_connection] = sync_files_on_connection if sync_files_on_connection != SENTINEL
+      _body[:request_id] = request_id if request_id != SENTINEL
+      _body[:sync_source_items] = sync_source_items if sync_source_items != SENTINEL
+      _body[:file_sync_config] = file_sync_config if file_sync_config != SENTINEL
+      _body[:data_source_tags] = data_source_tags if data_source_tags != SENTINEL
+      document360_connect_request = _body
+      connect_document360_with_http_info_impl(document360_connect_request, extra)
+    end
+
+    # Document360 Connect
+    # You will need an access token to connect your Document360 account. To obtain an access token, follow the steps highlighted  here https://apidocs.document360.com/apidocs/api-token.
+    # @param document360_connect_request [Document360ConnectRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [GenericSuccessResponse]
+    private def connect_document360_impl(document360_connect_request, opts = {})
+      data, _status_code, _headers = connect_document360_with_http_info(document360_connect_request, opts)
+      data
+    end
+
+    # Document360 Connect
+    # You will need an access token to connect your Document360 account. To obtain an access token, follow the steps highlighted  here https://apidocs.document360.com/apidocs/api-token.
+    # @param document360_connect_request [Document360ConnectRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [APIResponse] data is GenericSuccessResponse, status code, headers and response
+    private def connect_document360_with_http_info_impl(document360_connect_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IntegrationsApi.connect_document360 ...'
+      end
+      # verify the required parameter 'document360_connect_request' is set
+      if @api_client.config.client_side_validation && document360_connect_request.nil?
+        fail ArgumentError, "Missing the required parameter 'document360_connect_request' when calling IntegrationsApi.connect_document360"
+      end
+      # resource path
+      local_var_path = '/integrations/document360'
+
+      # 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(document360_connect_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GenericSuccessResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['accessToken', 'apiKey', 'customerId']
+
+      new_options = opts.merge(
+        :operation => :"IntegrationsApi.connect_document360",
+        :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_document360\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/data_source_type.rb

@@ -50,6 +50,7 @@ module Carbon
     SLACK = "SLACK".freeze
     GURU = "GURU".freeze
     GONG = "GONG".freeze
+    DOCUMENT360 = "DOCUMENT360".freeze
     JPG = "JPG".freeze
     PNG = "PNG".freeze
     JPEG = "JPEG".freeze
@@ -75,7 +76,7 @@ module Carbon
     MSG = "MSG".freeze
 
     def self.all_vars
-      @all_vars ||= [GOOGLE_CLOUD_STORAGE, GOOGLE_DRIVE, NOTION, NOTION_DATABASE, INTERCOM, DROPBOX, ONEDRIVE, SHAREPOINT, CONFLUENCE, BOX, ZENDESK, ZOTERO, S3, AZURE_BLOB_STORAGE, GMAIL, OUTLOOK, SERVICENOW, TEXT, CSV, TSV, PDF, DOCX, PPTX, XLSX, XLSM, MD, RTF, JSON, HTML, RAW_TEXT, WEB_SCRAPE, RSS_FEED, FRESHDESK, GITBOOK, SALESFORCE, GITHUB, SLACK, GURU, GONG, JPG, PNG, JPEG, MP3, MP2, AAC, WAV, FLAC, PCM, M4_A, OGG, OPUS, MPEG, MPG, MP4, WMV, AVI, MOV, MKV, FLV, WEBM, EML, MSG].freeze
+      @all_vars ||= [GOOGLE_CLOUD_STORAGE, GOOGLE_DRIVE, NOTION, NOTION_DATABASE, INTERCOM, DROPBOX, ONEDRIVE, SHAREPOINT, CONFLUENCE, BOX, ZENDESK, ZOTERO, S3, AZURE_BLOB_STORAGE, GMAIL, OUTLOOK, SERVICENOW, TEXT, CSV, TSV, PDF, DOCX, PPTX, XLSX, XLSM, MD, RTF, JSON, HTML, RAW_TEXT, WEB_SCRAPE, RSS_FEED, FRESHDESK, GITBOOK, SALESFORCE, GITHUB, SLACK, GURU, GONG, DOCUMENT360, JPG, PNG, JPEG, MP3, MP2, AAC, WAV, FLAC, PCM, M4_A, OGG, OPUS, MPEG, MPG, MP4, WMV, AVI, MOV, MKV, FLV, WEBM, EML, MSG].freeze
     end
 
     # Builds the enum from string

data/lib/carbon_ruby_sdk/models/data_source_type_nullable.rb

@@ -50,6 +50,7 @@ module Carbon
     SLACK = "SLACK".freeze
     GURU = "GURU".freeze
     GONG = "GONG".freeze
+    DOCUMENT360 = "DOCUMENT360".freeze
     JPG = "JPG".freeze
     PNG = "PNG".freeze
     JPEG = "JPEG".freeze
@@ -75,7 +76,7 @@ module Carbon
     MSG = "MSG".freeze
 
     def self.all_vars
-      @all_vars ||= [GOOGLE_CLOUD_STORAGE, GOOGLE_DRIVE, NOTION, NOTION_DATABASE, INTERCOM, DROPBOX, ONEDRIVE, SHAREPOINT, CONFLUENCE, BOX, ZENDESK, ZOTERO, S3, AZURE_BLOB_STORAGE, GMAIL, OUTLOOK, SERVICENOW, TEXT, CSV, TSV, PDF, DOCX, PPTX, XLSX, XLSM, MD, RTF, JSON, HTML, RAW_TEXT, WEB_SCRAPE, RSS_FEED, FRESHDESK, GITBOOK, SALESFORCE, GITHUB, SLACK, GURU, GONG, JPG, PNG, JPEG, MP3, MP2, AAC, WAV, FLAC, PCM, M4_A, OGG, OPUS, MPEG, MPG, MP4, WMV, AVI, MOV, MKV, FLV, WEBM, EML, MSG].freeze
+      @all_vars ||= [GOOGLE_CLOUD_STORAGE, GOOGLE_DRIVE, NOTION, NOTION_DATABASE, INTERCOM, DROPBOX, ONEDRIVE, SHAREPOINT, CONFLUENCE, BOX, ZENDESK, ZOTERO, S3, AZURE_BLOB_STORAGE, GMAIL, OUTLOOK, SERVICENOW, TEXT, CSV, TSV, PDF, DOCX, PPTX, XLSX, XLSM, MD, RTF, JSON, HTML, RAW_TEXT, WEB_SCRAPE, RSS_FEED, FRESHDESK, GITBOOK, SALESFORCE, GITHUB, SLACK, GURU, GONG, DOCUMENT360, JPG, PNG, JPEG, MP3, MP2, AAC, WAV, FLAC, PCM, M4_A, OGG, OPUS, MPEG, MPG, MP4, WMV, AVI, MOV, MKV, FLV, WEBM, EML, MSG].freeze
     end
 
     # Builds the enum from string