carbon_ruby_sdk 0.2.44 → 0.2.46

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8a352dae3f352ac098e4b9e3dce57183ec6d7d51b9fa0be54e06980259cf1a24
4
- data.tar.gz: 7998deace11207b727529794155403b8b331bcee5a0a5d89e245cb671207600d
3
+ metadata.gz: 6744e44fd0600e16103921e4b1a6a359ed7843f7ba3a6e8e6d44148dd9ad7b0c
4
+ data.tar.gz: d54957620b7d4324e441bd777e2a9475dd969071673ad45c15571f2450791d96
5
5
  SHA512:
6
- metadata.gz: 0d057a1a86a2b49205f263602d92db072afddede8b39c5dc12d5ae3b9cc1d708e293ef3a55dc819902b8fae0f2c43bed8e809a7da587720837f91810deee3dc6
7
- data.tar.gz: 38ce8209f51c29d860dbeabf52c1e446999c5199f6ea5e23902294e12a853bfd2708b6e1f665b2f6f3bbfd51202f03292d4cc584514b0fdaf74f62f194b9f17c
6
+ metadata.gz: 6dc396894df099d59b67614dc0eb2efeb1018c217311f7878be5e0b73ae2e5c6fdebc2b513613b697e14b8c7d792fa64bc4721cf2576cf3f8ca145235fcc62df
7
+ data.tar.gz: b606cf25c74b50dc5b82b8b57b0fc6850b25cb58f74c617dfaba60dd29bb5f58b2d65fc4c871da42c3474af953119e6a37a5dac4e06ad45478508d0573bfe5fa
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- carbon_ruby_sdk (0.2.44)
4
+ carbon_ruby_sdk (0.2.46)
5
5
  faraday (>= 1.0.1, < 3.0)
6
6
  faraday-multipart (~> 1.0, >= 1.0.4)
7
7
 
@@ -44,7 +44,7 @@ GEM
44
44
  regexp_parser (2.9.2)
45
45
  reline (0.5.10)
46
46
  io-console (~> 0.5)
47
- rexml (3.3.8)
47
+ rexml (3.3.9)
48
48
  rspec (3.13.0)
49
49
  rspec-core (~> 3.13.0)
