carbon_ruby_sdk 0.1.5 → 0.1.6

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 58958795ddfad5666367afc517c5d3f538823c2d6a3b29cfa5a6b5adc7d775bb
4
- data.tar.gz: 169f320f74f9c1ab73bf5b6855ff45be3df795a3347fc07a05b291354af2b2fe
3
+ metadata.gz: bf47c03b0e27651aa516a1b57c87c83324e769fb98dd2d983d0bd89c9c7e87d3
4
+ data.tar.gz: f36807e5b7c143e385e0420641ebf791bef641314eae726214446bcfd6c97a7f
5
5
  SHA512:
6
- metadata.gz: 5fd551a710809c3f5907508f27b5ebbf9a63ec9accedb216f30c26143487d7a2acbd37023ec5eb15a8041fe9b7c479f8aa473870d52cb83070aefd1fba1ee2a8
7
- data.tar.gz: fa80b65792aec38897c35061c72dcd9d82740ede5968abc64fc1dfc72771e301846fd7aa7bbcd31fae503fe8e16b5a9f6477a76a549474e9a0efa3b065ac4f63
6
+ metadata.gz: b3a842c472397b3708a9a5517763cdcb3f6cea3dbcbc5af4c5d7f4648f07dae1e2dcd637ba5cdc3b6d1aa2a100483cdcc091cc27f8e4ffbc5e0fd8b066e92fa8
7
+ data.tar.gz: fc30a060950f4e7b0e8a30463f5c8529de9edf8e4257ea5e4933b451747e79e1cd375e6b29c34047dd716807a3c804f053863e7a5427d067dfdd09c2ad51b35f
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- carbon_ruby_sdk (0.1.5)
4
+ carbon_ruby_sdk (0.1.6)
5
5
  faraday (>= 1.0.1, < 3.0)
6
6
  faraday-multipart (~> 1.0, >= 1.0.4)
7
7
 
data/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  Connect external data to LLMs, no matter the source.
8
8
 
