carbon_ruby_sdk 0.1.30 → 0.1.31
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +13 -8
- data/lib/carbon_ruby_sdk/api/integrations_api.rb +14 -10
- data/lib/carbon_ruby_sdk/models/data_source_type.rb +2 -1
- data/lib/carbon_ruby_sdk/models/data_source_type_nullable.rb +2 -1
- data/lib/carbon_ruby_sdk/models/file_formats.rb +2 -1
- data/lib/carbon_ruby_sdk/models/file_formats_nullable.rb +2 -1
- data/lib/carbon_ruby_sdk/models/fresh_desk_connect_request.rb +14 -4
- data/lib/carbon_ruby_sdk/models/o_auth_url_request.rb +2 -2
- data/lib/carbon_ruby_sdk/models/raw_text_input.rb +19 -0
- 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/user_response.rb +20 -4
- data/lib/carbon_ruby_sdk/version.rb +1 -1
- data/spec/models/fresh_desk_connect_request_spec.rb +6 -0
- data/spec/models/user_response_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: fc47919261953d696f4d56ed93f1d2a18e707c65f65644f97e2702c82b27081f
|
|
4
|
+
data.tar.gz: 56291e500477dc4f57452b11a504e72f824357e283f08b06723333f2fe52cb4f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 882c31432619603fbd8e6b6c50ab04fc36857bd68713dff6fb3ee8f578895300910b5d3a9af83b96c4c25c88305406779db119dbc9953533cee853ae75ebc8db
|
|
7
|
+
data.tar.gz: 849af42ca5865e1a4c18fd0ecb345b12589e2a9214281c5b82247388d0636b71f362695a4067b68d46ddff113ae5fd1d5e58145f2797a6abba7165cf629d8c15
|
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
|
-
[](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.1.31)
|
|
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.31'
|
|
88
88
|
```
|
|
89
89
|
|
|
90
90
|
## Getting Started<a id="getting-started"></a>
|
|
@@ -1126,7 +1126,7 @@ set `VERTEX_MULTIMODAL` as an `embedding_model`. This model is used automaticall
|
|
|
1126
1126
|
|
|
1127
1127
|
```ruby
|
|
1128
1128
|
result = carbon.files.upload_text(
|
|
1129
|
-
contents: "
|
|
1129
|
+
contents: "aaaaa",
|
|
1130
1130
|
name: "string_example",
|
|
1131
1131
|
chunk_size: 1,
|
|
1132
1132
|
chunk_overlap: 1,
|
|
@@ -1202,7 +1202,7 @@ result = carbon.integrations.connect_data_source(
|
|
|
1202
1202
|
"prepend_filename_to_chunks" => false,
|
|
1203
1203
|
"sync_files_on_connection" => true,
|
|
1204
1204
|
"set_page_as_boundary" => false,
|
|
1205
|
-
"request_id" => "
|
|
1205
|
+
"request_id" => "b194468b-b547-46b9-98d6-e45c491bb8d0",
|
|
1206
1206
|
"enable_file_picker" => true,
|
|
1207
1207
|
"sync_source_items" => true,
|
|
1208
1208
|
"incremental_sync" => false,
|
|
@@ -1252,6 +1252,10 @@ result = carbon.integrations.connect_freshdesk(
|
|
|
1252
1252
|
sync_files_on_connection: true,
|
|
1253
1253
|
request_id: "string_example",
|
|
1254
1254
|
sync_source_items: true,
|
|
1255
|
+
file_sync_config: {
|
|
1256
|
+
"file_types" => ["ARTICLE"],
|
|
1257
|
+
"sync_attachments" => false,
|
|
1258
|
+
},
|
|
1255
1259
|
)
|
|
1256
1260
|
p result
|
|
1257
1261
|
```
|
|
@@ -1273,6 +1277,7 @@ p result
|
|
|
1273
1277
|
Enabling this flag will fetch all available content from the source to be listed
|
|
1274
1278
|
via list items endpoint
|
|
1275
1279
|
|
|
1280
|
+
##### file_sync_config: [`HelpdeskFileSyncConfigNullable`](./lib/carbon_ruby_sdk/models/helpdesk_file_sync_config_nullable.rb)<a id="file_sync_config-helpdeskfilesyncconfignullablelibcarbon_ruby_sdkmodelshelpdesk_file_sync_config_nullablerb"></a>
|
|
1276
1281
|
#### 🔄 Return<a id="🔄-return"></a>
|
|
1277
1282
|
|
|
1278
1283
|
[GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
|
|
@@ -1415,7 +1420,7 @@ result = carbon.integrations.get_oauth_url(
|
|
|
1415
1420
|
set_page_as_boundary: false,
|
|
1416
1421
|
data_source_id: 1,
|
|
1417
1422
|
connecting_new_account: false,
|
|
1418
|
-
request_id: "
|
|
1423
|
+
request_id: "fd8991d4-05d6-4fdd-92bf-9dccb96d5b92",
|
|
1419
1424
|
use_ocr: false,
|
|
1420
1425
|
parse_pdf_tables_with_ocr: false,
|
|
1421
1426
|
enable_file_picker: true,
|
|
@@ -1474,7 +1479,7 @@ Enable OCR for files that support it. Supported formats: pdf
|
|
|
1474
1479
|
##### parse_pdf_tables_with_ocr: `Boolean`<a id="parse_pdf_tables_with_ocr-boolean"></a>
|
|
1475
1480
|
##### enable_file_picker: `Boolean`<a id="enable_file_picker-boolean"></a>
|
|
1476
1481
|
Enable integration's file picker for sources that support it. Supported sources:
|
|
1477
|
-
|
|
1482
|
+
ONEDRIVE, SHAREPOINT, DROPBOX, BOX, GOOGLE_DRIVE
|
|
1478
1483
|
|
|
1479
1484
|
##### sync_source_items: `Boolean`<a id="sync_source_items-boolean"></a>
|
|
1480
1485
|
Enabling this flag will fetch all available content from the source to be listed
|
|
@@ -1736,7 +1741,7 @@ result = carbon.integrations.sync_confluence(
|
|
|
1736
1741
|
prepend_filename_to_chunks: false,
|
|
1737
1742
|
max_items_per_chunk: 1,
|
|
1738
1743
|
set_page_as_boundary: false,
|
|
1739
|
-
request_id: "
|
|
1744
|
+
request_id: "fdb7ec68-6f04-49d2-adb3-fc5ae9f30a14",
|
|
1740
1745
|
use_ocr: false,
|
|
1741
1746
|
parse_pdf_tables_with_ocr: false,
|
|
1742
1747
|
incremental_sync: false,
|
|
@@ -1837,7 +1842,7 @@ result = carbon.integrations.sync_files(
|
|
|
1837
1842
|
prepend_filename_to_chunks: false,
|
|
1838
1843
|
max_items_per_chunk: 1,
|
|
1839
1844
|
set_page_as_boundary: false,
|
|
1840
|
-
request_id: "
|
|
1845
|
+
request_id: "fdb7ec68-6f04-49d2-adb3-fc5ae9f30a14",
|
|
1841
1846
|
use_ocr: false,
|
|
1842
1847
|
parse_pdf_tables_with_ocr: false,
|
|
1843
1848
|
incremental_sync: false,
|
|
@@ -132,9 +132,10 @@ module Carbon
|
|
|
132
132
|
# @param sync_files_on_connection [Boolean]
|
|
133
133
|
# @param request_id [String]
|
|
134
134
|
# @param sync_source_items [Boolean] Enabling this flag will fetch all available content from the source to be listed via list items endpoint
|
|
135
|
+
# @param file_sync_config [HelpdeskFileSyncConfigNullable]
|
|
135
136
|
# @param body [FreshDeskConnectRequest]
|
|
136
137
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
|
137
|
-
def connect_freshdesk(domain:, api_key:, tags: SENTINEL, 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: SENTINEL, sync_source_items: true, extra: {})
|
|
138
|
+
def connect_freshdesk(domain:, api_key:, tags: SENTINEL, 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: SENTINEL, sync_source_items: true, file_sync_config: SENTINEL, extra: {})
|
|
138
139
|
_body = {}
|
|
139
140
|
_body[:tags] = tags if tags != SENTINEL
|
|
140
141
|
_body[:domain] = domain if domain != SENTINEL
|
|
@@ -148,6 +149,7 @@ module Carbon
|
|
|
148
149
|
_body[:sync_files_on_connection] = sync_files_on_connection if sync_files_on_connection != SENTINEL
|
|
149
150
|
_body[:request_id] = request_id if request_id != SENTINEL
|
|
150
151
|
_body[:sync_source_items] = sync_source_items if sync_source_items != SENTINEL
|
|
152
|
+
_body[:file_sync_config] = file_sync_config if file_sync_config != SENTINEL
|
|
151
153
|
fresh_desk_connect_request = _body
|
|
152
154
|
api_response = connect_freshdesk_with_http_info_impl(fresh_desk_connect_request, extra)
|
|
153
155
|
api_response.data
|
|
@@ -173,9 +175,10 @@ module Carbon
|
|
|
173
175
|
# @param sync_files_on_connection [Boolean]
|
|
174
176
|
# @param request_id [String]
|
|
175
177
|
# @param sync_source_items [Boolean] Enabling this flag will fetch all available content from the source to be listed via list items endpoint
|
|
178
|
+
# @param file_sync_config [HelpdeskFileSyncConfigNullable]
|
|
176
179
|
# @param body [FreshDeskConnectRequest]
|
|
177
180
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
|
178
|
-
def connect_freshdesk_with_http_info(domain:, api_key:, tags: SENTINEL, 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: SENTINEL, sync_source_items: true, extra: {})
|
|
181
|
+
def connect_freshdesk_with_http_info(domain:, api_key:, tags: SENTINEL, 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: SENTINEL, sync_source_items: true, file_sync_config: SENTINEL, extra: {})
|
|
179
182
|
_body = {}
|
|
180
183
|
_body[:tags] = tags if tags != SENTINEL
|
|
181
184
|
_body[:domain] = domain if domain != SENTINEL
|
|
@@ -189,6 +192,7 @@ module Carbon
|
|
|
189
192
|
_body[:sync_files_on_connection] = sync_files_on_connection if sync_files_on_connection != SENTINEL
|
|
190
193
|
_body[:request_id] = request_id if request_id != SENTINEL
|
|
191
194
|
_body[:sync_source_items] = sync_source_items if sync_source_items != SENTINEL
|
|
195
|
+
_body[:file_sync_config] = file_sync_config if file_sync_config != SENTINEL
|
|
192
196
|
fresh_desk_connect_request = _body
|
|
193
197
|
connect_freshdesk_with_http_info_impl(fresh_desk_connect_request, extra)
|
|
194
198
|
end
|
|
@@ -557,13 +561,13 @@ module Carbon
|
|
|
557
561
|
# @param request_id [String] This request id will be added to all files that get synced using the generated OAuth URL
|
|
558
562
|
# @param use_ocr [Boolean] Enable OCR for files that support it. Supported formats: pdf
|
|
559
563
|
# @param parse_pdf_tables_with_ocr [Boolean]
|
|
560
|
-
# @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: ONEDRIVE, SHAREPOINT, DROPBOX, BOX, GOOGLE_DRIVE
|
|
561
565
|
# @param sync_source_items [Boolean] Enabling this flag will fetch all available content from the source to be listed via list items endpoint
|
|
562
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.
|
|
563
567
|
# @param file_sync_config [HelpdeskFileSyncConfigNullable]
|
|
564
568
|
# @param body [OAuthURLRequest]
|
|
565
569
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
|
566
|
-
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: 'fd8991d4-05d6-4fdd-92bf-9dccb96d5b92', 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: {})
|
|
567
571
|
_body = {}
|
|
568
572
|
_body[:tags] = tags if tags != SENTINEL
|
|
569
573
|
_body[:scope] = scope if scope != SENTINEL
|
|
@@ -625,13 +629,13 @@ module Carbon
|
|
|
625
629
|
# @param request_id [String] This request id will be added to all files that get synced using the generated OAuth URL
|
|
626
630
|
# @param use_ocr [Boolean] Enable OCR for files that support it. Supported formats: pdf
|
|
627
631
|
# @param parse_pdf_tables_with_ocr [Boolean]
|
|
628
|
-
# @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: ONEDRIVE, SHAREPOINT, DROPBOX, BOX, GOOGLE_DRIVE
|
|
629
633
|
# @param sync_source_items [Boolean] Enabling this flag will fetch all available content from the source to be listed via list items endpoint
|
|
630
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.
|
|
631
635
|
# @param file_sync_config [HelpdeskFileSyncConfigNullable]
|
|
632
636
|
# @param body [OAuthURLRequest]
|
|
633
637
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
|
634
|
-
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: 'fd8991d4-05d6-4fdd-92bf-9dccb96d5b92', 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: {})
|
|
635
639
|
_body = {}
|
|
636
640
|
_body[:tags] = tags if tags != SENTINEL
|
|
637
641
|
_body[:scope] = scope if scope != SENTINEL
|
|
@@ -1427,7 +1431,7 @@ module Carbon
|
|
|
1427
1431
|
# @param file_sync_config [HelpdeskGlobalFileSyncConfigNullable]
|
|
1428
1432
|
# @param body [SyncFilesRequest]
|
|
1429
1433
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
|
1430
|
-
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: 'fdb7ec68-6f04-49d2-adb3-fc5ae9f30a14', use_ocr: false, parse_pdf_tables_with_ocr: false, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
|
|
1431
1435
|
_body = {}
|
|
1432
1436
|
_body[:tags] = tags if tags != SENTINEL
|
|
1433
1437
|
_body[:data_source_id] = data_source_id if data_source_id != SENTINEL
|
|
@@ -1475,7 +1479,7 @@ module Carbon
|
|
|
1475
1479
|
# @param file_sync_config [HelpdeskGlobalFileSyncConfigNullable]
|
|
1476
1480
|
# @param body [SyncFilesRequest]
|
|
1477
1481
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
|
1478
|
-
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: 'fdb7ec68-6f04-49d2-adb3-fc5ae9f30a14', use_ocr: false, parse_pdf_tables_with_ocr: false, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
|
|
1479
1483
|
_body = {}
|
|
1480
1484
|
_body[:tags] = tags if tags != SENTINEL
|
|
1481
1485
|
_body[:data_source_id] = data_source_id if data_source_id != SENTINEL
|
|
@@ -1683,7 +1687,7 @@ module Carbon
|
|
|
1683
1687
|
# @param file_sync_config [HelpdeskGlobalFileSyncConfigNullable]
|
|
1684
1688
|
# @param body [SyncFilesRequest]
|
|
1685
1689
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
|
1686
|
-
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: 'fdb7ec68-6f04-49d2-adb3-fc5ae9f30a14', use_ocr: false, parse_pdf_tables_with_ocr: false, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
|
|
1687
1691
|
_body = {}
|
|
1688
1692
|
_body[:tags] = tags if tags != SENTINEL
|
|
1689
1693
|
_body[:data_source_id] = data_source_id if data_source_id != SENTINEL
|
|
@@ -1731,7 +1735,7 @@ module Carbon
|
|
|
1731
1735
|
# @param file_sync_config [HelpdeskGlobalFileSyncConfigNullable]
|
|
1732
1736
|
# @param body [SyncFilesRequest]
|
|
1733
1737
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
|
1734
|
-
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: 'fdb7ec68-6f04-49d2-adb3-fc5ae9f30a14', use_ocr: false, parse_pdf_tables_with_ocr: false, incremental_sync: false, file_sync_config: SENTINEL, extra: {})
|
|
1735
1739
|
_body = {}
|
|
1736
1740
|
_body[:tags] = tags if tags != SENTINEL
|
|
1737
1741
|
_body[:data_source_id] = data_source_id if data_source_id != SENTINEL
|
|
@@ -35,6 +35,7 @@ module Carbon
|
|
|
35
35
|
MD = "MD".freeze
|
|
36
36
|
RTF = "RTF".freeze
|
|
37
37
|
JSON = "JSON".freeze
|
|
38
|
+
HTML = "HTML".freeze
|
|
38
39
|
RAW_TEXT = "RAW_TEXT".freeze
|
|
39
40
|
WEB_SCRAPE = "WEB_SCRAPE".freeze
|
|
40
41
|
RSS_FEED = "RSS_FEED".freeze
|
|
@@ -58,7 +59,7 @@ module Carbon
|
|
|
58
59
|
WEBM = "WEBM".freeze
|
|
59
60
|
|
|
60
61
|
def self.all_vars
|
|
61
|
-
@all_vars ||= [GOOGLE_DRIVE, NOTION, NOTION_DATABASE, INTERCOM, DROPBOX, ONEDRIVE, SHAREPOINT, CONFLUENCE, BOX, ZENDESK, ZOTERO, S3, GMAIL, OUTLOOK, TEXT, CSV, TSV, PDF, DOCX, PPTX, XLSX, MD, RTF, JSON, RAW_TEXT, WEB_SCRAPE, RSS_FEED, FRESHDESK, GITBOOK, SALESFORCE, GITHUB, JPG, PNG, JPEG, MP3, MP4, MP2, AAC, WAV, FLAC, PCM, M4_A, OGG, OPUS, WEBM].freeze
|
|
62
|
+
@all_vars ||= [GOOGLE_DRIVE, NOTION, NOTION_DATABASE, INTERCOM, DROPBOX, ONEDRIVE, SHAREPOINT, CONFLUENCE, BOX, ZENDESK, ZOTERO, S3, GMAIL, OUTLOOK, TEXT, CSV, TSV, PDF, DOCX, PPTX, XLSX, MD, RTF, JSON, HTML, RAW_TEXT, WEB_SCRAPE, RSS_FEED, FRESHDESK, GITBOOK, SALESFORCE, GITHUB, JPG, PNG, JPEG, MP3, MP4, MP2, AAC, WAV, FLAC, PCM, M4_A, OGG, OPUS, WEBM].freeze
|
|
62
63
|
end
|
|
63
64
|
|
|
64
65
|
# Builds the enum from string
|
|
@@ -35,6 +35,7 @@ module Carbon
|
|
|
35
35
|
MD = "MD".freeze
|
|
36
36
|
RTF = "RTF".freeze
|
|
37
37
|
JSON = "JSON".freeze
|
|
38
|
+
HTML = "HTML".freeze
|
|
38
39
|
RAW_TEXT = "RAW_TEXT".freeze
|
|
39
40
|
WEB_SCRAPE = "WEB_SCRAPE".freeze
|
|
40
41
|
RSS_FEED = "RSS_FEED".freeze
|
|
@@ -58,7 +59,7 @@ module Carbon
|
|
|
58
59
|
WEBM = "WEBM".freeze
|
|
59
60
|
|
|
60
61
|
def self.all_vars
|
|
61
|
-
@all_vars ||= [GOOGLE_DRIVE, NOTION, NOTION_DATABASE, INTERCOM, DROPBOX, ONEDRIVE, SHAREPOINT, CONFLUENCE, BOX, ZENDESK, ZOTERO, S3, GMAIL, OUTLOOK, TEXT, CSV, TSV, PDF, DOCX, PPTX, XLSX, MD, RTF, JSON, RAW_TEXT, WEB_SCRAPE, RSS_FEED, FRESHDESK, GITBOOK, SALESFORCE, GITHUB, JPG, PNG, JPEG, MP3, MP4, MP2, AAC, WAV, FLAC, PCM, M4_A, OGG, OPUS, WEBM].freeze
|
|
62
|
+
@all_vars ||= [GOOGLE_DRIVE, NOTION, NOTION_DATABASE, INTERCOM, DROPBOX, ONEDRIVE, SHAREPOINT, CONFLUENCE, BOX, ZENDESK, ZOTERO, S3, GMAIL, OUTLOOK, TEXT, CSV, TSV, PDF, DOCX, PPTX, XLSX, MD, RTF, JSON, HTML, RAW_TEXT, WEB_SCRAPE, RSS_FEED, FRESHDESK, GITBOOK, SALESFORCE, GITHUB, JPG, PNG, JPEG, MP3, MP4, MP2, AAC, WAV, FLAC, PCM, M4_A, OGG, OPUS, WEBM].freeze
|
|
62
63
|
end
|
|
63
64
|
|
|
64
65
|
# Builds the enum from string
|
|
@@ -21,6 +21,7 @@ module Carbon
|
|
|
21
21
|
MD = "MD".freeze
|
|
22
22
|
RTF = "RTF".freeze
|
|
23
23
|
JSON = "JSON".freeze
|
|
24
|
+
HTML = "HTML".freeze
|
|
24
25
|
NOTION = "NOTION".freeze
|
|
25
26
|
GOOGLE_DOCS = "GOOGLE_DOCS".freeze
|
|
26
27
|
GOOGLE_SHEETS = "GOOGLE_SHEETS".freeze
|
|
@@ -52,7 +53,7 @@ module Carbon
|
|
|
52
53
|
WEBM = "WEBM".freeze
|
|
53
54
|
|
|
54
55
|
def self.all_vars
|
|
55
|
-
@all_vars ||= [TXT, CSV, TSV, PDF, DOCX, PPTX, XLSX, MD, RTF, JSON, NOTION, GOOGLE_DOCS, GOOGLE_SHEETS, GOOGLE_SLIDES, INTERCOM, CONFLUENCE, RSS_FEED, GMAIL, OUTLOOK, ZENDESK, FRESHDESK, WEB_SCRAPE, GITBOOK, SALESFORCE, GITHUB, JPG, PNG, MPEG, MP3, MP4, MP2, AAC, WAV, FLAC, PCM, M4_A, OGG, OPUS, WEBM].freeze
|
|
56
|
+
@all_vars ||= [TXT, CSV, TSV, PDF, DOCX, PPTX, XLSX, MD, RTF, JSON, HTML, NOTION, GOOGLE_DOCS, GOOGLE_SHEETS, GOOGLE_SLIDES, INTERCOM, CONFLUENCE, RSS_FEED, GMAIL, OUTLOOK, ZENDESK, FRESHDESK, WEB_SCRAPE, GITBOOK, SALESFORCE, GITHUB, JPG, PNG, MPEG, MP3, MP4, MP2, AAC, WAV, FLAC, PCM, M4_A, OGG, OPUS, WEBM].freeze
|
|
56
57
|
end
|
|
57
58
|
|
|
58
59
|
# Builds the enum from string
|
|
@@ -21,6 +21,7 @@ module Carbon
|
|
|
21
21
|
MD = "MD".freeze
|
|
22
22
|
RTF = "RTF".freeze
|
|
23
23
|
JSON = "JSON".freeze
|
|
24
|
+
HTML = "HTML".freeze
|
|
24
25
|
NOTION = "NOTION".freeze
|
|
25
26
|
GOOGLE_DOCS = "GOOGLE_DOCS".freeze
|
|
26
27
|
GOOGLE_SHEETS = "GOOGLE_SHEETS".freeze
|
|
@@ -52,7 +53,7 @@ module Carbon
|
|
|
52
53
|
WEBM = "WEBM".freeze
|
|
53
54
|
|
|
54
55
|
def self.all_vars
|
|
55
|
-
@all_vars ||= [TXT, CSV, TSV, PDF, DOCX, PPTX, XLSX, MD, RTF, JSON, NOTION, GOOGLE_DOCS, GOOGLE_SHEETS, GOOGLE_SLIDES, INTERCOM, CONFLUENCE, RSS_FEED, GMAIL, OUTLOOK, ZENDESK, FRESHDESK, WEB_SCRAPE, GITBOOK, SALESFORCE, GITHUB, JPG, PNG, MPEG, MP3, MP4, MP2, AAC, WAV, FLAC, PCM, M4_A, OGG, OPUS, WEBM].freeze
|
|
56
|
+
@all_vars ||= [TXT, CSV, TSV, PDF, DOCX, PPTX, XLSX, MD, RTF, JSON, HTML, NOTION, GOOGLE_DOCS, GOOGLE_SHEETS, GOOGLE_SLIDES, INTERCOM, CONFLUENCE, RSS_FEED, GMAIL, OUTLOOK, ZENDESK, FRESHDESK, WEB_SCRAPE, GITBOOK, SALESFORCE, GITHUB, JPG, PNG, MPEG, MP3, MP4, MP2, AAC, WAV, FLAC, PCM, M4_A, OGG, OPUS, WEBM].freeze
|
|
56
57
|
end
|
|
57
58
|
|
|
58
59
|
# Builds the enum from string
|
|
@@ -36,6 +36,8 @@ module Carbon
|
|
|
36
36
|
# Enabling this flag will fetch all available content from the source to be listed via list items endpoint
|
|
37
37
|
attr_accessor :sync_source_items
|
|
38
38
|
|
|
39
|
+
attr_accessor :file_sync_config
|
|
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
|
:'prepend_filename_to_chunks' => :'prepend_filename_to_chunks',
|
|
51
53
|
:'sync_files_on_connection' => :'sync_files_on_connection',
|
|
52
54
|
:'request_id' => :'request_id',
|
|
53
|
-
:'sync_source_items' => :'sync_source_items'
|
|
55
|
+
:'sync_source_items' => :'sync_source_items',
|
|
56
|
+
:'file_sync_config' => :'file_sync_config'
|
|
54
57
|
}
|
|
55
58
|
end
|
|
56
59
|
|
|
@@ -73,7 +76,8 @@ module Carbon
|
|
|
73
76
|
:'prepend_filename_to_chunks' => :'Boolean',
|
|
74
77
|
:'sync_files_on_connection' => :'Boolean',
|
|
75
78
|
:'request_id' => :'String',
|
|
76
|
-
:'sync_source_items' => :'Boolean'
|
|
79
|
+
:'sync_source_items' => :'Boolean',
|
|
80
|
+
:'file_sync_config' => :'HelpdeskFileSyncConfigNullable'
|
|
77
81
|
}
|
|
78
82
|
end
|
|
79
83
|
|
|
@@ -89,6 +93,7 @@ module Carbon
|
|
|
89
93
|
:'prepend_filename_to_chunks',
|
|
90
94
|
:'sync_files_on_connection',
|
|
91
95
|
:'request_id',
|
|
96
|
+
:'file_sync_config'
|
|
92
97
|
])
|
|
93
98
|
end
|
|
94
99
|
|
|
@@ -170,6 +175,10 @@ module Carbon
|
|
|
170
175
|
else
|
|
171
176
|
self.sync_source_items = true
|
|
172
177
|
end
|
|
178
|
+
|
|
179
|
+
if attributes.key?(:'file_sync_config')
|
|
180
|
+
self.file_sync_config = attributes[:'file_sync_config']
|
|
181
|
+
end
|
|
173
182
|
end
|
|
174
183
|
|
|
175
184
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -211,7 +220,8 @@ module Carbon
|
|
|
211
220
|
prepend_filename_to_chunks == o.prepend_filename_to_chunks &&
|
|
212
221
|
sync_files_on_connection == o.sync_files_on_connection &&
|
|
213
222
|
request_id == o.request_id &&
|
|
214
|
-
sync_source_items == o.sync_source_items
|
|
223
|
+
sync_source_items == o.sync_source_items &&
|
|
224
|
+
file_sync_config == o.file_sync_config
|
|
215
225
|
end
|
|
216
226
|
|
|
217
227
|
# @see the `==` method
|
|
@@ -223,7 +233,7 @@ module Carbon
|
|
|
223
233
|
# Calculates hash code according to all attributes.
|
|
224
234
|
# @return [Integer] Hash code
|
|
225
235
|
def hash
|
|
226
|
-
[tags, domain, api_key, chunk_size, chunk_overlap, skip_embedding_generation, embedding_model, generate_sparse_vectors, prepend_filename_to_chunks, sync_files_on_connection, request_id, sync_source_items].hash
|
|
236
|
+
[tags, domain, api_key, chunk_size, chunk_overlap, skip_embedding_generation, embedding_model, generate_sparse_vectors, prepend_filename_to_chunks, sync_files_on_connection, request_id, sync_source_items, file_sync_config].hash
|
|
227
237
|
end
|
|
228
238
|
|
|
229
239
|
# Builds the object from hash
|
|
@@ -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: ONEDRIVE, SHAREPOINT, DROPBOX, BOX, 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 = 'fd8991d4-05d6-4fdd-92bf-9dccb96d5b92'
|
|
283
283
|
end
|
|
284
284
|
|
|
285
285
|
if attributes.key?(:'use_ocr')
|
|
@@ -134,6 +134,10 @@ module Carbon
|
|
|
134
134
|
invalid_properties.push('invalid value for "contents", contents cannot be nil.')
|
|
135
135
|
end
|
|
136
136
|
|
|
137
|
+
if @contents.to_s.length < 5
|
|
138
|
+
invalid_properties.push('invalid value for "contents", the character length must be great than or equal to 5.')
|
|
139
|
+
end
|
|
140
|
+
|
|
137
141
|
invalid_properties
|
|
138
142
|
end
|
|
139
143
|
|
|
@@ -141,9 +145,24 @@ module Carbon
|
|
|
141
145
|
# @return true if the model is valid
|
|
142
146
|
def valid?
|
|
143
147
|
return false if @contents.nil?
|
|
148
|
+
return false if @contents.to_s.length < 5
|
|
144
149
|
true
|
|
145
150
|
end
|
|
146
151
|
|
|
152
|
+
# Custom attribute writer method with validation
|
|
153
|
+
# @param [Object] contents Value to be assigned
|
|
154
|
+
def contents=(contents)
|
|
155
|
+
if contents.nil?
|
|
156
|
+
fail ArgumentError, 'contents cannot be nil'
|
|
157
|
+
end
|
|
158
|
+
|
|
159
|
+
if contents.to_s.length < 5
|
|
160
|
+
fail ArgumentError, 'invalid value for "contents", the character length must be great than or equal to 5.'
|
|
161
|
+
end
|
|
162
|
+
|
|
163
|
+
@contents = contents
|
|
164
|
+
end
|
|
165
|
+
|
|
147
166
|
# Checks equality by comparing each attribute.
|
|
148
167
|
# @param [Object] Object to be compared
|
|
149
168
|
def ==(o)
|
|
@@ -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 = 'fdb7ec68-6f04-49d2-adb3-fc5ae9f30a14'
|
|
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 = 'b194468b-b547-46b9-98d6-e45c491bb8d0'
|
|
186
186
|
end
|
|
187
187
|
|
|
188
188
|
if attributes.key?(:'enable_file_picker')
|
|
@@ -35,6 +35,8 @@ module Carbon
|
|
|
35
35
|
|
|
36
36
|
attr_accessor :custom_limits
|
|
37
37
|
|
|
38
|
+
attr_accessor :auto_sync_enabled_sources
|
|
39
|
+
|
|
38
40
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
39
41
|
def self.attribute_map
|
|
40
42
|
{
|
|
@@ -49,7 +51,8 @@ module Carbon
|
|
|
49
51
|
:'num_tokens_synced' => :'num_tokens_synced',
|
|
50
52
|
:'unique_file_tags' => :'unique_file_tags',
|
|
51
53
|
:'enabled_features' => :'enabled_features',
|
|
52
|
-
:'custom_limits' => :'custom_limits'
|
|
54
|
+
:'custom_limits' => :'custom_limits',
|
|
55
|
+
:'auto_sync_enabled_sources' => :'auto_sync_enabled_sources'
|
|
53
56
|
}
|
|
54
57
|
end
|
|
55
58
|
|
|
@@ -72,7 +75,8 @@ module Carbon
|
|
|
72
75
|
:'num_tokens_synced' => :'Integer',
|
|
73
76
|
:'unique_file_tags' => :'Array<Object>',
|
|
74
77
|
:'enabled_features' => :'Object',
|
|
75
|
-
:'custom_limits' => :'Object'
|
|
78
|
+
:'custom_limits' => :'Object',
|
|
79
|
+
:'auto_sync_enabled_sources' => :'Array<Object>'
|
|
76
80
|
}
|
|
77
81
|
end
|
|
78
82
|
|
|
@@ -148,6 +152,12 @@ module Carbon
|
|
|
148
152
|
if attributes.key?(:'custom_limits')
|
|
149
153
|
self.custom_limits = attributes[:'custom_limits']
|
|
150
154
|
end
|
|
155
|
+
|
|
156
|
+
if attributes.key?(:'auto_sync_enabled_sources')
|
|
157
|
+
if (value = attributes[:'auto_sync_enabled_sources']).is_a?(Array)
|
|
158
|
+
self.auto_sync_enabled_sources = value
|
|
159
|
+
end
|
|
160
|
+
end
|
|
151
161
|
end
|
|
152
162
|
|
|
153
163
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -194,6 +204,10 @@ module Carbon
|
|
|
194
204
|
invalid_properties.push('invalid value for "custom_limits", custom_limits cannot be nil.')
|
|
195
205
|
end
|
|
196
206
|
|
|
207
|
+
if @auto_sync_enabled_sources.nil?
|
|
208
|
+
invalid_properties.push('invalid value for "auto_sync_enabled_sources", auto_sync_enabled_sources cannot be nil.')
|
|
209
|
+
end
|
|
210
|
+
|
|
197
211
|
invalid_properties
|
|
198
212
|
end
|
|
199
213
|
|
|
@@ -210,6 +224,7 @@ module Carbon
|
|
|
210
224
|
return false if @num_tokens_synced.nil?
|
|
211
225
|
return false if @unique_file_tags.nil?
|
|
212
226
|
return false if @custom_limits.nil?
|
|
227
|
+
return false if @auto_sync_enabled_sources.nil?
|
|
213
228
|
true
|
|
214
229
|
end
|
|
215
230
|
|
|
@@ -229,7 +244,8 @@ module Carbon
|
|
|
229
244
|
num_tokens_synced == o.num_tokens_synced &&
|
|
230
245
|
unique_file_tags == o.unique_file_tags &&
|
|
231
246
|
enabled_features == o.enabled_features &&
|
|
232
|
-
custom_limits == o.custom_limits
|
|
247
|
+
custom_limits == o.custom_limits &&
|
|
248
|
+
auto_sync_enabled_sources == o.auto_sync_enabled_sources
|
|
233
249
|
end
|
|
234
250
|
|
|
235
251
|
# @see the `==` method
|
|
@@ -241,7 +257,7 @@ module Carbon
|
|
|
241
257
|
# Calculates hash code according to all attributes.
|
|
242
258
|
# @return [Integer] Hash code
|
|
243
259
|
def hash
|
|
244
|
-
[id, organization_id, organization_supplied_user_id, created_at, updated_at, deleted_at, num_files_synced, num_characters_synced, num_tokens_synced, unique_file_tags, enabled_features, custom_limits].hash
|
|
260
|
+
[id, organization_id, organization_supplied_user_id, created_at, updated_at, deleted_at, num_files_synced, num_characters_synced, num_tokens_synced, unique_file_tags, enabled_features, custom_limits, auto_sync_enabled_sources].hash
|
|
245
261
|
end
|
|
246
262
|
|
|
247
263
|
# Builds the object from hash
|
|
@@ -91,4 +91,10 @@ describe Carbon::FreshDeskConnectRequest do
|
|
|
91
91
|
end
|
|
92
92
|
end
|
|
93
93
|
|
|
94
|
+
describe 'test attribute "file_sync_config"' 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
|
|
@@ -91,4 +91,10 @@ describe Carbon::UserResponse do
|
|
|
91
91
|
end
|
|
92
92
|
end
|
|
93
93
|
|
|
94
|
+
describe 'test attribute "auto_sync_enabled_sources"' 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
|
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.31
|
|
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-17 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: faraday
|