carbon_ruby_sdk 0.1.31 → 0.1.32
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +13 -7
- data/lib/carbon_ruby_sdk/api/files_api.rb +15 -4
- data/lib/carbon_ruby_sdk/api/integrations_api.rb +8 -8
- data/lib/carbon_ruby_sdk/models/o_auth_url_request.rb +2 -2
- data/lib/carbon_ruby_sdk/models/sync_files_request.rb +1 -1
- data/lib/carbon_ruby_sdk/models/sync_options.rb +1 -1
- data/lib/carbon_ruby_sdk/models/upload_file_from_url_input.rb +15 -4
- data/lib/carbon_ruby_sdk/models/user_file.rb +11 -1
- data/lib/carbon_ruby_sdk/version.rb +1 -1
- data/spec/api/files_api_spec.rb +1 -0
- data/spec/models/upload_file_from_url_input_spec.rb +6 -0
- data/spec/models/user_file_spec.rb +6 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c4ae5d4f0f541a79e55ebbc31e389288ade690388320b312bfdfb93470623885
|
4
|
+
data.tar.gz: b04a0fb5010f8aea77b631fd8bae0eb01fe9e21c21e61aff1067cb4f97167293
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 869780fefbc58a5bdd2aa88b8681755c26ae8e356fedfb116ff601e4aba5769ca00c9a699f96b922327f5ddc0ed1448fcfc27b54e09838cf6a8a16c824067d26
|
7
|
+
data.tar.gz: 37846de55b750be951be3c478aabf2d66944eeb50b61641f62daf03f4df9333aaea4a97f793d14938baecdca0ee24e6f4906b0408a70885b11c83f66e97ce803
|
data/Gemfile.lock
CHANGED
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.
|
9
|
+
[![npm](https://img.shields.io/badge/gem-v0.1.32-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.1.32)
|
10
10
|
|
11
11
|
</div>
|
12
12
|
|
@@ -84,7 +84,7 @@ Connect external data to LLMs, no matter the source.
|
|
84
84
|
Add to Gemfile:
|
85
85
|
|
86
86
|
```ruby
|
87
|
-
gem 'carbon_ruby_sdk', '~> 0.1.
|
87
|
+
gem 'carbon_ruby_sdk', '~> 0.1.32'
|
88
88
|
```
|
89
89
|
|
90
90
|
## Getting Started<a id="getting-started"></a>
|
@@ -1001,6 +1001,7 @@ result = carbon.files.upload(
|
|
1001
1001
|
prepend_filename_to_chunks: false,
|
1002
1002
|
max_items_per_chunk: 1,
|
1003
1003
|
parse_pdf_tables_with_ocr: false,
|
1004
|
+
detect_audio_language: false,
|
1004
1005
|
)
|
1005
1006
|
p result
|
1006
1007
|
```
|
@@ -1043,6 +1044,9 @@ Number of objects per chunk. For csv, tsv, xlsx, and json files only.
|
|
1043
1044
|
##### parse_pdf_tables_with_ocr: `Boolean`<a id="parse_pdf_tables_with_ocr-boolean"></a>
|
1044
1045
|
Whether to use rich table parsing when `use_ocr` is enabled.
|
1045
1046
|
|
1047
|
+
##### detect_audio_language: `Boolean`<a id="detect_audio_language-boolean"></a>
|
1048
|
+
Whether to automatically detect the language of the uploaded audio file.
|
1049
|
+
|
1046
1050
|
#### 🔄 Return<a id="🔄-return"></a>
|
1047
1051
|
|
1048
1052
|
[UserFile](./lib/carbon_ruby_sdk/models/user_file.rb)
|
@@ -1076,6 +1080,7 @@ result = carbon.files.upload_from_url(
|
|
1076
1080
|
prepend_filename_to_chunks: false,
|
1077
1081
|
max_items_per_chunk: 1,
|
1078
1082
|
parse_pdf_tables_with_ocr: false,
|
1083
|
+
detect_audio_language: false,
|
1079
1084
|
)
|
1080
1085
|
p result
|
1081
1086
|
```
|
@@ -1096,6 +1101,7 @@ p result
|
|
1096
1101
|
Number of objects per chunk. For csv, tsv, xlsx, and json files only.
|
1097
1102
|
|
1098
1103
|
##### parse_pdf_tables_with_ocr: `Boolean`<a id="parse_pdf_tables_with_ocr-boolean"></a>
|
1104
|
+
##### detect_audio_language: `Boolean`<a id="detect_audio_language-boolean"></a>
|
1099
1105
|
#### 🔄 Return<a id="🔄-return"></a>
|
1100
1106
|
|
1101
1107
|
[UserFile](./lib/carbon_ruby_sdk/models/user_file.rb)
|
@@ -1202,7 +1208,7 @@ result = carbon.integrations.connect_data_source(
|
|
1202
1208
|
"prepend_filename_to_chunks" => false,
|
1203
1209
|
"sync_files_on_connection" => true,
|
1204
1210
|
"set_page_as_boundary" => false,
|
1205
|
-
"request_id" => "
|
1211
|
+
"request_id" => "b360dae1-b5fd-4803-a53a-1691e3c32558",
|
1206
1212
|
"enable_file_picker" => true,
|
1207
1213
|
"sync_source_items" => true,
|
1208
1214
|
"incremental_sync" => false,
|
@@ -1420,7 +1426,7 @@ result = carbon.integrations.get_oauth_url(
|
|
1420
1426
|
set_page_as_boundary: false,
|
1421
1427
|
data_source_id: 1,
|
1422
1428
|
connecting_new_account: false,
|
1423
|
-
request_id: "
|
1429
|
+
request_id: "26453c8f-69ab-4eb3-bc25-0ca995b118a0",
|
1424
1430
|
use_ocr: false,
|
1425
1431
|
parse_pdf_tables_with_ocr: false,
|
1426
1432
|
enable_file_picker: true,
|
@@ -1479,7 +1485,7 @@ Enable OCR for files that support it. Supported formats: pdf
|
|
1479
1485
|
##### parse_pdf_tables_with_ocr: `Boolean`<a id="parse_pdf_tables_with_ocr-boolean"></a>
|
1480
1486
|
##### enable_file_picker: `Boolean`<a id="enable_file_picker-boolean"></a>
|
1481
1487
|
Enable integration's file picker for sources that support it. Supported sources:
|
1482
|
-
|
1488
|
+
SHAREPOINT, DROPBOX, BOX, ONEDRIVE, GOOGLE_DRIVE
|
1483
1489
|
|
1484
1490
|
##### sync_source_items: `Boolean`<a id="sync_source_items-boolean"></a>
|
1485
1491
|
Enabling this flag will fetch all available content from the source to be listed
|
@@ -1741,7 +1747,7 @@ result = carbon.integrations.sync_confluence(
|
|
1741
1747
|
prepend_filename_to_chunks: false,
|
1742
1748
|
max_items_per_chunk: 1,
|
1743
1749
|
set_page_as_boundary: false,
|
1744
|
-
request_id: "
|
1750
|
+
request_id: "3d0330f2-f2e4-482b-9ca7-91d3a1bbbd18",
|
1745
1751
|
use_ocr: false,
|
1746
1752
|
parse_pdf_tables_with_ocr: false,
|
1747
1753
|
incremental_sync: false,
|
@@ -1842,7 +1848,7 @@ result = carbon.integrations.sync_files(
|
|
1842
1848
|
prepend_filename_to_chunks: false,
|
1843
1849
|
max_items_per_chunk: 1,
|
1844
1850
|
set_page_as_boundary: false,
|
1845
|
-
request_id: "
|
1851
|
+
request_id: "3d0330f2-f2e4-482b-9ca7-91d3a1bbbd18",
|
1846
1852
|
use_ocr: false,
|
1847
1853
|
parse_pdf_tables_with_ocr: false,
|
1848
1854
|
incremental_sync: false,
|
@@ -1172,9 +1172,10 @@ module Carbon
|
|
1172
1172
|
# @param prepend_filename_to_chunks [Boolean] Whether or not to prepend the file's name to chunks.
|
1173
1173
|
# @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
|
1174
1174
|
# @param parse_pdf_tables_with_ocr [Boolean] Whether to use rich table parsing when `use_ocr` is enabled.
|
1175
|
+
# @param detect_audio_language [Boolean] Whether to automatically detect the language of the uploaded audio file.
|
1175
1176
|
# @param body [BodyCreateUploadFileUploadfilePost]
|
1176
1177
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
1177
|
-
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, parse_pdf_tables_with_ocr: false, extra: {})
|
1178
|
+
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, parse_pdf_tables_with_ocr: false, detect_audio_language: false, extra: {})
|
1178
1179
|
_body = {}
|
1179
1180
|
_body[:file] = file if file != SENTINEL
|
1180
1181
|
body_create_upload_file_uploadfile_post = _body
|
@@ -1188,6 +1189,7 @@ module Carbon
|
|
1188
1189
|
extra[:prepend_filename_to_chunks] = prepend_filename_to_chunks if prepend_filename_to_chunks != SENTINEL
|
1189
1190
|
extra[:max_items_per_chunk] = max_items_per_chunk if max_items_per_chunk != SENTINEL
|
1190
1191
|
extra[:parse_pdf_tables_with_ocr] = parse_pdf_tables_with_ocr if parse_pdf_tables_with_ocr != SENTINEL
|
1192
|
+
extra[:detect_audio_language] = detect_audio_language if detect_audio_language != SENTINEL
|
1191
1193
|
api_response = upload_with_http_info_impl(file, body_create_upload_file_uploadfile_post, extra)
|
1192
1194
|
api_response.data
|
1193
1195
|
end
|
@@ -1231,9 +1233,10 @@ module Carbon
|
|
1231
1233
|
# @param prepend_filename_to_chunks [Boolean] Whether or not to prepend the file's name to chunks.
|
1232
1234
|
# @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
|
1233
1235
|
# @param parse_pdf_tables_with_ocr [Boolean] Whether to use rich table parsing when `use_ocr` is enabled.
|
1236
|
+
# @param detect_audio_language [Boolean] Whether to automatically detect the language of the uploaded audio file.
|
1234
1237
|
# @param body [BodyCreateUploadFileUploadfilePost]
|
1235
1238
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
1236
|
-
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, parse_pdf_tables_with_ocr: false, extra: {})
|
1239
|
+
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, parse_pdf_tables_with_ocr: false, detect_audio_language: false, extra: {})
|
1237
1240
|
_body = {}
|
1238
1241
|
_body[:file] = file if file != SENTINEL
|
1239
1242
|
body_create_upload_file_uploadfile_post = _body
|
@@ -1247,6 +1250,7 @@ module Carbon
|
|
1247
1250
|
extra[:prepend_filename_to_chunks] = prepend_filename_to_chunks if prepend_filename_to_chunks != SENTINEL
|
1248
1251
|
extra[:max_items_per_chunk] = max_items_per_chunk if max_items_per_chunk != SENTINEL
|
1249
1252
|
extra[:parse_pdf_tables_with_ocr] = parse_pdf_tables_with_ocr if parse_pdf_tables_with_ocr != SENTINEL
|
1253
|
+
extra[:detect_audio_language] = detect_audio_language if detect_audio_language != SENTINEL
|
1250
1254
|
upload_with_http_info_impl(file, body_create_upload_file_uploadfile_post, extra)
|
1251
1255
|
end
|
1252
1256
|
|
@@ -1265,6 +1269,7 @@ module Carbon
|
|
1265
1269
|
# @option opts [Boolean] :prepend_filename_to_chunks Whether or not to prepend the file's name to chunks. (default to false)
|
1266
1270
|
# @option opts [Integer] :max_items_per_chunk Number of objects per chunk. For csv, tsv, xlsx, and json files only.
|
1267
1271
|
# @option opts [Boolean] :parse_pdf_tables_with_ocr Whether to use rich table parsing when `use_ocr` is enabled. (default to false)
|
1272
|
+
# @option opts [Boolean] :detect_audio_language Whether to automatically detect the language of the uploaded audio file. (default to false)
|
1268
1273
|
# @return [UserFile]
|
1269
1274
|
private def upload_impl(file, body_create_upload_file_uploadfile_post, opts = {})
|
1270
1275
|
data, _status_code, _headers = upload_with_http_info(file, body_create_upload_file_uploadfile_post, opts)
|
@@ -1286,6 +1291,7 @@ module Carbon
|
|
1286
1291
|
# @option opts [Boolean] :prepend_filename_to_chunks Whether or not to prepend the file's name to chunks. (default to false)
|
1287
1292
|
# @option opts [Integer] :max_items_per_chunk Number of objects per chunk. For csv, tsv, xlsx, and json files only.
|
1288
1293
|
# @option opts [Boolean] :parse_pdf_tables_with_ocr Whether to use rich table parsing when `use_ocr` is enabled. (default to false)
|
1294
|
+
# @option opts [Boolean] :detect_audio_language Whether to automatically detect the language of the uploaded audio file. (default to false)
|
1289
1295
|
# @return [APIResponse] data is UserFile, status code, headers and response
|
1290
1296
|
private def upload_with_http_info_impl(file, body_create_upload_file_uploadfile_post, opts = {})
|
1291
1297
|
if @api_client.config.debugging
|
@@ -1314,6 +1320,7 @@ module Carbon
|
|
1314
1320
|
query_params[:'prepend_filename_to_chunks'] = opts[:'prepend_filename_to_chunks'] if !opts[:'prepend_filename_to_chunks'].nil?
|
1315
1321
|
query_params[:'max_items_per_chunk'] = opts[:'max_items_per_chunk'] if !opts[:'max_items_per_chunk'].nil?
|
1316
1322
|
query_params[:'parse_pdf_tables_with_ocr'] = opts[:'parse_pdf_tables_with_ocr'] if !opts[:'parse_pdf_tables_with_ocr'].nil?
|
1323
|
+
query_params[:'detect_audio_language'] = opts[:'detect_audio_language'] if !opts[:'detect_audio_language'].nil?
|
1317
1324
|
|
1318
1325
|
# header parameters
|
1319
1326
|
header_params = opts[:header_params] || {}
|
@@ -1370,9 +1377,10 @@ module Carbon
|
|
1370
1377
|
# @param prepend_filename_to_chunks [Boolean]
|
1371
1378
|
# @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
|
1372
1379
|
# @param parse_pdf_tables_with_ocr [Boolean]
|
1380
|
+
# @param detect_audio_language [Boolean]
|
1373
1381
|
# @param body [UploadFileFromUrlInput]
|
1374
1382
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
1375
|
-
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, parse_pdf_tables_with_ocr: false, extra: {})
|
1383
|
+
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, parse_pdf_tables_with_ocr: false, detect_audio_language: false, extra: {})
|
1376
1384
|
_body = {}
|
1377
1385
|
_body[:url] = url if url != SENTINEL
|
1378
1386
|
_body[:file_name] = file_name if file_name != SENTINEL
|
@@ -1386,6 +1394,7 @@ module Carbon
|
|
1386
1394
|
_body[:prepend_filename_to_chunks] = prepend_filename_to_chunks if prepend_filename_to_chunks != SENTINEL
|
1387
1395
|
_body[:max_items_per_chunk] = max_items_per_chunk if max_items_per_chunk != SENTINEL
|
1388
1396
|
_body[:parse_pdf_tables_with_ocr] = parse_pdf_tables_with_ocr if parse_pdf_tables_with_ocr != SENTINEL
|
1397
|
+
_body[:detect_audio_language] = detect_audio_language if detect_audio_language != SENTINEL
|
1389
1398
|
upload_file_from_url_input = _body
|
1390
1399
|
api_response = upload_from_url_with_http_info_impl(upload_file_from_url_input, extra)
|
1391
1400
|
api_response.data
|
@@ -1405,9 +1414,10 @@ module Carbon
|
|
1405
1414
|
# @param prepend_filename_to_chunks [Boolean]
|
1406
1415
|
# @param max_items_per_chunk [Integer] Number of objects per chunk. For csv, tsv, xlsx, and json files only.
|
1407
1416
|
# @param parse_pdf_tables_with_ocr [Boolean]
|
1417
|
+
# @param detect_audio_language [Boolean]
|
1408
1418
|
# @param body [UploadFileFromUrlInput]
|
1409
1419
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
1410
|
-
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, parse_pdf_tables_with_ocr: false, extra: {})
|
1420
|
+
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, parse_pdf_tables_with_ocr: false, detect_audio_language: false, extra: {})
|
1411
1421
|
_body = {}
|
1412
1422
|
_body[:url] = url if url != SENTINEL
|
1413
1423
|
_body[:file_name] = file_name if file_name != SENTINEL
|
@@ -1421,6 +1431,7 @@ module Carbon
|
|
1421
1431
|
_body[:prepend_filename_to_chunks] = prepend_filename_to_chunks if prepend_filename_to_chunks != SENTINEL
|
1422
1432
|
_body[:max_items_per_chunk] = max_items_per_chunk if max_items_per_chunk != SENTINEL
|
1423
1433
|
_body[:parse_pdf_tables_with_ocr] = parse_pdf_tables_with_ocr if parse_pdf_tables_with_ocr != SENTINEL
|
1434
|
+
_body[:detect_audio_language] = detect_audio_language if detect_audio_language != SENTINEL
|
1424
1435
|
upload_file_from_url_input = _body
|
1425
1436
|
upload_from_url_with_http_info_impl(upload_file_from_url_input, extra)
|
1426
1437
|
end
|
@@ -561,13 +561,13 @@ module Carbon
|
|
561
561
|
# @param request_id [String] This request id will be added to all files that get synced using the generated OAuth URL
|
562
562
|
# @param use_ocr [Boolean] Enable OCR for files that support it. Supported formats: pdf
|
563
563
|
# @param parse_pdf_tables_with_ocr [Boolean]
|
564
|
-
# @param enable_file_picker [Boolean] Enable integration's file picker for sources that support it. Supported sources:
|
564
|
+
# @param enable_file_picker [Boolean] Enable integration's file picker for sources that support it. Supported sources: SHAREPOINT, DROPBOX, BOX, ONEDRIVE, GOOGLE_DRIVE
|
565
565
|
# @param sync_source_items [Boolean] Enabling this flag will fetch all available content from the source to be listed via list items endpoint
|
566
566
|
# @param incremental_sync [Boolean] Only sync files if they have not already been synced or if the embedding properties have changed. This flag is currently supported by ONEDRIVE, GOOGLE_DRIVE, BOX, DROPBOX. It will be ignored for other data sources.
|
567
567
|
# @param file_sync_config [HelpdeskFileSyncConfigNullable]
|
568
568
|
# @param body [OAuthURLRequest]
|
569
569
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
570
|
-
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, request_id: '
|
570
|
+
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, request_id: '26453c8f-69ab-4eb3-bc25-0ca995b118a0', use_ocr: false, parse_pdf_tables_with_ocr: false, enable_file_picker: true, sync_source_items: true, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
|
571
571
|
_body = {}
|
572
572
|
_body[:tags] = tags if tags != SENTINEL
|
573
573
|
_body[:scope] = scope if scope != SENTINEL
|
@@ -629,13 +629,13 @@ module Carbon
|
|
629
629
|
# @param request_id [String] This request id will be added to all files that get synced using the generated OAuth URL
|
630
630
|
# @param use_ocr [Boolean] Enable OCR for files that support it. Supported formats: pdf
|
631
631
|
# @param parse_pdf_tables_with_ocr [Boolean]
|
632
|
-
# @param enable_file_picker [Boolean] Enable integration's file picker for sources that support it. Supported sources:
|
632
|
+
# @param enable_file_picker [Boolean] Enable integration's file picker for sources that support it. Supported sources: SHAREPOINT, DROPBOX, BOX, ONEDRIVE, GOOGLE_DRIVE
|
633
633
|
# @param sync_source_items [Boolean] Enabling this flag will fetch all available content from the source to be listed via list items endpoint
|
634
634
|
# @param incremental_sync [Boolean] Only sync files if they have not already been synced or if the embedding properties have changed. This flag is currently supported by ONEDRIVE, GOOGLE_DRIVE, BOX, DROPBOX. It will be ignored for other data sources.
|
635
635
|
# @param file_sync_config [HelpdeskFileSyncConfigNullable]
|
636
636
|
# @param body [OAuthURLRequest]
|
637
637
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
638
|
-
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, request_id: '
|
638
|
+
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, request_id: '26453c8f-69ab-4eb3-bc25-0ca995b118a0', use_ocr: false, parse_pdf_tables_with_ocr: false, enable_file_picker: true, sync_source_items: true, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
|
639
639
|
_body = {}
|
640
640
|
_body[:tags] = tags if tags != SENTINEL
|
641
641
|
_body[:scope] = scope if scope != SENTINEL
|
@@ -1431,7 +1431,7 @@ module Carbon
|
|
1431
1431
|
# @param file_sync_config [HelpdeskGlobalFileSyncConfigNullable]
|
1432
1432
|
# @param body [SyncFilesRequest]
|
1433
1433
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
1434
|
-
def sync_confluence(data_source_id:, 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, request_id: '
|
1434
|
+
def sync_confluence(data_source_id:, 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, request_id: '3d0330f2-f2e4-482b-9ca7-91d3a1bbbd18', use_ocr: false, parse_pdf_tables_with_ocr: false, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
|
1435
1435
|
_body = {}
|
1436
1436
|
_body[:tags] = tags if tags != SENTINEL
|
1437
1437
|
_body[:data_source_id] = data_source_id if data_source_id != SENTINEL
|
@@ -1479,7 +1479,7 @@ module Carbon
|
|
1479
1479
|
# @param file_sync_config [HelpdeskGlobalFileSyncConfigNullable]
|
1480
1480
|
# @param body [SyncFilesRequest]
|
1481
1481
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
1482
|
-
def sync_confluence_with_http_info(data_source_id:, 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, request_id: '
|
1482
|
+
def sync_confluence_with_http_info(data_source_id:, 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, request_id: '3d0330f2-f2e4-482b-9ca7-91d3a1bbbd18', use_ocr: false, parse_pdf_tables_with_ocr: false, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
|
1483
1483
|
_body = {}
|
1484
1484
|
_body[:tags] = tags if tags != SENTINEL
|
1485
1485
|
_body[:data_source_id] = data_source_id if data_source_id != SENTINEL
|
@@ -1687,7 +1687,7 @@ module Carbon
|
|
1687
1687
|
# @param file_sync_config [HelpdeskGlobalFileSyncConfigNullable]
|
1688
1688
|
# @param body [SyncFilesRequest]
|
1689
1689
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
1690
|
-
def sync_files(data_source_id:, 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, request_id: '
|
1690
|
+
def sync_files(data_source_id:, 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, request_id: '3d0330f2-f2e4-482b-9ca7-91d3a1bbbd18', use_ocr: false, parse_pdf_tables_with_ocr: false, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
|
1691
1691
|
_body = {}
|
1692
1692
|
_body[:tags] = tags if tags != SENTINEL
|
1693
1693
|
_body[:data_source_id] = data_source_id if data_source_id != SENTINEL
|
@@ -1735,7 +1735,7 @@ module Carbon
|
|
1735
1735
|
# @param file_sync_config [HelpdeskGlobalFileSyncConfigNullable]
|
1736
1736
|
# @param body [SyncFilesRequest]
|
1737
1737
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
1738
|
-
def sync_files_with_http_info(data_source_id:, 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, request_id: '
|
1738
|
+
def sync_files_with_http_info(data_source_id:, 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, request_id: '3d0330f2-f2e4-482b-9ca7-91d3a1bbbd18', use_ocr: false, parse_pdf_tables_with_ocr: false, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
|
1739
1739
|
_body = {}
|
1740
1740
|
_body[:tags] = tags if tags != SENTINEL
|
1741
1741
|
_body[:data_source_id] = data_source_id if data_source_id != SENTINEL
|
@@ -61,7 +61,7 @@ module Carbon
|
|
61
61
|
|
62
62
|
attr_accessor :parse_pdf_tables_with_ocr
|
63
63
|
|
64
|
-
# Enable integration's file picker for sources that support it. Supported sources:
|
64
|
+
# Enable integration's file picker for sources that support it. Supported sources: SHAREPOINT, DROPBOX, BOX, ONEDRIVE, GOOGLE_DRIVE
|
65
65
|
attr_accessor :enable_file_picker
|
66
66
|
|
67
67
|
# Enabling this flag will fetch all available content from the source to be listed via list items endpoint
|
@@ -279,7 +279,7 @@ module Carbon
|
|
279
279
|
if attributes.key?(:'request_id')
|
280
280
|
self.request_id = attributes[:'request_id']
|
281
281
|
else
|
282
|
-
self.request_id = '
|
282
|
+
self.request_id = '26453c8f-69ab-4eb3-bc25-0ca995b118a0'
|
283
283
|
end
|
284
284
|
|
285
285
|
if attributes.key?(:'use_ocr')
|
@@ -187,7 +187,7 @@ module Carbon
|
|
187
187
|
if attributes.key?(:'request_id')
|
188
188
|
self.request_id = attributes[:'request_id']
|
189
189
|
else
|
190
|
-
self.request_id = '
|
190
|
+
self.request_id = '3d0330f2-f2e4-482b-9ca7-91d3a1bbbd18'
|
191
191
|
end
|
192
192
|
|
193
193
|
if attributes.key?(:'use_ocr')
|
@@ -182,7 +182,7 @@ module Carbon
|
|
182
182
|
if attributes.key?(:'request_id')
|
183
183
|
self.request_id = attributes[:'request_id']
|
184
184
|
else
|
185
|
-
self.request_id = '
|
185
|
+
self.request_id = 'b360dae1-b5fd-4803-a53a-1691e3c32558'
|
186
186
|
end
|
187
187
|
|
188
188
|
if attributes.key?(:'enable_file_picker')
|
@@ -36,6 +36,8 @@ module Carbon
|
|
36
36
|
|
37
37
|
attr_accessor :parse_pdf_tables_with_ocr
|
38
38
|
|
39
|
+
attr_accessor :detect_audio_language
|
40
|
+
|
39
41
|
# Attribute mapping from ruby-style variable name to JSON key.
|
40
42
|
def self.attribute_map
|
41
43
|
{
|
@@ -50,7 +52,8 @@ module Carbon
|
|
50
52
|
:'use_textract' => :'use_textract',
|
51
53
|
:'prepend_filename_to_chunks' => :'prepend_filename_to_chunks',
|
52
54
|
:'max_items_per_chunk' => :'max_items_per_chunk',
|
53
|
-
:'parse_pdf_tables_with_ocr' => :'parse_pdf_tables_with_ocr'
|
55
|
+
:'parse_pdf_tables_with_ocr' => :'parse_pdf_tables_with_ocr',
|
56
|
+
:'detect_audio_language' => :'detect_audio_language'
|
54
57
|
}
|
55
58
|
end
|
56
59
|
|
@@ -73,7 +76,8 @@ module Carbon
|
|
73
76
|
:'use_textract' => :'Boolean',
|
74
77
|
:'prepend_filename_to_chunks' => :'Boolean',
|
75
78
|
:'max_items_per_chunk' => :'Integer',
|
76
|
-
:'parse_pdf_tables_with_ocr' => :'Boolean'
|
79
|
+
:'parse_pdf_tables_with_ocr' => :'Boolean',
|
80
|
+
:'detect_audio_language' => :'Boolean'
|
77
81
|
}
|
78
82
|
end
|
79
83
|
|
@@ -163,6 +167,12 @@ module Carbon
|
|
163
167
|
else
|
164
168
|
self.parse_pdf_tables_with_ocr = false
|
165
169
|
end
|
170
|
+
|
171
|
+
if attributes.key?(:'detect_audio_language')
|
172
|
+
self.detect_audio_language = attributes[:'detect_audio_language']
|
173
|
+
else
|
174
|
+
self.detect_audio_language = false
|
175
|
+
end
|
166
176
|
end
|
167
177
|
|
168
178
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -199,7 +209,8 @@ module Carbon
|
|
199
209
|
use_textract == o.use_textract &&
|
200
210
|
prepend_filename_to_chunks == o.prepend_filename_to_chunks &&
|
201
211
|
max_items_per_chunk == o.max_items_per_chunk &&
|
202
|
-
parse_pdf_tables_with_ocr == o.parse_pdf_tables_with_ocr
|
212
|
+
parse_pdf_tables_with_ocr == o.parse_pdf_tables_with_ocr &&
|
213
|
+
detect_audio_language == o.detect_audio_language
|
203
214
|
end
|
204
215
|
|
205
216
|
# @see the `==` method
|
@@ -211,7 +222,7 @@ module Carbon
|
|
211
222
|
# Calculates hash code according to all attributes.
|
212
223
|
# @return [Integer] Hash code
|
213
224
|
def hash
|
214
|
-
[url, file_name, chunk_size, chunk_overlap, skip_embedding_generation, set_page_as_boundary, embedding_model, generate_sparse_vectors, use_textract, prepend_filename_to_chunks, max_items_per_chunk, parse_pdf_tables_with_ocr].hash
|
225
|
+
[url, file_name, chunk_size, chunk_overlap, skip_embedding_generation, set_page_as_boundary, embedding_model, generate_sparse_vectors, use_textract, prepend_filename_to_chunks, max_items_per_chunk, parse_pdf_tables_with_ocr, detect_audio_language].hash
|
215
226
|
end
|
216
227
|
|
217
228
|
# Builds the object from hash
|
@@ -67,6 +67,8 @@ module Carbon
|
|
67
67
|
|
68
68
|
attr_accessor :generate_sparse_vectors
|
69
69
|
|
70
|
+
attr_accessor :audio_properties
|
71
|
+
|
70
72
|
attr_accessor :request_id
|
71
73
|
|
72
74
|
attr_accessor :created_at
|
@@ -104,6 +106,7 @@ module Carbon
|
|
104
106
|
:'skip_embedding_generation' => :'skip_embedding_generation',
|
105
107
|
:'source_created_at' => :'source_created_at',
|
106
108
|
:'generate_sparse_vectors' => :'generate_sparse_vectors',
|
109
|
+
:'audio_properties' => :'audio_properties',
|
107
110
|
:'request_id' => :'request_id',
|
108
111
|
:'created_at' => :'created_at',
|
109
112
|
:'updated_at' => :'updated_at'
|
@@ -146,6 +149,7 @@ module Carbon
|
|
146
149
|
:'skip_embedding_generation' => :'Boolean',
|
147
150
|
:'source_created_at' => :'Time',
|
148
151
|
:'generate_sparse_vectors' => :'Boolean',
|
152
|
+
:'audio_properties' => :'Object',
|
149
153
|
:'request_id' => :'String',
|
150
154
|
:'created_at' => :'Time',
|
151
155
|
:'updated_at' => :'Time'
|
@@ -175,6 +179,7 @@ module Carbon
|
|
175
179
|
:'additional_presigned_urls',
|
176
180
|
:'source_created_at',
|
177
181
|
:'generate_sparse_vectors',
|
182
|
+
:'audio_properties',
|
178
183
|
:'request_id',
|
179
184
|
])
|
180
185
|
end
|
@@ -308,6 +313,10 @@ module Carbon
|
|
308
313
|
self.generate_sparse_vectors = attributes[:'generate_sparse_vectors']
|
309
314
|
end
|
310
315
|
|
316
|
+
if attributes.key?(:'audio_properties')
|
317
|
+
self.audio_properties = attributes[:'audio_properties']
|
318
|
+
end
|
319
|
+
|
311
320
|
if attributes.key?(:'request_id')
|
312
321
|
self.request_id = attributes[:'request_id']
|
313
322
|
end
|
@@ -417,6 +426,7 @@ module Carbon
|
|
417
426
|
skip_embedding_generation == o.skip_embedding_generation &&
|
418
427
|
source_created_at == o.source_created_at &&
|
419
428
|
generate_sparse_vectors == o.generate_sparse_vectors &&
|
429
|
+
audio_properties == o.audio_properties &&
|
420
430
|
request_id == o.request_id &&
|
421
431
|
created_at == o.created_at &&
|
422
432
|
updated_at == o.updated_at
|
@@ -431,7 +441,7 @@ module Carbon
|
|
431
441
|
# Calculates hash code according to all attributes.
|
432
442
|
# @return [Integer] Hash code
|
433
443
|
def hash
|
434
|
-
[tags, id, source, organization_id, organization_supplied_user_id, organization_user_data_source_id, external_file_id, external_url, sync_status, sync_error_message, last_sync, file_statistics, file_metadata, embedding_properties, chunk_size, chunk_overlap, chunk_properties, ocr_properties, ocr_job_started_at, name, parent_id, enable_auto_sync, presigned_url, parsed_text_url, additional_presigned_urls, skip_embedding_generation, source_created_at, generate_sparse_vectors, request_id, created_at, updated_at].hash
|
444
|
+
[tags, id, source, organization_id, organization_supplied_user_id, organization_user_data_source_id, external_file_id, external_url, sync_status, sync_error_message, last_sync, file_statistics, file_metadata, embedding_properties, chunk_size, chunk_overlap, chunk_properties, ocr_properties, ocr_job_started_at, name, parent_id, enable_auto_sync, presigned_url, parsed_text_url, additional_presigned_urls, skip_embedding_generation, source_created_at, generate_sparse_vectors, audio_properties, request_id, created_at, updated_at].hash
|
435
445
|
end
|
436
446
|
|
437
447
|
# Builds the object from hash
|
data/spec/api/files_api_spec.rb
CHANGED
@@ -157,6 +157,7 @@ describe 'FilesApi' do
|
|
157
157
|
# @option opts [Boolean] :prepend_filename_to_chunks Whether or not to prepend the file's name to chunks.
|
158
158
|
# @option opts [Integer] :max_items_per_chunk Number of objects per chunk. For csv, tsv, xlsx, and json files only.
|
159
159
|
# @option opts [Boolean] :parse_pdf_tables_with_ocr Whether to use rich table parsing when `use_ocr` is enabled.
|
160
|
+
# @option opts [Boolean] :detect_audio_language Whether to automatically detect the language of the uploaded audio file.
|
160
161
|
# @return [UserFile]
|
161
162
|
describe 'upload test' do
|
162
163
|
it 'should work' do
|
@@ -91,4 +91,10 @@ describe Carbon::UploadFileFromUrlInput do
|
|
91
91
|
end
|
92
92
|
end
|
93
93
|
|
94
|
+
describe 'test attribute "detect_audio_language"' do
|
95
|
+
it 'should work' do
|
96
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
97
|
+
end
|
98
|
+
end
|
99
|
+
|
94
100
|
end
|
@@ -187,6 +187,12 @@ describe Carbon::UserFile do
|
|
187
187
|
end
|
188
188
|
end
|
189
189
|
|
190
|
+
describe 'test attribute "audio_properties"' do
|
191
|
+
it 'should work' do
|
192
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
193
|
+
end
|
194
|
+
end
|
195
|
+
|
190
196
|
describe 'test attribute "request_id"' do
|
191
197
|
it 'should work' do
|
192
198
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: carbon_ruby_sdk
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.32
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Konfig
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-05-
|
11
|
+
date: 2024-05-20 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: faraday
|