9
- [![npm](https://img.shields.io/badge/gem-v0.1.5-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.1.5)
9
+ [![npm](https://img.shields.io/badge/gem-v0.1.6-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.1.6)
10
10
 
11
11
  </div>
12
12
 
@@ -77,7 +77,7 @@ Connect external data to LLMs, no matter the source.
77
77
  Add to Gemfile:
78
78
 
79
79
  ```ruby
80
- gem 'carbon_ruby_sdk', '~> 0.1.5'
80
+ gem 'carbon_ruby_sdk', '~> 0.1.6'
81
81
  ```
82
82
 
83
83
  ## Getting Started<a id="getting-started"></a>
@@ -492,14 +492,13 @@ result = carbon.embeddings.upload_chunks_and_embeddings(
492
492
  {
493
493
  "chunk_number" => 1,
494
494
  "chunk" => "chunk_example",
495
- "embedding" => [
496
- 3.14
497
- ],
498
495
  }
499
496
  ],
500
497
  }
501
498
  ],
502
499
  overwrite_existing: false,
500
+ chunks_only: false,
501
+ custom_credentials: {},
503
502
  )
504
503
  p result
505
504
  ```
@@ -509,6 +508,8 @@ p result
509
508
  ##### embedding_model: [`EmbeddingGenerators`](./lib/carbon_ruby_sdk/models/embedding_generators.rb)<a id="embedding_model-embeddinggeneratorslibcarbon_ruby_sdkmodelsembedding_generatorsrb"></a>
510
509
  ##### chunks_and_embeddings: Array<[`SingleChunksAndEmbeddingsUploadInput`](./lib/carbon_ruby_sdk/models/single_chunks_and_embeddings_upload_input.rb)><a id="chunks_and_embeddings-array"></a>
511
510
  ##### overwrite_existing: `Boolean`<a id="overwrite_existing-boolean"></a>
511
+ ##### chunks_only: `Boolean`<a id="chunks_only-boolean"></a>
512
+ ##### custom_credentials: `Object`<a id="custom_credentials-object"></a>
512
513
  #### 🔄 Return<a id="🔄-return"></a>
513
514
 
514
515
  [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
@@ -876,6 +877,7 @@ result = carbon.files.resync(
876
877
  file_id: 1,
877
878
  chunk_size: 1,
878
879
  chunk_overlap: 1,
880
+ force_embedding_generation: false,
879
881
  )
880
882
  p result
881
883
  ```
@@ -885,6 +887,7 @@ p result
885
887
  ##### file_id: `Integer`<a id="file_id-integer"></a>
886
888
  ##### chunk_size: `Integer`<a id="chunk_size-integer"></a>
887
889
  ##### chunk_overlap: `Integer`<a id="chunk_overlap-integer"></a>
890
+ ##### force_embedding_generation: `Boolean`<a id="force_embedding_generation-boolean"></a>
888
891
  #### 🔄 Return<a id="🔄-return"></a>
889
892
 
890
893
  [UserFile](./lib/carbon_ruby_sdk/models/user_file.rb)
@@ -1253,7 +1256,10 @@ p result
1253
1256
 
1254
1257
  ### `carbon.integrations.get_oauth_url`<a id="carbonintegrationsget_oauth_url"></a>
1255
1258
 
1256
- Get Oauth Url
1259
+ This endpoint can be used to generate the following URLs
1260
+ - An OAuth URL for OAuth based connectors
1261
+ - A file syncing URL which skips the OAuth flow if the user already has a valid access token and takes them to the
1262
+ success state.
1257
1263
 
1258
1264
  #### 🛠️ Usage<a id="🛠️-usage"></a>
1259
1265
 
@@ -1276,6 +1282,8 @@ result = carbon.integrations.get_oauth_url(
1276
1282
  salesforce_domain: "string_example",
1277
1283
  sync_files_on_connection: true,
1278
1284
  set_page_as_boundary: false,
1285
+ data_source_id: 1,
1286
+ connecting_new_account: false,
1279
1287
  )
1280
1288
  p result
1281
1289
  ```
@@ -1298,7 +1306,25 @@ p result
1298
1306
  ##### max_items_per_chunk: `Integer`<a id="max_items_per_chunk-integer"></a>
1299
1307
  ##### salesforce_domain: `String`<a id="salesforce_domain-string"></a>
1300
1308
  ##### sync_files_on_connection: `Boolean`<a id="sync_files_on_connection-boolean"></a>
1309
+ Used to specify whether Carbon should attempt to sync all your files
1310
+ automatically when authorization is complete. This is only supported for a
1311
+ subset of connectors and will be ignored for the rest. Supported connectors:
1312
+ Intercom, Zendesk, Gitbook, Confluence, Salesforce, Freshdesk
1313
+
1301
1314
  ##### set_page_as_boundary: `Boolean`<a id="set_page_as_boundary-boolean"></a>
1315
+ ##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
1316
+ Used to specify a data source to sync from if you have multiple connected. It
1317
+ can be skipped if you only have one data source of that type connected or are
1318
+ connecting a new account.
1319
+
1320
+ ##### connecting_new_account: `Boolean`<a id="connecting_new_account-boolean"></a>
1321
+ Used to connect a new data source. If not specified, we will attempt to create a
1322
+ sync URL for an existing data source based on type and ID.
1323
+
1324
+ #### 🔄 Return<a id="🔄-return"></a>
1325
+
1326
+ [OuthURLResponse](./lib/carbon_ruby_sdk/models/outh_url_response.rb)
1327
+
1302
1328
  #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1303
1329
 
1304
1330
  `/integrations/oauth_url` `POST`
@@ -1389,10 +1415,15 @@ both system folders like "inbox" and user created folders.
1389
1415
  #### 🛠️ Usage<a id="🛠️-usage"></a>
1390
1416
 
1391
1417
  ```ruby
1392
- result = carbon.integrations.list_folders
1418
+ result = carbon.integrations.list_folders(
1419
+ data_source_id: 1,
1420
+ )
1393
1421
  p result
1394
1422
  ```
1395
1423
 
1424
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1425
+
1426
+ ##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
1396
1427
  #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1397
1428
 
1398
1429
  `/integrations/outlook/user_folders` `GET`
@@ -1435,10 +1466,15 @@ will have the type "user" and Gmail's default labels will have the type "system"
1435
1466
  #### 🛠️ Usage<a id="🛠️-usage"></a>
1436
1467
 
1437
1468
  ```ruby
1438
- result = carbon.integrations.list_labels
1469
+ result = carbon.integrations.list_labels(
1470
+ data_source_id: 1,
1471
+ )
1439
1472
  p result
1440
1473
  ```
1441
1474
 
1475
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1476
+
1477
+ ##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
1442
1478
  #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1443
1479
 
1444
1480
  `/integrations/gmail/user_labels` `GET`
@@ -1456,10 +1492,15 @@ support listing up to 250 categories.
1456
1492
  #### 🛠️ Usage<a id="🛠️-usage"></a>
1457
1493
 
1458
1494
  ```ruby
1459
- result = carbon.integrations.list_outlook_categories
1495
+ result = carbon.integrations.list_outlook_categories(
1496
+ data_source_id: 1,
1497
+ )
1460
1498
  p result
1461
1499
  ```
1462
1500
 
1501
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1502
+
1503
+ ##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
1463
1504
  #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1464
1505
 
1465
1506
  `/integrations/outlook/user_categories` `GET`
@@ -1715,6 +1756,7 @@ result = carbon.integrations.sync_gmail(
1715
1756
  embedding_model: "OPENAI",
1716
1757
  generate_sparse_vectors: false,
1717
1758
  prepend_filename_to_chunks: false,
1759
+ data_source_id: 1,
1718
1760
  )
1719
1761
  p result
1720
1762
  ```
@@ -1729,6 +1771,7 @@ p result
1729
1771
  ##### embedding_model: [`EmbeddingGenerators`](./lib/carbon_ruby_sdk/models/embedding_generators.rb)<a id="embedding_model-embeddinggeneratorslibcarbon_ruby_sdkmodelsembedding_generatorsrb"></a>
1730
1772
  ##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
1731
1773
  ##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
1774
+ ##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
1732
1775
  #### 🔄 Return<a id="🔄-return"></a>
1733
1776
 
1734
1777
  [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
@@ -1818,6 +1861,7 @@ result = carbon.integrations.sync_outlook(
1818
1861
  embedding_model: "OPENAI",
1819
1862
  generate_sparse_vectors: false,
1820
1863
  prepend_filename_to_chunks: false,
1864
+ data_source_id: 1,
1821
1865
  )
1822
1866
  p result
1823
1867
  ```
@@ -1833,6 +1877,7 @@ p result
1833
1877
  ##### embedding_model: [`EmbeddingGenerators`](./lib/carbon_ruby_sdk/models/embedding_generators.rb)<a id="embedding_model-embeddinggeneratorslibcarbon_ruby_sdkmodelsembedding_generatorsrb"></a>
1834
1878
  ##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
1835
1879
  ##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
1880
+ ##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
1836
1881
  #### 🔄 Return<a id="🔄-return"></a>
1837
1882
 
1838
1883
  [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
@@ -1912,6 +1957,7 @@ result = carbon.integrations.sync_s3_files(
1912
1957
  prepend_filename_to_chunks: false,
1913
1958
  max_items_per_chunk: 1,
1914
1959
  set_page_as_boundary: false,
1960
+ data_source_id: 1,
1915
1961
  )
1916
1962
  p result
1917
1963
  ```
@@ -1928,6 +1974,7 @@ p result
1928
1974
  ##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
1929
1975
  ##### max_items_per_chunk: `Integer`<a id="max_items_per_chunk-integer"></a>
1930
1976
  ##### set_page_as_boundary: `Boolean`<a id="set_page_as_boundary-boolean"></a>
1977
+ ##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
1931
1978
  #### 🔄 Return<a id="🔄-return"></a>
1932
1979
 
1933
1980
  [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
@@ -465,13 +465,17 @@ module Carbon
465
465
  # @param embedding_model [EmbeddingGenerators]
466
466
  # @param chunks_and_embeddings [Array<SingleChunksAndEmbeddingsUploadInput>]
467
467
  # @param overwrite_existing [Boolean]
468
+ # @param chunks_only [Boolean]
469
+ # @param custom_credentials [Object]
468
470
  # @param body [ChunksAndEmbeddingsUploadInput]
469
471
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
470
- def upload_chunks_and_embeddings(embedding_model:, chunks_and_embeddings:, overwrite_existing: false, extra: {})
472
+ def upload_chunks_and_embeddings(embedding_model:, chunks_and_embeddings:, overwrite_existing: false, chunks_only: false, custom_credentials: SENTINEL, extra: {})
471
473
  _body = {}
472
474
  _body[:embedding_model] = embedding_model if embedding_model != SENTINEL
473
475
  _body[:chunks_and_embeddings] = chunks_and_embeddings if chunks_and_embeddings != SENTINEL
474
476
  _body[:overwrite_existing] = overwrite_existing if overwrite_existing != SENTINEL
477
+ _body[:chunks_only] = chunks_only if chunks_only != SENTINEL
478
+ _body[:custom_credentials] = custom_credentials if custom_credentials != SENTINEL
475
479
  chunks_and_embeddings_upload_input = _body
476
480
  api_response = upload_chunks_and_embeddings_with_http_info_impl(chunks_and_embeddings_upload_input, extra)
477
481
  api_response.data
@@ -482,13 +486,17 @@ module Carbon
482
486
  # @param embedding_model [EmbeddingGenerators]
483
487
  # @param chunks_and_embeddings [Array<SingleChunksAndEmbeddingsUploadInput>]
484
488
  # @param overwrite_existing [Boolean]
489
+ # @param chunks_only [Boolean]
490
+ # @param custom_credentials [Object]
485
491
  # @param body [ChunksAndEmbeddingsUploadInput]
486
492
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
487
- def upload_chunks_and_embeddings_with_http_info(embedding_model:, chunks_and_embeddings:, overwrite_existing: false, extra: {})
493
+ def upload_chunks_and_embeddings_with_http_info(embedding_model:, chunks_and_embeddings:, overwrite_existing: false, chunks_only: false, custom_credentials: SENTINEL, extra: {})
488
494
  _body = {}
489
495
  _body[:embedding_model] = embedding_model if embedding_model != SENTINEL
490
496
  _body[:chunks_and_embeddings] = chunks_and_embeddings if chunks_and_embeddings != SENTINEL
491
497
  _body[:overwrite_existing] = overwrite_existing if overwrite_existing != SENTINEL
498
+ _body[:chunks_only] = chunks_only if chunks_only != SENTINEL
499
+ _body[:custom_credentials] = custom_credentials if custom_credentials != SENTINEL
492
500
  chunks_and_embeddings_upload_input = _body
493
501
  upload_chunks_and_embeddings_with_http_info_impl(chunks_and_embeddings_upload_input, extra)
494
502
  end
@@ -938,13 +938,15 @@ module Carbon
938
938
  # @param file_id [Integer]
939
939
  # @param chunk_size [Integer]
940
940
  # @param chunk_overlap [Integer]
941
+ # @param force_embedding_generation [Boolean]
941
942
  # @param body [ResyncFileQueryInput]
942
943
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
943
- def resync(file_id:, chunk_size: SENTINEL, chunk_overlap: SENTINEL, extra: {})
944
+ def resync(file_id:, chunk_size: SENTINEL, chunk_overlap: SENTINEL, force_embedding_generation: false, extra: {})
944
945
  _body = {}
945
946
  _body[:file_id] = file_id if file_id != SENTINEL
946
947
  _body[:chunk_size] = chunk_size if chunk_size != SENTINEL
947
948
  _body[:chunk_overlap] = chunk_overlap if chunk_overlap != SENTINEL
949
+ _body[:force_embedding_generation] = force_embedding_generation if force_embedding_generation != SENTINEL
948
950
  resync_file_query_input = _body
949
951
  api_response = resync_with_http_info_impl(resync_file_query_input, extra)
950
952
  api_response.data
@@ -955,13 +957,15 @@ module Carbon
955
957
  # @param file_id [Integer]
956
958
  # @param chunk_size [Integer]
957
959
  # @param chunk_overlap [Integer]
960
+ # @param force_embedding_generation [Boolean]
958
961
  # @param body [ResyncFileQueryInput]
959
962
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
960
- def resync_with_http_info(file_id:, chunk_size: SENTINEL, chunk_overlap: SENTINEL, extra: {})
963
+ def resync_with_http_info(file_id:, chunk_size: SENTINEL, chunk_overlap: SENTINEL, force_embedding_generation: false, extra: {})
961
964
  _body = {}
962
965
  _body[:file_id] = file_id if file_id != SENTINEL
963
966
  _body[:chunk_size] = chunk_size if chunk_size != SENTINEL
964
967
  _body[:chunk_overlap] = chunk_overlap if chunk_overlap != SENTINEL
968
+ _body[:force_embedding_generation] = force_embedding_generation if force_embedding_generation != SENTINEL
965
969
  resync_file_query_input = _body
966
970
  resync_with_http_info_impl(resync_file_query_input, extra)
967
971
  end
@@ -414,6 +414,11 @@ module Carbon
414
414
 
415
415
  # Get Oauth Url
416
416
  #
417
+ # This endpoint can be used to generate the following URLs
418
+ # - An OAuth URL for OAuth based connectors
419
+ # - A file syncing URL which skips the OAuth flow if the user already has a valid access token and takes them to the
420
+ # success state.
421
+ #
417
422
  # @param service [DataSourceType]
418
423
  # @param tags [Object]
419
424
  # @param scope [String]
@@ -429,11 +434,13 @@ module Carbon
429
434
  # @param prepend_filename_to_chunks [Boolean]
430
435
  # @param max_items_per_chunk [Integer]
431
436
  # @param salesforce_domain [String]
432
- # @param sync_files_on_connection [Boolean]
437
+ # @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
433
438
  # @param set_page_as_boundary [Boolean]
439
+ # @param data_source_id [Integer] 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.
440
+ # @param connecting_new_account [Boolean] 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.
434
441
  # @param body [OAuthURLRequest]
435
442
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
436
- def get_oauth_url(service:, tags: SENTINEL, scope: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', zendesk_subdomain: SENTINEL, microsoft_tenant: SENTINEL, sharepoint_site_name: SENTINEL, confluence_subdomain: SENTINEL, generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, salesforce_domain: SENTINEL, sync_files_on_connection: true, set_page_as_boundary: false, extra: {})
443
+ def get_oauth_url(service:, tags: SENTINEL, scope: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', zendesk_subdomain: SENTINEL, microsoft_tenant: SENTINEL, sharepoint_site_name: SENTINEL, confluence_subdomain: SENTINEL, generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, salesforce_domain: SENTINEL, sync_files_on_connection: true, set_page_as_boundary: false, data_source_id: SENTINEL, connecting_new_account: false, extra: {})
437
444
  _body = {}
438
445
  _body[:tags] = tags if tags != SENTINEL
439
446
  _body[:scope] = scope if scope != SENTINEL
@@ -452,6 +459,8 @@ module Carbon
452
459
  _body[:salesforce_domain] = salesforce_domain if salesforce_domain != SENTINEL
453
460
  _body[:sync_files_on_connection] = sync_files_on_connection if sync_files_on_connection != SENTINEL
454
461
  _body[:set_page_as_boundary] = set_page_as_boundary if set_page_as_boundary != SENTINEL
462
+ _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
463
+ _body[:connecting_new_account] = connecting_new_account if connecting_new_account != SENTINEL
455
464
  o_auth_url_request = _body
456
465
  api_response = get_oauth_url_with_http_info_impl(o_auth_url_request, extra)
457
466
  api_response.data
@@ -459,6 +468,11 @@ module Carbon
459
468
 
460
469
  # Get Oauth Url
461
470
  #
471
+ # This endpoint can be used to generate the following URLs
472
+ # - An OAuth URL for OAuth based connectors
473
+ # - A file syncing URL which skips the OAuth flow if the user already has a valid access token and takes them to the
474
+ # success state.
475
+ #
462
476
  # @param service [DataSourceType]
463
477
  # @param tags [Object]
464
478
  # @param scope [String]
@@ -474,11 +488,13 @@ module Carbon
474
488
  # @param prepend_filename_to_chunks [Boolean]
475
489
  # @param max_items_per_chunk [Integer]
476
490
  # @param salesforce_domain [String]
477
- # @param sync_files_on_connection [Boolean]
491
+ # @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
478
492
  # @param set_page_as_boundary [Boolean]
493
+ # @param data_source_id [Integer] 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.
494
+ # @param connecting_new_account [Boolean] 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.
479
495
  # @param body [OAuthURLRequest]
480
496
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
481
- def get_oauth_url_with_http_info(service:, tags: SENTINEL, scope: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', zendesk_subdomain: SENTINEL, microsoft_tenant: SENTINEL, sharepoint_site_name: SENTINEL, confluence_subdomain: SENTINEL, generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, salesforce_domain: SENTINEL, sync_files_on_connection: true, set_page_as_boundary: false, extra: {})
497
+ def get_oauth_url_with_http_info(service:, tags: SENTINEL, scope: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', zendesk_subdomain: SENTINEL, microsoft_tenant: SENTINEL, sharepoint_site_name: SENTINEL, confluence_subdomain: SENTINEL, generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, salesforce_domain: SENTINEL, sync_files_on_connection: true, set_page_as_boundary: false, data_source_id: SENTINEL, connecting_new_account: false, extra: {})
482
498
  _body = {}
483
499
  _body[:tags] = tags if tags != SENTINEL
484
500
  _body[:scope] = scope if scope != SENTINEL
@@ -497,23 +513,27 @@ module Carbon
497
513
  _body[:salesforce_domain] = salesforce_domain if salesforce_domain != SENTINEL
498
514
  _body[:sync_files_on_connection] = sync_files_on_connection if sync_files_on_connection != SENTINEL
499
515
  _body[:set_page_as_boundary] = set_page_as_boundary if set_page_as_boundary != SENTINEL
516
+ _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
517
+ _body[:connecting_new_account] = connecting_new_account if connecting_new_account != SENTINEL
500
518
  o_auth_url_request = _body
501
519
  get_oauth_url_with_http_info_impl(o_auth_url_request, extra)
502
520
  end
503
521
 
504
522
  # Get Oauth Url
523
+ # 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.
505
524
  # @param o_auth_url_request [OAuthURLRequest]
506
525
  # @param [Hash] opts the optional parameters
507
- # @return [Object]
526
+ # @return [OuthURLResponse]
508
527
  private def get_oauth_url_impl(o_auth_url_request, opts = {})
509
528
  data, _status_code, _headers = get_oauth_url_with_http_info(o_auth_url_request, opts)
510
529
  data
511
530
  end
512
531
 
513
532
  # Get Oauth Url
533
+ # 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.
514
534
  # @param o_auth_url_request [OAuthURLRequest]
515
535
  # @param [Hash] opts the optional parameters
516
- # @return [APIResponse] data is Object, status code, headers and response
536
+ # @return [APIResponse] data is OuthURLResponse, status code, headers and response
517
537
  private def get_oauth_url_with_http_info_impl(o_auth_url_request, opts = {})
518
538
  if @api_client.config.debugging
519
539
  @api_client.config.logger.debug 'Calling API: IntegrationsApi.get_oauth_url ...'
@@ -545,7 +565,7 @@ module Carbon
545
565
  post_body = opts[:debug_body] || @api_client.object_to_http_body(o_auth_url_request)
546
566
 
547
567
  # return_type
548
- return_type = opts[:debug_return_type] || 'Object'
568
+ return_type = opts[:debug_return_type] || 'OuthURLResponse'
549
569
 
550
570
  # auth_names
551
571
  auth_names = opts[:debug_auth_names] || ['accessToken', 'apiKey', 'customerId']
@@ -787,8 +807,10 @@ module Carbon
787
807
  # After connecting your Outlook account, you can use this endpoint to list all of your folders on outlook. This includes
788
808
  # both system folders like "inbox" and user created folders.
789
809
  #
810
+ # @param data_source_id [Integer]
790
811
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
791
- def list_folders(extra: {})
812
+ def list_folders(data_source_id: SENTINEL, extra: {})
813
+ extra[:data_source_id] = data_source_id if data_source_id != SENTINEL
792
814
  api_response = list_folders_with_http_info_impl(extra)
793
815
  api_response.data
794
816
  end
@@ -798,14 +820,17 @@ module Carbon
798
820
  # After connecting your Outlook account, you can use this endpoint to list all of your folders on outlook. This includes
799
821
  # both system folders like "inbox" and user created folders.
800
822
  #
823
+ # @param data_source_id [Integer]
801
824
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
802
- def list_folders_with_http_info(extra: {})
825
+ def list_folders_with_http_info(data_source_id: SENTINEL, extra: {})
826
+ extra[:data_source_id] = data_source_id if data_source_id != SENTINEL
803
827
  list_folders_with_http_info_impl(extra)
804
828
  end
805
829
 
806
830
  # Outlook Folders
807
831
  # After connecting your Outlook account, you can use this endpoint to list all of your folders on outlook. This includes both system folders like \"inbox\" and user created folders.
808
832
  # @param [Hash] opts the optional parameters
833
+ # @option opts [Integer] :data_source_id
809
834
  # @return [Object]
810
835
  private def list_folders_impl(opts = {})
811
836
  data, _status_code, _headers = list_folders_with_http_info(opts)
@@ -815,6 +840,7 @@ module Carbon
815
840
  # Outlook Folders
816
841
  # After connecting your Outlook account, you can use this endpoint to list all of your folders on outlook. This includes both system folders like \&quot;inbox\&quot; and user created folders.
817
842
  # @param [Hash] opts the optional parameters
843
+ # @option opts [Integer] :data_source_id
818
844
  # @return [APIResponse] data is Object, status code, headers and response
819
845
  private def list_folders_with_http_info_impl(opts = {})
820
846
  if @api_client.config.debugging
@@ -825,6 +851,7 @@ module Carbon
825
851
 
826
852
  # query parameters
827
853
  query_params = opts[:query_params] || {}
854
+ query_params[:'data_source_id'] = opts[:'data_source_id'] if !opts[:'data_source_id'].nil?
828
855
 
829
856
  # header parameters
830
857
  header_params = opts[:header_params] || {}
@@ -952,8 +979,10 @@ module Carbon
952
979
  # After connecting your Gmail account, you can use this endpoint to list all of your labels. User created labels
953
980
  # will have the type "user" and Gmail's default labels will have the type "system"
954
981
  #
982
+ # @param data_source_id [Integer]
955
983
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
956
- def list_labels(extra: {})
984
+ def list_labels(data_source_id: SENTINEL, extra: {})
985
+ extra[:data_source_id] = data_source_id if data_source_id != SENTINEL
957
986
  api_response = list_labels_with_http_info_impl(extra)
958
987
  api_response.data
959
988
  end
@@ -963,14 +992,17 @@ module Carbon
963
992
  # After connecting your Gmail account, you can use this endpoint to list all of your labels. User created labels
964
993
  # will have the type "user" and Gmail's default labels will have the type "system"
965
994
  #
995
+ # @param data_source_id [Integer]
966
996
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
967
- def list_labels_with_http_info(extra: {})
997
+ def list_labels_with_http_info(data_source_id: SENTINEL, extra: {})
998
+ extra[:data_source_id] = data_source_id if data_source_id != SENTINEL
968
999
  list_labels_with_http_info_impl(extra)
969
1000
  end
970
1001
 
971
1002
  # Gmail Labels
972
1003
  # After connecting your Gmail account, you can use this endpoint to list all of your labels. User created labels will have the type \"user\" and Gmail's default labels will have the type \"system\"
973
1004
  # @param [Hash] opts the optional parameters
1005
+ # @option opts [Integer] :data_source_id
974
1006
  # @return [Object]
975
1007
  private def list_labels_impl(opts = {})
976
1008
  data, _status_code, _headers = list_labels_with_http_info(opts)
@@ -980,6 +1012,7 @@ module Carbon
980
1012
  # Gmail Labels
981
1013
  # After connecting your Gmail account, you can use this endpoint to list all of your labels. User created labels will have the type \&quot;user\&quot; and Gmail&#39;s default labels will have the type \&quot;system\&quot;
982
1014
  # @param [Hash] opts the optional parameters
1015
+ # @option opts [Integer] :data_source_id
983
1016
  # @return [APIResponse] data is Object, status code, headers and response
984
1017
  private def list_labels_with_http_info_impl(opts = {})
985
1018
  if @api_client.config.debugging
@@ -990,6 +1023,7 @@ module Carbon
990
1023
 
991
1024
  # query parameters
992
1025
  query_params = opts[:query_params] || {}
1026
+ query_params[:'data_source_id'] = opts[:'data_source_id'] if !opts[:'data_source_id'].nil?
993
1027
 
994
1028
  # header parameters
995
1029
  header_params = opts[:header_params] || {}
@@ -1031,8 +1065,10 @@ module Carbon
1031
1065
  # After connecting your Outlook account, you can use this endpoint to list all of your categories on outlook. We currently
1032
1066
  # support listing up to 250 categories.
1033
1067
  #
1068
+ # @param data_source_id [Integer]
1034
1069
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
1035
- def list_outlook_categories(extra: {})
1070
+ def list_outlook_categories(data_source_id: SENTINEL, extra: {})
1071
+ extra[:data_source_id] = data_source_id if data_source_id != SENTINEL
1036
1072
  api_response = list_outlook_categories_with_http_info_impl(extra)
1037
1073
  api_response.data
1038
1074
  end
@@ -1042,14 +1078,17 @@ module Carbon
1042
1078
  # After connecting your Outlook account, you can use this endpoint to list all of your categories on outlook. We currently
1043
1079
  # support listing up to 250 categories.
1044
1080
  #
1081
+ # @param data_source_id [Integer]
1045
1082
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
1046
- def list_outlook_categories_with_http_info(extra: {})
1083
+ def list_outlook_categories_with_http_info(data_source_id: SENTINEL, extra: {})
1084
+ extra[:data_source_id] = data_source_id if data_source_id != SENTINEL
1047
1085
  list_outlook_categories_with_http_info_impl(extra)
1048
1086
  end
1049
1087
 
1050
1088
  # Outlook Categories
1051
1089
  # After connecting your Outlook account, you can use this endpoint to list all of your categories on outlook. We currently support listing up to 250 categories.
1052
1090
  # @param [Hash] opts the optional parameters
1091
+ # @option opts [Integer] :data_source_id
1053
1092
  # @return [Object]
1054
1093
  private def list_outlook_categories_impl(opts = {})
1055
1094
  data, _status_code, _headers = list_outlook_categories_with_http_info(opts)
@@ -1059,6 +1098,7 @@ module Carbon
1059
1098
  # Outlook Categories
1060
1099
  # After connecting your Outlook account, you can use this endpoint to list all of your categories on outlook. We currently support listing up to 250 categories.
1061
1100
  # @param [Hash] opts the optional parameters
1101
+ # @option opts [Integer] :data_source_id
1062
1102
  # @return [APIResponse] data is Object, status code, headers and response
1063
1103
  private def list_outlook_categories_with_http_info_impl(opts = {})
1064
1104
  if @api_client.config.debugging
@@ -1069,6 +1109,7 @@ module Carbon
1069
1109
 
1070
1110
  # query parameters
1071
1111
  query_params = opts[:query_params] || {}
1112
+ query_params[:'data_source_id'] = opts[:'data_source_id'] if !opts[:'data_source_id'].nil?
1072
1113
 
1073
1114
  # header parameters
1074
1115
  header_params = opts[:header_params] || {}
@@ -1678,9 +1719,10 @@ module Carbon
1678
1719
  # @param embedding_model [EmbeddingGenerators]
1679
1720
  # @param generate_sparse_vectors [Boolean]
1680
1721
  # @param prepend_filename_to_chunks [Boolean]
1722
+ # @param data_source_id [Integer]
1681
1723
  # @param body [GmailSyncInput]
1682
1724
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
1683
- def sync_gmail(filters:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, extra: {})
1725
+ def sync_gmail(filters:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, data_source_id: SENTINEL, extra: {})
1684
1726
  _body = {}
1685
1727
  _body[:tags] = tags if tags != SENTINEL
1686
1728
  _body[:filters] = filters if filters != SENTINEL
@@ -1690,6 +1732,7 @@ module Carbon
1690
1732
  _body[:embedding_model] = embedding_model if embedding_model != SENTINEL
1691
1733
  _body[:generate_sparse_vectors] = generate_sparse_vectors if generate_sparse_vectors != SENTINEL
1692
1734
  _body[:prepend_filename_to_chunks] = prepend_filename_to_chunks if prepend_filename_to_chunks != SENTINEL
1735
+ _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
1693
1736
  gmail_sync_input = _body
1694
1737
  api_response = sync_gmail_with_http_info_impl(gmail_sync_input, extra)
1695
1738
  api_response.data
@@ -1756,9 +1799,10 @@ module Carbon
1756
1799
  # @param embedding_model [EmbeddingGenerators]
1757
1800
  # @param generate_sparse_vectors [Boolean]
1758
1801
  # @param prepend_filename_to_chunks [Boolean]
1802
+ # @param data_source_id [Integer]
1759
1803
  # @param body [GmailSyncInput]
1760
1804
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
1761
- def sync_gmail_with_http_info(filters:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, extra: {})
1805
+ def sync_gmail_with_http_info(filters:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, data_source_id: SENTINEL, extra: {})
1762
1806
  _body = {}
1763
1807
  _body[:tags] = tags if tags != SENTINEL
1764
1808
  _body[:filters] = filters if filters != SENTINEL
@@ -1768,6 +1812,7 @@ module Carbon
1768
1812
  _body[:embedding_model] = embedding_model if embedding_model != SENTINEL
1769
1813
  _body[:generate_sparse_vectors] = generate_sparse_vectors if generate_sparse_vectors != SENTINEL
1770
1814
  _body[:prepend_filename_to_chunks] = prepend_filename_to_chunks if prepend_filename_to_chunks != SENTINEL
1815
+ _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
1771
1816
  gmail_sync_input = _body
1772
1817
  sync_gmail_with_http_info_impl(gmail_sync_input, extra)
1773
1818
  end
@@ -1913,9 +1958,10 @@ module Carbon
1913
1958
  # @param embedding_model [EmbeddingGenerators]
1914
1959
  # @param generate_sparse_vectors [Boolean]
1915
1960
  # @param prepend_filename_to_chunks [Boolean]
1961
+ # @param data_source_id [Integer]
1916
1962
  # @param body [OutlookSyncInput]
1917
1963
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
1918
- def sync_outlook(filters:, tags: SENTINEL, folder: 'Inbox', chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, extra: {})
1964
+ def sync_outlook(filters:, tags: SENTINEL, folder: 'Inbox', chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, data_source_id: SENTINEL, extra: {})
1919
1965
  _body = {}
1920
1966
  _body[:tags] = tags if tags != SENTINEL
1921
1967
  _body[:folder] = folder if folder != SENTINEL
@@ -1926,6 +1972,7 @@ module Carbon
1926
1972
  _body[:embedding_model] = embedding_model if embedding_model != SENTINEL
1927
1973
  _body[:generate_sparse_vectors] = generate_sparse_vectors if generate_sparse_vectors != SENTINEL
1928
1974
  _body[:prepend_filename_to_chunks] = prepend_filename_to_chunks if prepend_filename_to_chunks != SENTINEL
1975
+ _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
1929
1976
  outlook_sync_input = _body
1930
1977
  api_response = sync_outlook_with_http_info_impl(outlook_sync_input, extra)
1931
1978
  api_response.data
@@ -2003,9 +2050,10 @@ module Carbon
2003
2050
  # @param embedding_model [EmbeddingGenerators]
2004
2051
  # @param generate_sparse_vectors [Boolean]
2005
2052
  # @param prepend_filename_to_chunks [Boolean]
2053
+ # @param data_source_id [Integer]
2006
2054
  # @param body [OutlookSyncInput]
2007
2055
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
2008
- def sync_outlook_with_http_info(filters:, tags: SENTINEL, folder: 'Inbox', chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, extra: {})
2056
+ def sync_outlook_with_http_info(filters:, tags: SENTINEL, folder: 'Inbox', chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, data_source_id: SENTINEL, extra: {})
2009
2057
  _body = {}
2010
2058
  _body[:tags] = tags if tags != SENTINEL
2011
2059
  _body[:folder] = folder if folder != SENTINEL
@@ -2016,6 +2064,7 @@ module Carbon
2016
2064
  _body[:embedding_model] = embedding_model if embedding_model != SENTINEL
2017
2065
  _body[:generate_sparse_vectors] = generate_sparse_vectors if generate_sparse_vectors != SENTINEL
2018
2066
  _body[:prepend_filename_to_chunks] = prepend_filename_to_chunks if prepend_filename_to_chunks != SENTINEL
2067
+ _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
2019
2068
  outlook_sync_input = _body
2020
2069
  sync_outlook_with_http_info_impl(outlook_sync_input, extra)
2021
2070
  end
@@ -2225,9 +2274,10 @@ module Carbon
2225
2274
  # @param prepend_filename_to_chunks [Boolean]
2226
2275
  # @param max_items_per_chunk [Integer]
2227
2276
  # @param set_page_as_boundary [Boolean]
2277
+ # @param data_source_id [Integer]
2228
2278
  # @param body [S3FileSyncInput]
2229
2279
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
2230
- def sync_s3_files(ids:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, set_page_as_boundary: false, extra: {})
2280
+ def sync_s3_files(ids:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, set_page_as_boundary: false, data_source_id: SENTINEL, extra: {})
2231
2281
  _body = {}
2232
2282
  _body[:tags] = tags if tags != SENTINEL
2233
2283
  _body[:ids] = ids if ids != SENTINEL
@@ -2239,6 +2289,7 @@ module Carbon
2239
2289
  _body[:prepend_filename_to_chunks] = prepend_filename_to_chunks if prepend_filename_to_chunks != SENTINEL
2240
2290
  _body[:max_items_per_chunk] = max_items_per_chunk if max_items_per_chunk != SENTINEL
2241
2291
  _body[:set_page_as_boundary] = set_page_as_boundary if set_page_as_boundary != SENTINEL
2292
+ _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
2242
2293
  s3_file_sync_input = _body
2243
2294
  api_response = sync_s3_files_with_http_info_impl(s3_file_sync_input, extra)
2244
2295
  api_response.data
@@ -2260,9 +2311,10 @@ module Carbon
2260
2311
  # @param prepend_filename_to_chunks [Boolean]
2261
2312
  # @param max_items_per_chunk [Integer]
2262
2313
  # @param set_page_as_boundary [Boolean]
2314
+ # @param data_source_id [Integer]
2263
2315
  # @param body [S3FileSyncInput]
2264
2316
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
2265
- def sync_s3_files_with_http_info(ids:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, set_page_as_boundary: false, extra: {})
2317
+ def sync_s3_files_with_http_info(ids:, tags: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, embedding_model: 'OPENAI', generate_sparse_vectors: false, prepend_filename_to_chunks: false, max_items_per_chunk: SENTINEL, set_page_as_boundary: false, data_source_id: SENTINEL, extra: {})
2266
2318
  _body = {}
2267
2319
  _body[:tags] = tags if tags != SENTINEL
2268
2320
  _body[:ids] = ids if ids != SENTINEL
@@ -2274,6 +2326,7 @@ module Carbon
2274
2326
  _body[:prepend_filename_to_chunks] = prepend_filename_to_chunks if prepend_filename_to_chunks != SENTINEL
2275
2327
  _body[:max_items_per_chunk] = max_items_per_chunk if max_items_per_chunk != SENTINEL
2276
2328
  _body[:set_page_as_boundary] = set_page_as_boundary if set_page_as_boundary != SENTINEL
2329
+ _body[:data_source_id] = data_source_id if data_source_id != SENTINEL
2277
2330
  s3_file_sync_input = _body
2278
2331
  sync_s3_files_with_http_info_impl(s3_file_sync_input, extra)
2279
2332
  end