carbon_ruby_sdk 0.1.2 → 0.1.4
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 +29 -6
- data/lib/carbon_ruby_sdk/api/files_api.rb +6 -2
- data/lib/carbon_ruby_sdk/api/integrations_api.rb +58 -10
- data/lib/carbon_ruby_sdk/models/delete_files_query_input.rb +15 -4
- data/lib/carbon_ruby_sdk/models/file_formats.rb +1 -2
- data/lib/carbon_ruby_sdk/models/file_formats_nullable.rb +1 -2
- data/lib/carbon_ruby_sdk/models/fresh_desk_connect_request.rb +17 -5
- data/lib/carbon_ruby_sdk/models/gitbook_connect_request.rb +97 -4
- data/lib/carbon_ruby_sdk/models/ids_property.rb +226 -0
- data/lib/carbon_ruby_sdk/models/o_auth_url_request.rb +1 -1
- data/lib/carbon_ruby_sdk/models/sync_files_ids.rb +234 -0
- data/lib/carbon_ruby_sdk/models/sync_files_request.rb +2 -4
- data/lib/carbon_ruby_sdk/version.rb +1 -1
- data/lib/carbon_ruby_sdk.rb +2 -0
- data/spec/api/integrations_api_spec.rb +1 -0
- data/spec/models/delete_files_query_input_spec.rb +6 -0
- data/spec/models/fresh_desk_connect_request_spec.rb +6 -0
- data/spec/models/gitbook_connect_request_spec.rb +48 -0
- data/spec/models/ids_property_spec.rb +22 -0
- data/spec/models/sync_files_ids_spec.rb +34 -0
- metadata +8 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e19f8989c416d45b0cf4dc8a5b261b1f0b37d5111084c20bd48dac1f3a8ae795
|
4
|
+
data.tar.gz: be5d4f7386b026b0dd0810f65ff4b916bcad4aeacb3105b513611814cdfe2524
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f5a05f4d3880897ddffc218c189009c0fecf396d14b7c3634951e2a24d508824a99f8e5f2eb107207d7cd157dc289ac2cb0feb4686aac5e68d237d0c9c2962d8
|
7
|
+
data.tar.gz: 494d7bb4ecaff69ce143ad63e4285d7c2a1c91bdde8b62d9231c3bb00f29ebcc013bc1ccdc27316518032143ab56772ff70e7d5593fe35d8a21e6ccdbad88cae
|
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.4)
|
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.
|
80
|
+
gem 'carbon_ruby_sdk', '~> 0.1.4'
|
81
81
|
```
|
82
82
|
|
83
83
|
## Getting Started<a id="getting-started"></a>
|
@@ -643,6 +643,7 @@ result = carbon.files.delete_many(
|
|
643
643
|
],
|
644
644
|
delete_non_synced_only: false,
|
645
645
|
send_webhook: false,
|
646
|
+
delete_child_files: false,
|
646
647
|
)
|
647
648
|
p result
|
648
649
|
```
|
@@ -653,6 +654,7 @@ p result
|
|
653
654
|
##### sync_statuses: Array<[`ExternalFileSyncStatuses`](./lib/carbon_ruby_sdk/models/external_file_sync_statuses.rb)><a id="sync_statuses-array"></a>
|
654
655
|
##### delete_non_synced_only: `Boolean`<a id="delete_non_synced_only-boolean"></a>
|
655
656
|
##### send_webhook: `Boolean`<a id="send_webhook-boolean"></a>
|
657
|
+
##### delete_child_files: `Boolean`<a id="delete_child_files-boolean"></a>
|
656
658
|
#### 🔄 Return<a id="🔄-return"></a>
|
657
659
|
|
658
660
|
[GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
|
@@ -1132,6 +1134,7 @@ result = carbon.integrations.connect_freshdesk(
|
|
1132
1134
|
embedding_model: "OPENAI",
|
1133
1135
|
generate_sparse_vectors: false,
|
1134
1136
|
prepend_filename_to_chunks: false,
|
1137
|
+
sync_files_on_connection: true,
|
1135
1138
|
)
|
1136
1139
|
p result
|
1137
1140
|
```
|
@@ -1147,6 +1150,7 @@ p result
|
|
1147
1150
|
##### embedding_model: [`EmbeddingGeneratorsNullable`](./lib/carbon_ruby_sdk/models/embedding_generators_nullable.rb)<a id="embedding_model-embeddinggeneratorsnullablelibcarbon_ruby_sdkmodelsembedding_generators_nullablerb"></a>
|
1148
1151
|
##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
|
1149
1152
|
##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
|
1153
|
+
##### sync_files_on_connection: `Boolean`<a id="sync_files_on_connection-boolean"></a>
|
1150
1154
|
#### 🔄 Return<a id="🔄-return"></a>
|
1151
1155
|
|
1152
1156
|
[GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
|
@@ -1173,6 +1177,14 @@ need to specify the name of organization you will be syncing data from.
|
|
1173
1177
|
result = carbon.integrations.connect_gitbook(
|
1174
1178
|
organization: "string_example",
|
1175
1179
|
access_token: "string_example",
|
1180
|
+
tags: {},
|
1181
|
+
chunk_size: 1500,
|
1182
|
+
chunk_overlap: 20,
|
1183
|
+
skip_embedding_generation: false,
|
1184
|
+
embedding_model: "OPENAI",
|
1185
|
+
generate_sparse_vectors: false,
|
1186
|
+
prepend_filename_to_chunks: false,
|
1187
|
+
sync_files_on_connection: true,
|
1176
1188
|
)
|
1177
1189
|
p result
|
1178
1190
|
```
|
@@ -1181,6 +1193,14 @@ p result
|
|
1181
1193
|
|
1182
1194
|
##### organization: `String`<a id="organization-string"></a>
|
1183
1195
|
##### access_token: `String`<a id="access_token-string"></a>
|
1196
|
+
##### tags: `Object`<a id="tags-object"></a>
|
1197
|
+
##### chunk_size: `Integer`<a id="chunk_size-integer"></a>
|
1198
|
+
##### chunk_overlap: `Integer`<a id="chunk_overlap-integer"></a>
|
1199
|
+
##### skip_embedding_generation: `Boolean`<a id="skip_embedding_generation-boolean"></a>
|
1200
|
+
##### embedding_model: [`EmbeddingGenerators`](./lib/carbon_ruby_sdk/models/embedding_generators.rb)<a id="embedding_model-embeddinggeneratorslibcarbon_ruby_sdkmodelsembedding_generatorsrb"></a>
|
1201
|
+
##### generate_sparse_vectors: `Boolean`<a id="generate_sparse_vectors-boolean"></a>
|
1202
|
+
##### prepend_filename_to_chunks: `Boolean`<a id="prepend_filename_to_chunks-boolean"></a>
|
1203
|
+
##### sync_files_on_connection: `Boolean`<a id="sync_files_on_connection-boolean"></a>
|
1184
1204
|
#### 🔄 Return<a id="🔄-return"></a>
|
1185
1205
|
|
1186
1206
|
[GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
|
@@ -1254,7 +1274,7 @@ result = carbon.integrations.get_oauth_url(
|
|
1254
1274
|
prepend_filename_to_chunks: false,
|
1255
1275
|
max_items_per_chunk: 1,
|
1256
1276
|
salesforce_domain: "string_example",
|
1257
|
-
sync_files_on_connection:
|
1277
|
+
sync_files_on_connection: true,
|
1258
1278
|
set_page_as_boundary: false,
|
1259
1279
|
)
|
1260
1280
|
p result
|
@@ -1480,7 +1500,7 @@ p result
|
|
1480
1500
|
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1481
1501
|
|
1482
1502
|
##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
|
1483
|
-
##### ids:
|
1503
|
+
##### ids: [`IdsProperty`](./lib/carbon_ruby_sdk/models/ids_property.rb)<a id="ids-idspropertylibcarbon_ruby_sdkmodelsids_propertyrb"></a>
|
1484
1504
|
##### tags: `Object`<a id="tags-object"></a>
|
1485
1505
|
##### chunk_size: `Integer`<a id="chunk_size-integer"></a>
|
1486
1506
|
##### chunk_overlap: `Integer`<a id="chunk_overlap-integer"></a>
|
@@ -1534,7 +1554,10 @@ p result
|
|
1534
1554
|
|
1535
1555
|
### `carbon.integrations.sync_files`<a id="carbonintegrationssync_files"></a>
|
1536
1556
|
|
1537
|
-
|
1557
|
+
After listing files and folders via /integrations/items/sync and integrations/items/list, use the selected items' external ids
|
1558
|
+
as the ids in this endpoint to sync them into Carbon. Sharepoint items take an additional parameter root_id, which identifies
|
1559
|
+
the drive the file or folder is in and is stored in root_external_id. That additional paramter is optional and excluding it will
|
1560
|
+
tell the sync to assume the item is stored in the default Documents drive.
|
1538
1561
|
|
1539
1562
|
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1540
1563
|
|
@@ -1560,7 +1583,7 @@ p result
|
|
1560
1583
|
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1561
1584
|
|
1562
1585
|
##### data_source_id: `Integer`<a id="data_source_id-integer"></a>
|
1563
|
-
##### ids:
|
1586
|
+
##### ids: [`IdsProperty`](./lib/carbon_ruby_sdk/models/ids_property.rb)<a id="ids-idspropertylibcarbon_ruby_sdkmodelsids_propertyrb"></a>
|
1564
1587
|
##### tags: `Object`<a id="tags-object"></a>
|
1565
1588
|
##### chunk_size: `Integer`<a id="chunk_size-integer"></a>
|
1566
1589
|
##### chunk_overlap: `Integer`<a id="chunk_overlap-integer"></a>
|
@@ -319,14 +319,16 @@ module Carbon
|
|
319
319
|
# @param sync_statuses [Array<ExternalFileSyncStatuses>]
|
320
320
|
# @param delete_non_synced_only [Boolean]
|
321
321
|
# @param send_webhook [Boolean]
|
322
|
+
# @param delete_child_files [Boolean]
|
322
323
|
# @param body [DeleteFilesQueryInput]
|
323
324
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
324
|
-
def delete_many(file_ids: SENTINEL, sync_statuses: SENTINEL, delete_non_synced_only: false, send_webhook: false, extra: {})
|
325
|
+
def delete_many(file_ids: SENTINEL, sync_statuses: SENTINEL, delete_non_synced_only: false, send_webhook: false, delete_child_files: false, extra: {})
|
325
326
|
_body = {}
|
326
327
|
_body[:file_ids] = file_ids if file_ids != SENTINEL
|
327
328
|
_body[:sync_statuses] = sync_statuses if sync_statuses != SENTINEL
|
328
329
|
_body[:delete_non_synced_only] = delete_non_synced_only if delete_non_synced_only != SENTINEL
|
329
330
|
_body[:send_webhook] = send_webhook if send_webhook != SENTINEL
|
331
|
+
_body[:delete_child_files] = delete_child_files if delete_child_files != SENTINEL
|
330
332
|
delete_files_query_input = _body
|
331
333
|
api_response = delete_many_with_http_info_impl(delete_files_query_input, extra)
|
332
334
|
api_response.data
|
@@ -338,14 +340,16 @@ module Carbon
|
|
338
340
|
# @param sync_statuses [Array<ExternalFileSyncStatuses>]
|
339
341
|
# @param delete_non_synced_only [Boolean]
|
340
342
|
# @param send_webhook [Boolean]
|
343
|
+
# @param delete_child_files [Boolean]
|
341
344
|
# @param body [DeleteFilesQueryInput]
|
342
345
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
343
|
-
def delete_many_with_http_info(file_ids: SENTINEL, sync_statuses: SENTINEL, delete_non_synced_only: false, send_webhook: false, extra: {})
|
346
|
+
def delete_many_with_http_info(file_ids: SENTINEL, sync_statuses: SENTINEL, delete_non_synced_only: false, send_webhook: false, delete_child_files: false, extra: {})
|
344
347
|
_body = {}
|
345
348
|
_body[:file_ids] = file_ids if file_ids != SENTINEL
|
346
349
|
_body[:sync_statuses] = sync_statuses if sync_statuses != SENTINEL
|
347
350
|
_body[:delete_non_synced_only] = delete_non_synced_only if delete_non_synced_only != SENTINEL
|
348
351
|
_body[:send_webhook] = send_webhook if send_webhook != SENTINEL
|
352
|
+
_body[:delete_child_files] = delete_child_files if delete_child_files != SENTINEL
|
349
353
|
delete_files_query_input = _body
|
350
354
|
delete_many_with_http_info_impl(delete_files_query_input, extra)
|
351
355
|
end
|
@@ -33,9 +33,10 @@ module Carbon
|
|
33
33
|
# @param embedding_model [EmbeddingGeneratorsNullable]
|
34
34
|
# @param generate_sparse_vectors [Boolean]
|
35
35
|
# @param prepend_filename_to_chunks [Boolean]
|
36
|
+
# @param sync_files_on_connection [Boolean]
|
36
37
|
# @param body [FreshDeskConnectRequest]
|
37
38
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
38
|
-
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, extra: {})
|
39
|
+
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, extra: {})
|
39
40
|
_body = {}
|
40
41
|
_body[:tags] = tags if tags != SENTINEL
|
41
42
|
_body[:domain] = domain if domain != SENTINEL
|
@@ -46,6 +47,7 @@ module Carbon
|
|
46
47
|
_body[:embedding_model] = embedding_model if embedding_model != SENTINEL
|
47
48
|
_body[:generate_sparse_vectors] = generate_sparse_vectors if generate_sparse_vectors != SENTINEL
|
48
49
|
_body[:prepend_filename_to_chunks] = prepend_filename_to_chunks if prepend_filename_to_chunks != SENTINEL
|
50
|
+
_body[:sync_files_on_connection] = sync_files_on_connection if sync_files_on_connection != SENTINEL
|
49
51
|
fresh_desk_connect_request = _body
|
50
52
|
api_response = connect_freshdesk_with_http_info_impl(fresh_desk_connect_request, extra)
|
51
53
|
api_response.data
|
@@ -68,9 +70,10 @@ module Carbon
|
|
68
70
|
# @param embedding_model [EmbeddingGeneratorsNullable]
|
69
71
|
# @param generate_sparse_vectors [Boolean]
|
70
72
|
# @param prepend_filename_to_chunks [Boolean]
|
73
|
+
# @param sync_files_on_connection [Boolean]
|
71
74
|
# @param body [FreshDeskConnectRequest]
|
72
75
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
73
|
-
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, extra: {})
|
76
|
+
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, extra: {})
|
74
77
|
_body = {}
|
75
78
|
_body[:tags] = tags if tags != SENTINEL
|
76
79
|
_body[:domain] = domain if domain != SENTINEL
|
@@ -81,6 +84,7 @@ module Carbon
|
|
81
84
|
_body[:embedding_model] = embedding_model if embedding_model != SENTINEL
|
82
85
|
_body[:generate_sparse_vectors] = generate_sparse_vectors if generate_sparse_vectors != SENTINEL
|
83
86
|
_body[:prepend_filename_to_chunks] = prepend_filename_to_chunks if prepend_filename_to_chunks != SENTINEL
|
87
|
+
_body[:sync_files_on_connection] = sync_files_on_connection if sync_files_on_connection != SENTINEL
|
84
88
|
fresh_desk_connect_request = _body
|
85
89
|
connect_freshdesk_with_http_info_impl(fresh_desk_connect_request, extra)
|
86
90
|
end
|
@@ -163,12 +167,28 @@ module Carbon
|
|
163
167
|
#
|
164
168
|
# @param organization [String]
|
165
169
|
# @param access_token [String]
|
170
|
+
# @param tags [Object]
|
171
|
+
# @param chunk_size [Integer]
|
172
|
+
# @param chunk_overlap [Integer]
|
173
|
+
# @param skip_embedding_generation [Boolean]
|
174
|
+
# @param embedding_model [EmbeddingGenerators]
|
175
|
+
# @param generate_sparse_vectors [Boolean]
|
176
|
+
# @param prepend_filename_to_chunks [Boolean]
|
177
|
+
# @param sync_files_on_connection [Boolean]
|
166
178
|
# @param body [GitbookConnectRequest]
|
167
179
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
168
|
-
def connect_gitbook(organization:, access_token:, extra: {})
|
180
|
+
def connect_gitbook(organization:, access_token:, 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, extra: {})
|
169
181
|
_body = {}
|
182
|
+
_body[:tags] = tags if tags != SENTINEL
|
170
183
|
_body[:organization] = organization if organization != SENTINEL
|
171
184
|
_body[:access_token] = access_token if access_token != SENTINEL
|
185
|
+
_body[:chunk_size] = chunk_size if chunk_size != SENTINEL
|
186
|
+
_body[:chunk_overlap] = chunk_overlap if chunk_overlap != SENTINEL
|
187
|
+
_body[:skip_embedding_generation] = skip_embedding_generation if skip_embedding_generation != SENTINEL
|
188
|
+
_body[:embedding_model] = embedding_model if embedding_model != SENTINEL
|
189
|
+
_body[:generate_sparse_vectors] = generate_sparse_vectors if generate_sparse_vectors != SENTINEL
|
190
|
+
_body[:prepend_filename_to_chunks] = prepend_filename_to_chunks if prepend_filename_to_chunks != SENTINEL
|
191
|
+
_body[:sync_files_on_connection] = sync_files_on_connection if sync_files_on_connection != SENTINEL
|
172
192
|
gitbook_connect_request = _body
|
173
193
|
api_response = connect_gitbook_with_http_info_impl(gitbook_connect_request, extra)
|
174
194
|
api_response.data
|
@@ -183,12 +203,28 @@ module Carbon
|
|
183
203
|
#
|
184
204
|
# @param organization [String]
|
185
205
|
# @param access_token [String]
|
206
|
+
# @param tags [Object]
|
207
|
+
# @param chunk_size [Integer]
|
208
|
+
# @param chunk_overlap [Integer]
|
209
|
+
# @param skip_embedding_generation [Boolean]
|
210
|
+
# @param embedding_model [EmbeddingGenerators]
|
211
|
+
# @param generate_sparse_vectors [Boolean]
|
212
|
+
# @param prepend_filename_to_chunks [Boolean]
|
213
|
+
# @param sync_files_on_connection [Boolean]
|
186
214
|
# @param body [GitbookConnectRequest]
|
187
215
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
188
|
-
def connect_gitbook_with_http_info(organization:, access_token:, extra: {})
|
216
|
+
def connect_gitbook_with_http_info(organization:, access_token:, 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, extra: {})
|
189
217
|
_body = {}
|
218
|
+
_body[:tags] = tags if tags != SENTINEL
|
190
219
|
_body[:organization] = organization if organization != SENTINEL
|
191
220
|
_body[:access_token] = access_token if access_token != SENTINEL
|
221
|
+
_body[:chunk_size] = chunk_size if chunk_size != SENTINEL
|
222
|
+
_body[:chunk_overlap] = chunk_overlap if chunk_overlap != SENTINEL
|
223
|
+
_body[:skip_embedding_generation] = skip_embedding_generation if skip_embedding_generation != SENTINEL
|
224
|
+
_body[:embedding_model] = embedding_model if embedding_model != SENTINEL
|
225
|
+
_body[:generate_sparse_vectors] = generate_sparse_vectors if generate_sparse_vectors != SENTINEL
|
226
|
+
_body[:prepend_filename_to_chunks] = prepend_filename_to_chunks if prepend_filename_to_chunks != SENTINEL
|
227
|
+
_body[:sync_files_on_connection] = sync_files_on_connection if sync_files_on_connection != SENTINEL
|
192
228
|
gitbook_connect_request = _body
|
193
229
|
connect_gitbook_with_http_info_impl(gitbook_connect_request, extra)
|
194
230
|
end
|
@@ -397,7 +433,7 @@ module Carbon
|
|
397
433
|
# @param set_page_as_boundary [Boolean]
|
398
434
|
# @param body [OAuthURLRequest]
|
399
435
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
400
|
-
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:
|
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: {})
|
401
437
|
_body = {}
|
402
438
|
_body[:tags] = tags if tags != SENTINEL
|
403
439
|
_body[:scope] = scope if scope != SENTINEL
|
@@ -442,7 +478,7 @@ module Carbon
|
|
442
478
|
# @param set_page_as_boundary [Boolean]
|
443
479
|
# @param body [OAuthURLRequest]
|
444
480
|
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
|
445
|
-
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:
|
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: {})
|
446
482
|
_body = {}
|
447
483
|
_body[:tags] = tags if tags != SENTINEL
|
448
484
|
_body[:scope] = scope if scope != SENTINEL
|
@@ -1077,7 +1113,7 @@ module Carbon
|
|
1077
1113
|
# pages or alter the behavior of the sync.
|
1078
1114
|
#
|
1079
1115
|
# @param data_source_id [Integer]
|
1080
|
-
# @param ids [
|
1116
|
+
# @param ids [IdsProperty]
|
1081
1117
|
# @param tags [Object]
|
1082
1118
|
# @param chunk_size [Integer]
|
1083
1119
|
# @param chunk_overlap [Integer]
|
@@ -1115,7 +1151,7 @@ module Carbon
|
|
1115
1151
|
# pages or alter the behavior of the sync.
|
1116
1152
|
#
|
1117
1153
|
# @param data_source_id [Integer]
|
1118
|
-
# @param ids [
|
1154
|
+
# @param ids [IdsProperty]
|
1119
1155
|
# @param tags [Object]
|
1120
1156
|
# @param chunk_size [Integer]
|
1121
1157
|
# @param chunk_overlap [Integer]
|
@@ -1307,8 +1343,13 @@ module Carbon
|
|
1307
1343
|
|
1308
1344
|
# Sync Files
|
1309
1345
|
#
|
1346
|
+
# After listing files and folders via /integrations/items/sync and integrations/items/list, use the selected items' external ids
|
1347
|
+
# as the ids in this endpoint to sync them into Carbon. Sharepoint items take an additional parameter root_id, which identifies
|
1348
|
+
# the drive the file or folder is in and is stored in root_external_id. That additional paramter is optional and excluding it will
|
1349
|
+
# tell the sync to assume the item is stored in the default Documents drive.
|
1350
|
+
#
|
1310
1351
|
# @param data_source_id [Integer]
|
1311
|
-
# @param ids [
|
1352
|
+
# @param ids [IdsProperty]
|
1312
1353
|
# @param tags [Object]
|
1313
1354
|
# @param chunk_size [Integer]
|
1314
1355
|
# @param chunk_overlap [Integer]
|
@@ -1340,8 +1381,13 @@ module Carbon
|
|
1340
1381
|
|
1341
1382
|
# Sync Files
|
1342
1383
|
#
|
1384
|
+
# After listing files and folders via /integrations/items/sync and integrations/items/list, use the selected items' external ids
|
1385
|
+
# as the ids in this endpoint to sync them into Carbon. Sharepoint items take an additional parameter root_id, which identifies
|
1386
|
+
# the drive the file or folder is in and is stored in root_external_id. That additional paramter is optional and excluding it will
|
1387
|
+
# tell the sync to assume the item is stored in the default Documents drive.
|
1388
|
+
#
|
1343
1389
|
# @param data_source_id [Integer]
|
1344
|
-
# @param ids [
|
1390
|
+
# @param ids [IdsProperty]
|
1345
1391
|
# @param tags [Object]
|
1346
1392
|
# @param chunk_size [Integer]
|
1347
1393
|
# @param chunk_overlap [Integer]
|
@@ -1371,6 +1417,7 @@ module Carbon
|
|
1371
1417
|
end
|
1372
1418
|
|
1373
1419
|
# Sync Files
|
1420
|
+
# After listing files and folders via /integrations/items/sync and integrations/items/list, use the selected items' external ids as the ids in this endpoint to sync them into Carbon. Sharepoint items take an additional parameter root_id, which identifies the drive the file or folder is in and is stored in root_external_id. That additional paramter is optional and excluding it will tell the sync to assume the item is stored in the default Documents drive.
|
1374
1421
|
# @param sync_files_request [SyncFilesRequest]
|
1375
1422
|
# @param [Hash] opts the optional parameters
|
1376
1423
|
# @return [GenericSuccessResponse]
|
@@ -1380,6 +1427,7 @@ module Carbon
|
|
1380
1427
|
end
|
1381
1428
|
|
1382
1429
|
# Sync Files
|
1430
|
+
# After listing files and folders via /integrations/items/sync and integrations/items/list, use the selected items' external ids as the ids in this endpoint to sync them into Carbon. Sharepoint items take an additional parameter root_id, which identifies the drive the file or folder is in and is stored in root_external_id. That additional paramter is optional and excluding it will tell the sync to assume the item is stored in the default Documents drive.
|
1383
1431
|
# @param sync_files_request [SyncFilesRequest]
|
1384
1432
|
# @param [Hash] opts the optional parameters
|
1385
1433
|
# @return [APIResponse] data is GenericSuccessResponse, status code, headers and response
|
@@ -19,13 +19,16 @@ module Carbon
|
|
19
19
|
|
20
20
|
attr_accessor :send_webhook
|
21
21
|
|
22
|
+
attr_accessor :delete_child_files
|
23
|
+
|
22
24
|
# Attribute mapping from ruby-style variable name to JSON key.
|
23
25
|
def self.attribute_map
|
24
26
|
{
|
25
27
|
:'file_ids' => :'file_ids',
|
26
28
|
:'sync_statuses' => :'sync_statuses',
|
27
29
|
:'delete_non_synced_only' => :'delete_non_synced_only',
|
28
|
-
:'send_webhook' => :'send_webhook'
|
30
|
+
:'send_webhook' => :'send_webhook',
|
31
|
+
:'delete_child_files' => :'delete_child_files'
|
29
32
|
}
|
30
33
|
end
|
31
34
|
|
@@ -40,7 +43,8 @@ module Carbon
|
|
40
43
|
:'file_ids' => :'Array<Integer>',
|
41
44
|
:'sync_statuses' => :'Array<ExternalFileSyncStatuses>',
|
42
45
|
:'delete_non_synced_only' => :'Boolean',
|
43
|
-
:'send_webhook' => :'Boolean'
|
46
|
+
:'send_webhook' => :'Boolean',
|
47
|
+
:'delete_child_files' => :'Boolean'
|
44
48
|
}
|
45
49
|
end
|
46
50
|
|
@@ -90,6 +94,12 @@ module Carbon
|
|
90
94
|
else
|
91
95
|
self.send_webhook = false
|
92
96
|
end
|
97
|
+
|
98
|
+
if attributes.key?(:'delete_child_files')
|
99
|
+
self.delete_child_files = attributes[:'delete_child_files']
|
100
|
+
else
|
101
|
+
self.delete_child_files = false
|
102
|
+
end
|
93
103
|
end
|
94
104
|
|
95
105
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -113,7 +123,8 @@ module Carbon
|
|
113
123
|
file_ids == o.file_ids &&
|
114
124
|
sync_statuses == o.sync_statuses &&
|
115
125
|
delete_non_synced_only == o.delete_non_synced_only &&
|
116
|
-
send_webhook == o.send_webhook
|
126
|
+
send_webhook == o.send_webhook &&
|
127
|
+
delete_child_files == o.delete_child_files
|
117
128
|
end
|
118
129
|
|
119
130
|
# @see the `==` method
|
@@ -125,7 +136,7 @@ module Carbon
|
|
125
136
|
# Calculates hash code according to all attributes.
|
126
137
|
# @return [Integer] Hash code
|
127
138
|
def hash
|
128
|
-
[file_ids, sync_statuses, delete_non_synced_only, send_webhook].hash
|
139
|
+
[file_ids, sync_statuses, delete_non_synced_only, send_webhook, delete_child_files].hash
|
129
140
|
end
|
130
141
|
|
131
142
|
# Builds the object from hash
|
@@ -41,7 +41,6 @@ module Carbon
|
|
41
41
|
GITBOOK = "GITBOOK".freeze
|
42
42
|
SALESFORCE = "SALESFORCE".freeze
|
43
43
|
JPG = "JPG".freeze
|
44
|
-
JPG = "JPG".freeze
|
45
44
|
PNG = "PNG".freeze
|
46
45
|
MP3 = "MP3".freeze
|
47
46
|
MP4 = "MP4".freeze
|
@@ -56,7 +55,7 @@ module Carbon
|
|
56
55
|
WEBM = "WEBM".freeze
|
57
56
|
|
58
57
|
def self.all_vars
|
59
|
-
@all_vars ||= [TXT, CSV, TSV, PDF, DOCX, PPTX, XLSX, MD, RTF, JSON, NOTION, GOOGLE_DRIVE, GOOGLE_DOCS, GOOGLE_SHEETS, GOOGLE_SLIDES, INTERCOM, DROPBOX, ONEDRIVE, SHAREPOINT, CONFLUENCE, RSS_FEED, GMAIL, OUTLOOK, BOX, ZENDESK, FRESHDESK, WEB_SCRAPE, GITBOOK, SALESFORCE, JPG,
|
58
|
+
@all_vars ||= [TXT, CSV, TSV, PDF, DOCX, PPTX, XLSX, MD, RTF, JSON, NOTION, GOOGLE_DRIVE, GOOGLE_DOCS, GOOGLE_SHEETS, GOOGLE_SLIDES, INTERCOM, DROPBOX, ONEDRIVE, SHAREPOINT, CONFLUENCE, RSS_FEED, GMAIL, OUTLOOK, BOX, ZENDESK, FRESHDESK, WEB_SCRAPE, GITBOOK, SALESFORCE, JPG, PNG, MP3, MP4, MP2, AAC, WAV, FLAC, PCM, M4_A, OGG, OPUS, WEBM].freeze
|
60
59
|
end
|
61
60
|
|
62
61
|
# Builds the enum from string
|
@@ -41,7 +41,6 @@ module Carbon
|
|
41
41
|
GITBOOK = "GITBOOK".freeze
|
42
42
|
SALESFORCE = "SALESFORCE".freeze
|
43
43
|
JPG = "JPG".freeze
|
44
|
-
JPG = "JPG".freeze
|
45
44
|
PNG = "PNG".freeze
|
46
45
|
MP3 = "MP3".freeze
|
47
46
|
MP4 = "MP4".freeze
|
@@ -56,7 +55,7 @@ module Carbon
|
|
56
55
|
WEBM = "WEBM".freeze
|
57
56
|
|
58
57
|
def self.all_vars
|
59
|
-
@all_vars ||= [TXT, CSV, TSV, PDF, DOCX, PPTX, XLSX, MD, RTF, JSON, NOTION, GOOGLE_DRIVE, GOOGLE_DOCS, GOOGLE_SHEETS, GOOGLE_SLIDES, INTERCOM, DROPBOX, ONEDRIVE, SHAREPOINT, CONFLUENCE, RSS_FEED, GMAIL, OUTLOOK, BOX, ZENDESK, FRESHDESK, WEB_SCRAPE, GITBOOK, SALESFORCE, JPG,
|
58
|
+
@all_vars ||= [TXT, CSV, TSV, PDF, DOCX, PPTX, XLSX, MD, RTF, JSON, NOTION, GOOGLE_DRIVE, GOOGLE_DOCS, GOOGLE_SHEETS, GOOGLE_SLIDES, INTERCOM, DROPBOX, ONEDRIVE, SHAREPOINT, CONFLUENCE, RSS_FEED, GMAIL, OUTLOOK, BOX, ZENDESK, FRESHDESK, WEB_SCRAPE, GITBOOK, SALESFORCE, JPG, PNG, MP3, MP4, MP2, AAC, WAV, FLAC, PCM, M4_A, OGG, OPUS, WEBM].freeze
|
60
59
|
end
|
61
60
|
|
62
61
|
# Builds the enum from string
|
@@ -29,6 +29,8 @@ module Carbon
|
|
29
29
|
|
30
30
|
attr_accessor :prepend_filename_to_chunks
|
31
31
|
|
32
|
+
attr_accessor :sync_files_on_connection
|
33
|
+
|
32
34
|
# Attribute mapping from ruby-style variable name to JSON key.
|
33
35
|
def self.attribute_map
|
34
36
|
{
|
@@ -40,7 +42,8 @@ module Carbon
|
|
40
42
|
:'skip_embedding_generation' => :'skip_embedding_generation',
|
41
43
|
:'embedding_model' => :'embedding_model',
|
42
44
|
:'generate_sparse_vectors' => :'generate_sparse_vectors',
|
43
|
-
:'prepend_filename_to_chunks' => :'prepend_filename_to_chunks'
|
45
|
+
:'prepend_filename_to_chunks' => :'prepend_filename_to_chunks',
|
46
|
+
:'sync_files_on_connection' => :'sync_files_on_connection'
|
44
47
|
}
|
45
48
|
end
|
46
49
|
|
@@ -60,7 +63,8 @@ module Carbon
|
|
60
63
|
:'skip_embedding_generation' => :'Boolean',
|
61
64
|
:'embedding_model' => :'EmbeddingGeneratorsNullable',
|
62
65
|
:'generate_sparse_vectors' => :'Boolean',
|
63
|
-
:'prepend_filename_to_chunks' => :'Boolean'
|
66
|
+
:'prepend_filename_to_chunks' => :'Boolean',
|
67
|
+
:'sync_files_on_connection' => :'Boolean'
|
64
68
|
}
|
65
69
|
end
|
66
70
|
|
@@ -73,7 +77,8 @@ module Carbon
|
|
73
77
|
:'skip_embedding_generation',
|
74
78
|
:'embedding_model',
|
75
79
|
:'generate_sparse_vectors',
|
76
|
-
:'prepend_filename_to_chunks'
|
80
|
+
:'prepend_filename_to_chunks',
|
81
|
+
:'sync_files_on_connection'
|
77
82
|
])
|
78
83
|
end
|
79
84
|
|
@@ -139,6 +144,12 @@ module Carbon
|
|
139
144
|
else
|
140
145
|
self.prepend_filename_to_chunks = false
|
141
146
|
end
|
147
|
+
|
148
|
+
if attributes.key?(:'sync_files_on_connection')
|
149
|
+
self.sync_files_on_connection = attributes[:'sync_files_on_connection']
|
150
|
+
else
|
151
|
+
self.sync_files_on_connection = true
|
152
|
+
end
|
142
153
|
end
|
143
154
|
|
144
155
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -177,7 +188,8 @@ module Carbon
|
|
177
188
|
skip_embedding_generation == o.skip_embedding_generation &&
|
178
189
|
embedding_model == o.embedding_model &&
|
179
190
|
generate_sparse_vectors == o.generate_sparse_vectors &&
|
180
|
-
prepend_filename_to_chunks == o.prepend_filename_to_chunks
|
191
|
+
prepend_filename_to_chunks == o.prepend_filename_to_chunks &&
|
192
|
+
sync_files_on_connection == o.sync_files_on_connection
|
181
193
|
end
|
182
194
|
|
183
195
|
# @see the `==` method
|
@@ -189,7 +201,7 @@ module Carbon
|
|
189
201
|
# Calculates hash code according to all attributes.
|
190
202
|
# @return [Integer] Hash code
|
191
203
|
def hash
|
192
|
-
[tags, domain, api_key, chunk_size, chunk_overlap, skip_embedding_generation, embedding_model, generate_sparse_vectors, prepend_filename_to_chunks].hash
|
204
|
+
[tags, domain, api_key, chunk_size, chunk_overlap, skip_embedding_generation, embedding_model, generate_sparse_vectors, prepend_filename_to_chunks, sync_files_on_connection].hash
|
193
205
|
end
|
194
206
|
|
195
207
|
# Builds the object from hash
|