50
50
  rspec-expectations (~> 3.13.0)
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.2.44-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.2.44)
9
+ [![npm](https://img.shields.io/badge/gem-v0.2.46-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.2.46)
10
10
 
11
11
  </div>
12
12
 
@@ -118,7 +118,7 @@ Connect external data to LLMs, no matter the source.
118
118
  Add to Gemfile:
119
119
 
120
120
  ```ruby
121
- gem 'carbon_ruby_sdk', '~> 0.2.44'
121
+ gem 'carbon_ruby_sdk', '~> 0.2.46'
122
122
  ```
123
123
 
124
124
  ## Getting Started<a id="getting-started"></a>
@@ -1411,6 +1411,7 @@ result = carbon.files.query_user_files(
1411
1411
  include_raw_file: true,
1412
1412
  include_parsed_text_file: true,
1413
1413
  include_additional_files: true,
1414
+ presigned_url_expiry_time_seconds: 3600,
1414
1415
  )
1415
1416
  p result
1416
1417
  ```
@@ -1418,12 +1419,33 @@ p result
1418
1419
  #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1419
1420
 
1420
1421
  ##### pagination: [`Pagination`](./lib/carbon_ruby_sdk/models/pagination.rb)<a id="pagination-paginationlibcarbon_ruby_sdkmodelspaginationrb"></a>
1422
+ Pagination parameters for the query.
1423
+
1421
1424
  ##### order_by: [`OrganizationUserFilesToSyncOrderByTypes`](./lib/carbon_ruby_sdk/models/organization_user_files_to_sync_order_by_types.rb)<a id="order_by-organizationuserfilestosyncorderbytypeslibcarbon_ruby_sdkmodelsorganization_user_files_to_sync_order_by_typesrb"></a>
1425
+ The field on OrganizationUserFilesToSYnc to order the results by.
1426
+
1422
1427
  ##### order_dir: [`OrderDir`](./lib/carbon_ruby_sdk/models/order_dir.rb)<a id="order_dir-orderdirlibcarbon_ruby_sdkmodelsorder_dirrb"></a>
1428
+ The direction to order the results by.
1429
+
1423
1430
  ##### filters: [`OrganizationUserFilesToSyncFilters`](./lib/carbon_ruby_sdk/models/organization_user_files_to_sync_filters.rb)<a id="filters-organizationuserfilestosyncfilterslibcarbon_ruby_sdkmodelsorganization_user_files_to_sync_filtersrb"></a>
1431
+ Filters to apply to the query.
1432
+
1424
1433
  ##### include_raw_file: `Boolean`<a id="include_raw_file-boolean"></a>
1434
+ If true, the query will return presigned URLs for the raw file. Only relevant
1435
+ for the /user_files_v2 endpoint.
1436
+
1425
1437
  ##### include_parsed_text_file: `Boolean`<a id="include_parsed_text_file-boolean"></a>
1438
+ If true, the query will return presigned URLs for the parsed text file. Only
1439
+ relevant for the /user_files_v2 endpoint.
1440
+
1426
1441
  ##### include_additional_files: `Boolean`<a id="include_additional_files-boolean"></a>
1442
+ If true, the query will return presigned URLs for additional files. Only
1443
+ relevant for the /user_files_v2 endpoint.
1444
+
1445
+ ##### presigned_url_expiry_time_seconds: `Integer`<a id="presigned_url_expiry_time_seconds-integer"></a>
1446
+ The expiry time for the presigned URLs. Only relevant for the /user_files_v2
1447
+ endpoint.
1448
+
1427
1449
  #### 🔄 Return<a id="🔄-return"></a>
1428
1450
 
1429
1451
  [UserFilesV2](./lib/carbon_ruby_sdk/models/user_files_v2.rb)
@@ -1460,6 +1482,7 @@ result = carbon.files.query_user_files_deprecated(
1460
1482
  include_raw_file: true,
1461
1483
  include_parsed_text_file: true,
1462
1484
  include_additional_files: true,
1485
+ presigned_url_expiry_time_seconds: 3600,
1463
1486
  )
1464
1487
  p result
1465
1488
  ```
@@ -1467,12 +1490,33 @@ p result
1467
1490
  #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1468
1491
 
1469
1492
  ##### pagination: [`Pagination`](./lib/carbon_ruby_sdk/models/pagination.rb)<a id="pagination-paginationlibcarbon_ruby_sdkmodelspaginationrb"></a>
1493
+ Pagination parameters for the query.
1494
+
1470
1495
  ##### order_by: [`OrganizationUserFilesToSyncOrderByTypes`](./lib/carbon_ruby_sdk/models/organization_user_files_to_sync_order_by_types.rb)<a id="order_by-organizationuserfilestosyncorderbytypeslibcarbon_ruby_sdkmodelsorganization_user_files_to_sync_order_by_typesrb"></a>
1496
+ The field on OrganizationUserFilesToSYnc to order the results by.
1497
+
1471
1498
  ##### order_dir: [`OrderDir`](./lib/carbon_ruby_sdk/models/order_dir.rb)<a id="order_dir-orderdirlibcarbon_ruby_sdkmodelsorder_dirrb"></a>
1499
+ The direction to order the results by.
1500
+
1472
1501
  ##### filters: [`OrganizationUserFilesToSyncFilters`](./lib/carbon_ruby_sdk/models/organization_user_files_to_sync_filters.rb)<a id="filters-organizationuserfilestosyncfilterslibcarbon_ruby_sdkmodelsorganization_user_files_to_sync_filtersrb"></a>
1502
+ Filters to apply to the query.
1503
+
1473
1504
  ##### include_raw_file: `Boolean`<a id="include_raw_file-boolean"></a>
1505
+ If true, the query will return presigned URLs for the raw file. Only relevant
1506
+ for the /user_files_v2 endpoint.
1507
+
1474
1508
  ##### include_parsed_text_file: `Boolean`<a id="include_parsed_text_file-boolean"></a>
1509
+ If true, the query will return presigned URLs for the parsed text file. Only
1510
+ relevant for the /user_files_v2 endpoint.
1511
+
1475
1512
  ##### include_additional_files: `Boolean`<a id="include_additional_files-boolean"></a>
1513
+ If true, the query will return presigned URLs for additional files. Only
1514
+ relevant for the /user_files_v2 endpoint.
1515
+
1516
+ ##### presigned_url_expiry_time_seconds: `Integer`<a id="presigned_url_expiry_time_seconds-integer"></a>
1517
+ The expiry time for the presigned URLs. Only relevant for the /user_files_v2
1518
+ endpoint.
1519
+
1476
1520
  #### 🔄 Return<a id="🔄-return"></a>
1477
1521
 
1478
1522
  [UserFile](./lib/carbon_ruby_sdk/models/user_file.rb)
@@ -2475,6 +2519,7 @@ result = carbon.integrations.get_oauth_url(
2475
2519
  service: "BOX",
2476
2520
  tags: None,
2477
2521
  scope: "string_example",
2522
+ scopes: [],
2478
2523
  chunk_size: 1500,
2479
2524
  chunk_overlap: 20,
2480
2525
  skip_embedding_generation: false,
@@ -2526,6 +2571,11 @@ p result
2526
2571
  ##### service: [`OauthBasedConnectors`](./lib/carbon_ruby_sdk/models/oauth_based_connectors.rb)<a id="service-oauthbasedconnectorslibcarbon_ruby_sdkmodelsoauth_based_connectorsrb"></a>
2527
2572
  ##### tags: `Object`<a id="tags-object"></a>
2528
2573
  ##### scope: `String`<a id="scope-string"></a>
2574
+ ##### scopes: Array<`String`><a id="scopes-array"></a>
2575
+ List of scopes to request from the OAuth provider. Please that the scopes will
2576
+ be used as it is, not combined with the default props that Carbon uses. One
2577
+ scope should be one array element.
2578
+
2529
2579
  ##### chunk_size: `Integer`<a id="chunk_size-integer"></a>
2530
2580
  ##### chunk_overlap: `Integer`<a id="chunk_overlap-integer"></a>
2531
2581
  ##### skip_embedding_generation: `Boolean`<a id="skip_embedding_generation-boolean"></a>
@@ -936,16 +936,17 @@ module Carbon
936
936
  # 3. "negate" is optional and must be `true` or `false`. If present and `true`, then the filter block is negated in
937
937
  # the resulting query. It is `false` by default.
938
938
  #
939
- # @param pagination [Pagination]
940
- # @param order_by [OrganizationUserFilesToSyncOrderByTypes]
941
- # @param order_dir [OrderDir]
942
- # @param filters [OrganizationUserFilesToSyncFilters]
943
- # @param include_raw_file [Boolean]
944
- # @param include_parsed_text_file [Boolean]
945
- # @param include_additional_files [Boolean]
939
+ # @param pagination [Pagination] Pagination parameters for the query.
940
+ # @param order_by [OrganizationUserFilesToSyncOrderByTypes] The field on OrganizationUserFilesToSYnc to order the results by.
941
+ # @param order_dir [OrderDir] The direction to order the results by.
942
+ # @param filters [OrganizationUserFilesToSyncFilters] Filters to apply to the query.
943
+ # @param include_raw_file [Boolean] If true, the query will return presigned URLs for the raw file. Only relevant for the /user_files_v2 endpoint.
944
+ # @param include_parsed_text_file [Boolean] If true, the query will return presigned URLs for the parsed text file. Only relevant for the /user_files_v2 endpoint.
945
+ # @param include_additional_files [Boolean] If true, the query will return presigned URLs for additional files. Only relevant for the /user_files_v2 endpoint.
946
+ # @param presigned_url_expiry_time_seconds [Integer] The expiry time for the presigned URLs. Only relevant for the /user_files_v2 endpoint.
946
947
  # @param body [OrganizationUserFilesToSyncQueryInput]
947
948
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
948
- def query_user_files(pagination: SENTINEL, order_by: 'updated_at', order_dir: 'asc', filters: SENTINEL, include_raw_file: SENTINEL, include_parsed_text_file: SENTINEL, include_additional_files: SENTINEL, extra: {})
949
+ def query_user_files(pagination: SENTINEL, order_by: 'updated_at', order_dir: 'asc', filters: SENTINEL, include_raw_file: SENTINEL, include_parsed_text_file: SENTINEL, include_additional_files: SENTINEL, presigned_url_expiry_time_seconds: 3600, extra: {})
949
950
  _body = {}
950
951
  _body[:pagination] = pagination if pagination != SENTINEL
951
952
  _body[:order_by] = order_by if order_by != SENTINEL
@@ -954,6 +955,7 @@ module Carbon
954
955
  _body[:include_raw_file] = include_raw_file if include_raw_file != SENTINEL
955
956
  _body[:include_parsed_text_file] = include_parsed_text_file if include_parsed_text_file != SENTINEL
956
957
  _body[:include_additional_files] = include_additional_files if include_additional_files != SENTINEL
958
+ _body[:presigned_url_expiry_time_seconds] = presigned_url_expiry_time_seconds if presigned_url_expiry_time_seconds != SENTINEL
957
959
  organization_user_files_to_sync_query_input = _body
958
960
  api_response = query_user_files_with_http_info_impl(organization_user_files_to_sync_query_input, extra)
959
961
  api_response.data
@@ -1012,16 +1014,17 @@ module Carbon
1012
1014
  # 3. "negate" is optional and must be `true` or `false`. If present and `true`, then the filter block is negated in
1013
1015
  # the resulting query. It is `false` by default.
1014
1016
  #
1015
- # @param pagination [Pagination]
1016
- # @param order_by [OrganizationUserFilesToSyncOrderByTypes]
1017
- # @param order_dir [OrderDir]
1018
- # @param filters [OrganizationUserFilesToSyncFilters]
1019
- # @param include_raw_file [Boolean]
1020
- # @param include_parsed_text_file [Boolean]
1021
- # @param include_additional_files [Boolean]
1017
+ # @param pagination [Pagination] Pagination parameters for the query.
1018
+ # @param order_by [OrganizationUserFilesToSyncOrderByTypes] The field on OrganizationUserFilesToSYnc to order the results by.
1019
+ # @param order_dir [OrderDir] The direction to order the results by.
1020
+ # @param filters [OrganizationUserFilesToSyncFilters] Filters to apply to the query.
1021
+ # @param include_raw_file [Boolean] If true, the query will return presigned URLs for the raw file. Only relevant for the /user_files_v2 endpoint.
1022
+ # @param include_parsed_text_file [Boolean] If true, the query will return presigned URLs for the parsed text file. Only relevant for the /user_files_v2 endpoint.
1023
+ # @param include_additional_files [Boolean] If true, the query will return presigned URLs for additional files. Only relevant for the /user_files_v2 endpoint.
1024
+ # @param presigned_url_expiry_time_seconds [Integer] The expiry time for the presigned URLs. Only relevant for the /user_files_v2 endpoint.
1022
1025
  # @param body [OrganizationUserFilesToSyncQueryInput]
1023
1026
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
1024
- def query_user_files_with_http_info(pagination: SENTINEL, order_by: 'updated_at', order_dir: 'asc', filters: SENTINEL, include_raw_file: SENTINEL, include_parsed_text_file: SENTINEL, include_additional_files: SENTINEL, extra: {})
1027
+ def query_user_files_with_http_info(pagination: SENTINEL, order_by: 'updated_at', order_dir: 'asc', filters: SENTINEL, include_raw_file: SENTINEL, include_parsed_text_file: SENTINEL, include_additional_files: SENTINEL, presigned_url_expiry_time_seconds: 3600, extra: {})
1025
1028
  _body = {}
1026
1029
  _body[:pagination] = pagination if pagination != SENTINEL
1027
1030
  _body[:order_by] = order_by if order_by != SENTINEL
@@ -1030,6 +1033,7 @@ module Carbon
1030
1033
  _body[:include_raw_file] = include_raw_file if include_raw_file != SENTINEL
1031
1034
  _body[:include_parsed_text_file] = include_parsed_text_file if include_parsed_text_file != SENTINEL
1032
1035
  _body[:include_additional_files] = include_additional_files if include_additional_files != SENTINEL
1036
+ _body[:presigned_url_expiry_time_seconds] = presigned_url_expiry_time_seconds if presigned_url_expiry_time_seconds != SENTINEL
1033
1037
  organization_user_files_to_sync_query_input = _body
1034
1038
  query_user_files_with_http_info_impl(organization_user_files_to_sync_query_input, extra)
1035
1039
  end
@@ -1107,16 +1111,17 @@ module Carbon
1107
1111
  #
1108
1112
  # This route is deprecated. Use `/user_files_v2` instead.
1109
1113
  #
1110
- # @param pagination [Pagination]
1111
- # @param order_by [OrganizationUserFilesToSyncOrderByTypes]
1112
- # @param order_dir [OrderDir]
1113
- # @param filters [OrganizationUserFilesToSyncFilters]
1114
- # @param include_raw_file [Boolean]
1115
- # @param include_parsed_text_file [Boolean]
1116
- # @param include_additional_files [Boolean]
1114
+ # @param pagination [Pagination] Pagination parameters for the query.
1115
+ # @param order_by [OrganizationUserFilesToSyncOrderByTypes] The field on OrganizationUserFilesToSYnc to order the results by.
1116
+ # @param order_dir [OrderDir] The direction to order the results by.
1117
+ # @param filters [OrganizationUserFilesToSyncFilters] Filters to apply to the query.
1118
+ # @param include_raw_file [Boolean] If true, the query will return presigned URLs for the raw file. Only relevant for the /user_files_v2 endpoint.
1119
+ # @param include_parsed_text_file [Boolean] If true, the query will return presigned URLs for the parsed text file. Only relevant for the /user_files_v2 endpoint.
1120
+ # @param include_additional_files [Boolean] If true, the query will return presigned URLs for additional files. Only relevant for the /user_files_v2 endpoint.
1121
+ # @param presigned_url_expiry_time_seconds [Integer] The expiry time for the presigned URLs. Only relevant for the /user_files_v2 endpoint.
1117
1122
  # @param body [OrganizationUserFilesToSyncQueryInput]
1118
1123
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
1119
- def query_user_files_deprecated(pagination: SENTINEL, order_by: 'updated_at', order_dir: 'asc', filters: SENTINEL, include_raw_file: SENTINEL, include_parsed_text_file: SENTINEL, include_additional_files: SENTINEL, extra: {})
1124
+ def query_user_files_deprecated(pagination: SENTINEL, order_by: 'updated_at', order_dir: 'asc', filters: SENTINEL, include_raw_file: SENTINEL, include_parsed_text_file: SENTINEL, include_additional_files: SENTINEL, presigned_url_expiry_time_seconds: 3600, extra: {})
1120
1125
  _body = {}
1121
1126
  _body[:pagination] = pagination if pagination != SENTINEL
1122
1127
  _body[:order_by] = order_by if order_by != SENTINEL
@@ -1125,6 +1130,7 @@ module Carbon
1125
1130
  _body[:include_raw_file] = include_raw_file if include_raw_file != SENTINEL
1126
1131
  _body[:include_parsed_text_file] = include_parsed_text_file if include_parsed_text_file != SENTINEL
1127
1132
  _body[:include_additional_files] = include_additional_files if include_additional_files != SENTINEL
1133
+ _body[:presigned_url_expiry_time_seconds] = presigned_url_expiry_time_seconds if presigned_url_expiry_time_seconds != SENTINEL
1128
1134
  organization_user_files_to_sync_query_input = _body
1129
1135
  api_response = query_user_files_deprecated_with_http_info_impl(organization_user_files_to_sync_query_input, extra)
1130
1136
  api_response.data
@@ -1134,16 +1140,17 @@ module Carbon
1134
1140
  #
1135
1141
  # This route is deprecated. Use `/user_files_v2` instead.
1136
1142
  #
1137
- # @param pagination [Pagination]
1138
- # @param order_by [OrganizationUserFilesToSyncOrderByTypes]
1139
- # @param order_dir [OrderDir]
1140
- # @param filters [OrganizationUserFilesToSyncFilters]
1141
- # @param include_raw_file [Boolean]
1142
- # @param include_parsed_text_file [Boolean]
1143
- # @param include_additional_files [Boolean]
1143
+ # @param pagination [Pagination] Pagination parameters for the query.
1144
+ # @param order_by [OrganizationUserFilesToSyncOrderByTypes] The field on OrganizationUserFilesToSYnc to order the results by.
1145
+ # @param order_dir [OrderDir] The direction to order the results by.
1146
+ # @param filters [OrganizationUserFilesToSyncFilters] Filters to apply to the query.
1147
+ # @param include_raw_file [Boolean] If true, the query will return presigned URLs for the raw file. Only relevant for the /user_files_v2 endpoint.
1148
+ # @param include_parsed_text_file [Boolean] If true, the query will return presigned URLs for the parsed text file. Only relevant for the /user_files_v2 endpoint.
1149
+ # @param include_additional_files [Boolean] If true, the query will return presigned URLs for additional files. Only relevant for the /user_files_v2 endpoint.
1150
+ # @param presigned_url_expiry_time_seconds [Integer] The expiry time for the presigned URLs. Only relevant for the /user_files_v2 endpoint.
1144
1151
  # @param body [OrganizationUserFilesToSyncQueryInput]
1145
1152
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
1146
- def query_user_files_deprecated_with_http_info(pagination: SENTINEL, order_by: 'updated_at', order_dir: 'asc', filters: SENTINEL, include_raw_file: SENTINEL, include_parsed_text_file: SENTINEL, include_additional_files: SENTINEL, extra: {})
1153
+ def query_user_files_deprecated_with_http_info(pagination: SENTINEL, order_by: 'updated_at', order_dir: 'asc', filters: SENTINEL, include_raw_file: SENTINEL, include_parsed_text_file: SENTINEL, include_additional_files: SENTINEL, presigned_url_expiry_time_seconds: 3600, extra: {})
1147
1154
  _body = {}
1148
1155
  _body[:pagination] = pagination if pagination != SENTINEL
1149
1156
  _body[:order_by] = order_by if order_by != SENTINEL
@@ -1152,6 +1159,7 @@ module Carbon
1152
1159
  _body[:include_raw_file] = include_raw_file if include_raw_file != SENTINEL
1153
1160
  _body[:include_parsed_text_file] = include_parsed_text_file if include_parsed_text_file != SENTINEL
1154
1161
  _body[:include_additional_files] = include_additional_files if include_additional_files != SENTINEL
1162
+ _body[:presigned_url_expiry_time_seconds] = presigned_url_expiry_time_seconds if presigned_url_expiry_time_seconds != SENTINEL
1155
1163
  organization_user_files_to_sync_query_input = _body
1156
1164
  query_user_files_deprecated_with_http_info_impl(organization_user_files_to_sync_query_input, extra)
1157
1165
  end
@@ -812,6 +812,7 @@ module Carbon
812
812
  # @param service [OauthBasedConnectors]
813
813
  # @param tags [Object]
814
814
  # @param scope [String]
815
+ # @param scopes [Array<String>] List of scopes to request from the OAuth provider. Please that the scopes will be used as it is, not combined with the default props that Carbon uses. One scope should be one array element.
815
816
  # @param chunk_size [Integer]
816
817
  # @param chunk_overlap [Integer]
817
818
  # @param skip_embedding_generation [Boolean]
@@ -841,10 +842,11 @@ module Carbon
841
842
  # @param data_source_tags [Object] Tags to be associated with the data source. If the data source already has tags set, then an upsert will be performed.
842
843
  # @param body [OAuthURLRequest]
843
844
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
844
- 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: SENTINEL, use_ocr: false, parse_pdf_tables_with_ocr: false, enable_file_picker: true, sync_source_items: true, incremental_sync: false, file_sync_config: SENTINEL, automatically_open_file_picker: SENTINEL, gong_account_email: SENTINEL, servicenow_credentials: SENTINEL, data_source_tags: SENTINEL, extra: {})
845
+ def get_oauth_url(service:, tags: SENTINEL, scope: SENTINEL, scopes: 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: SENTINEL, use_ocr: false, parse_pdf_tables_with_ocr: false, enable_file_picker: true, sync_source_items: true, incremental_sync: false, file_sync_config: SENTINEL, automatically_open_file_picker: SENTINEL, gong_account_email: SENTINEL, servicenow_credentials: SENTINEL, data_source_tags: SENTINEL, extra: {})
845
846
  _body = {}
846
847
  _body[:tags] = tags if tags != SENTINEL
847
848
  _body[:scope] = scope if scope != SENTINEL
849
+ _body[:scopes] = scopes if scopes != SENTINEL
848
850
  _body[:service] = service if service != SENTINEL
849
851
  _body[:chunk_size] = chunk_size if chunk_size != SENTINEL
850
852
  _body[:chunk_overlap] = chunk_overlap if chunk_overlap != SENTINEL
@@ -888,6 +890,7 @@ module Carbon
888
890
  # @param service [OauthBasedConnectors]
889
891
  # @param tags [Object]
890
892
  # @param scope [String]
893
+ # @param scopes [Array<String>] List of scopes to request from the OAuth provider. Please that the scopes will be used as it is, not combined with the default props that Carbon uses. One scope should be one array element.
891
894
  # @param chunk_size [Integer]
892
895
  # @param chunk_overlap [Integer]
893
896
  # @param skip_embedding_generation [Boolean]
@@ -917,10 +920,11 @@ module Carbon
917
920
  # @param data_source_tags [Object] Tags to be associated with the data source. If the data source already has tags set, then an upsert will be performed.
918
921
  # @param body [OAuthURLRequest]
919
922
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
920
- 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: SENTINEL, use_ocr: false, parse_pdf_tables_with_ocr: false, enable_file_picker: true, sync_source_items: true, incremental_sync: false, file_sync_config: SENTINEL, automatically_open_file_picker: SENTINEL, gong_account_email: SENTINEL, servicenow_credentials: SENTINEL, data_source_tags: SENTINEL, extra: {})
923
+ def get_oauth_url_with_http_info(service:, tags: SENTINEL, scope: SENTINEL, scopes: 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: SENTINEL, use_ocr: false, parse_pdf_tables_with_ocr: false, enable_file_picker: true, sync_source_items: true, incremental_sync: false, file_sync_config: SENTINEL, automatically_open_file_picker: SENTINEL, gong_account_email: SENTINEL, servicenow_credentials: SENTINEL, data_source_tags: SENTINEL, extra: {})
921
924
  _body = {}
922
925
  _body[:tags] = tags if tags != SENTINEL
923
926
  _body[:scope] = scope if scope != SENTINEL
927
+ _body[:scopes] = scopes if scopes != SENTINEL
924
928
  _body[:service] = service if service != SENTINEL
925
929
  _body[:chunk_size] = chunk_size if chunk_size != SENTINEL
926
930
  _body[:chunk_overlap] = chunk_overlap if chunk_overlap != SENTINEL
@@ -15,6 +15,9 @@ module Carbon
15
15
 
16
16
  attr_accessor :scope
17
17
 
18
+ # List of scopes to request from the OAuth provider. Please that the scopes will be used as it is, not combined with the default props that Carbon uses. One scope should be one array element.
19
+ attr_accessor :scopes
20
+
18
21
  attr_accessor :service
19
22
 
20
23
  attr_accessor :chunk_size
@@ -88,6 +91,7 @@ module Carbon
88
91
  {
89
92
  :'tags' => :'tags',
90
93
  :'scope' => :'scope',
94
+ :'scopes' => :'scopes',
91
95
  :'service' => :'service',
92
96
  :'chunk_size' => :'chunk_size',
93
97
  :'chunk_overlap' => :'chunk_overlap',
@@ -129,6 +133,7 @@ module Carbon
129
133
  {
130
134
  :'tags' => :'Object',
131
135
  :'scope' => :'String',
136
+ :'scopes' => :'Array<String>',
132
137
  :'service' => :'OauthBasedConnectors',
133
138
  :'chunk_size' => :'Integer',
134
139
  :'chunk_overlap' => :'Integer',
@@ -165,6 +170,7 @@ module Carbon
165
170
  Set.new([
166
171
  :'tags',
167
172
  :'scope',
173
+ :'scopes',
168
174
  :'chunk_size',
169
175
  :'chunk_overlap',
170
176
  :'skip_embedding_generation',
@@ -213,6 +219,12 @@ module Carbon
213
219
  self.scope = attributes[:'scope']
214
220
  end
215
221
 
222
+ if attributes.key?(:'scopes')
223
+ if (value = attributes[:'scopes']).is_a?(Array)
224
+ self.scopes = value
225
+ end
226
+ end
227
+
216
228
  if attributes.key?(:'service')
217
229
  self.service = attributes[:'service']
218
230
  end
@@ -379,6 +391,7 @@ module Carbon
379
391
  self.class == o.class &&
380
392
  tags == o.tags &&
381
393
  scope == o.scope &&
394
+ scopes == o.scopes &&
382
395
  service == o.service &&
383
396
  chunk_size == o.chunk_size &&
384
397
  chunk_overlap == o.chunk_overlap &&
@@ -418,7 +431,7 @@ module Carbon
418
431
  # Calculates hash code according to all attributes.
419
432
  # @return [Integer] Hash code
420
433
  def hash
421
- [tags, scope, service, chunk_size, chunk_overlap, skip_embedding_generation, embedding_model, zendesk_subdomain, microsoft_tenant, sharepoint_site_name, confluence_subdomain, generate_sparse_vectors, prepend_filename_to_chunks, max_items_per_chunk, salesforce_domain, sync_files_on_connection, set_page_as_boundary, data_source_id, connecting_new_account, request_id, use_ocr, parse_pdf_tables_with_ocr, enable_file_picker, sync_source_items, incremental_sync, file_sync_config, automatically_open_file_picker, gong_account_email, servicenow_credentials, data_source_tags].hash
434
+ [tags, scope, scopes, service, chunk_size, chunk_overlap, skip_embedding_generation, embedding_model, zendesk_subdomain, microsoft_tenant, sharepoint_site_name, confluence_subdomain, generate_sparse_vectors, prepend_filename_to_chunks, max_items_per_chunk, salesforce_domain, sync_files_on_connection, set_page_as_boundary, data_source_id, connecting_new_account, request_id, use_ocr, parse_pdf_tables_with_ocr, enable_file_picker, sync_source_items, incremental_sync, file_sync_config, automatically_open_file_picker, gong_account_email, servicenow_credentials, data_source_tags].hash
422
435
  end
423
436
 
424
437
  # Builds the object from hash
@@ -11,20 +11,30 @@ require 'time'
11
11
 
12
12
  module Carbon
13
13
  class OrganizationUserFilesToSyncQueryInput
14
+ # Pagination parameters for the query.
14
15
  attr_accessor :pagination
15
16
 
17
+ # The field on OrganizationUserFilesToSYnc to order the results by.
16
18
  attr_accessor :order_by
17
19
 
20
+ # The direction to order the results by.
18
21
  attr_accessor :order_dir
19
22
 
23
+ # Filters to apply to the query.
20
24
  attr_accessor :filters
21
25
 
26
+ # If true, the query will return presigned URLs for the raw file. Only relevant for the /user_files_v2 endpoint.
22
27
  attr_accessor :include_raw_file
23
28
 
29
+ # If true, the query will return presigned URLs for the parsed text file. Only relevant for the /user_files_v2 endpoint.
24
30
  attr_accessor :include_parsed_text_file
25
31
 
32
+ # If true, the query will return presigned URLs for additional files. Only relevant for the /user_files_v2 endpoint.
26
33
  attr_accessor :include_additional_files
27
34
 
35
+ # The expiry time for the presigned URLs. Only relevant for the /user_files_v2 endpoint.
36
+ attr_accessor :presigned_url_expiry_time_seconds
37
+
28
38
  # Attribute mapping from ruby-style variable name to JSON key.
29
39
  def self.attribute_map
30
40
  {
@@ -34,7 +44,8 @@ module Carbon
34
44
  :'filters' => :'filters',
35
45
  :'include_raw_file' => :'include_raw_file',
36
46
  :'include_parsed_text_file' => :'include_parsed_text_file',
37
- :'include_additional_files' => :'include_additional_files'
47
+ :'include_additional_files' => :'include_additional_files',
48
+ :'presigned_url_expiry_time_seconds' => :'presigned_url_expiry_time_seconds'
38
49
  }
39
50
  end
40
51
 
@@ -52,7 +63,8 @@ module Carbon
52
63
  :'filters' => :'OrganizationUserFilesToSyncFilters',
53
64
  :'include_raw_file' => :'Boolean',
54
65
  :'include_parsed_text_file' => :'Boolean',
55
- :'include_additional_files' => :'Boolean'
66
+ :'include_additional_files' => :'Boolean',
67
+ :'presigned_url_expiry_time_seconds' => :'Integer'
56
68
  }
57
69
  end
58
70
 
@@ -61,7 +73,7 @@ module Carbon
61
73
  Set.new([
62
74
  :'include_raw_file',
63
75
  :'include_parsed_text_file',
64
- :'include_additional_files'
76
+ :'include_additional_files',
65
77
  ])
66
78
  end
67
79
 
@@ -111,6 +123,12 @@ module Carbon
111
123
  if attributes.key?(:'include_additional_files')
112
124
  self.include_additional_files = attributes[:'include_additional_files']
113
125
  end
126
+
127
+ if attributes.key?(:'presigned_url_expiry_time_seconds')
128
+ self.presigned_url_expiry_time_seconds = attributes[:'presigned_url_expiry_time_seconds']
129
+ else
130
+ self.presigned_url_expiry_time_seconds = 3600
131
+ end
114
132
  end
115
133
 
116
134
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -137,7 +155,8 @@ module Carbon
137
155
  filters == o.filters &&
138
156
  include_raw_file == o.include_raw_file &&
139
157
  include_parsed_text_file == o.include_parsed_text_file &&
140
- include_additional_files == o.include_additional_files
158
+ include_additional_files == o.include_additional_files &&
159
+ presigned_url_expiry_time_seconds == o.presigned_url_expiry_time_seconds
141
160
  end
142
161
 
143
162
  # @see the `==` method
@@ -149,7 +168,7 @@ module Carbon
149
168
  # Calculates hash code according to all attributes.
150
169
  # @return [Integer] Hash code
151
170
  def hash
152
- [pagination, order_by, order_dir, filters, include_raw_file, include_parsed_text_file, include_additional_files].hash
171
+ [pagination, order_by, order_dir, filters, include_raw_file, include_parsed_text_file, include_additional_files, presigned_url_expiry_time_seconds].hash
153
172
  end
154
173
 
155
174
  # Builds the object from hash
@@ -11,6 +11,7 @@ require 'time'
11
11
 
12
12
  module Carbon
13
13
  class RerankParams
14
+ # The name of the model to use for reranking. Options: ['COHERE_RERANK_MULTILINGUAL_V3', 'JINA_RERANKER_MULTILINGUAL_V2', 'PONGO_RERANKER'].
14
15
  attr_accessor :model
15
16
 
16
17
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -12,6 +12,7 @@ require 'time'
12
12
  module Carbon
13
13
  # Parameters for reranking the chunks using a specified model. This field accepts an object with details of the reranking model to be used; either 'Cohere' or 'Jina'. If provided, the specified reranking model will reorder the retrieved chunks based on their relevance to the query.
14
14
  class RerankParamsNullable
15
+ # The name of the model to use for reranking. Options: ['COHERE_RERANK_MULTILINGUAL_V3', 'JINA_RERANKER_MULTILINGUAL_V2', 'PONGO_RERANKER'].
15
16
  attr_accessor :model
16
17
 
17
18
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -7,5 +7,5 @@ The version of the OpenAPI document: 1.0.0
7
7
  =end
8
8
 
9
9
  module Carbon
10
- VERSION = '0.2.44'
10
+ VERSION = '0.2.46'
11
11
  end
@@ -31,6 +31,12 @@ describe Carbon::OAuthURLRequest do
31
31
  end
32
32
  end
33
33
 
34
+ describe 'test attribute "scopes"' do
35
+ it 'should work' do
36
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
37
+ end
38
+ end
39
+
34
40
  describe 'test attribute "service"' do
35
41
  it 'should work' do
36
42
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -61,4 +61,10 @@ describe Carbon::OrganizationUserFilesToSyncQueryInput do
61
61
  end
62
62
  end
63
63
 
64
+ describe 'test attribute "presigned_url_expiry_time_seconds"' do
65
+ it 'should work' do
66
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
67
+ end
68
+ end
69
+
64
70
  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.2.44
4
+ version: 0.2.46
5
5
  platform: ruby
6
6
  authors:
7
7
  - Konfig
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-10-24 00:00:00.000000000 Z
11
+ date: 2024-10-29 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday