carbon_ruby_sdk 0.2.39 → 0.2.41

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: d2401dfba4e022cabaea06fd3c5c88a7ac478ac5844ed523afec47f345661190
4
- data.tar.gz: e5b881ccd3e79f60304ab784f7181b744c3e4d08982bbd5675bdc3448b6ed98e
3
+ metadata.gz: b6a3377f9d76f046be221f82a9245ff51891693ccd7da4871f731826ad9603fd
4
+ data.tar.gz: 16bb35d792953316029695d0931fedbcd7b0c49ff15ddf4e136074c92950a698
5
5
  SHA512:
6
- metadata.gz: 9ccf02f74adcd0cdc0af15baa8f812a608b4b4daf491ffce5af307643c44f2e9ef9f32f56361035c92e78d41548019831c0a59d82544098161200552944af5a3
7
- data.tar.gz: 05f1c9282a7df5f52b4463a4bd5b508d7988fa1788ee55e57b936b9e5fb7291f6f5740c4be0d96a0645ba1cc47cbadc2763b0dc1315485832a3829e38b1ce5d8
6
+ metadata.gz: e6cd3fc358155e0c0f915b68da5898afecf7c03ddec2341c48187a0d3afc7e85645fc7ca3394e8df0f1d858bf96ecc893aaea8277ef570ea04283d613552b767
7
+ data.tar.gz: 4ad76f42235498b6ac475612e468fd1facc96d6fb28812cfce16dc2ecdf4d45a7c30cb951e64695dd9e4bc3991a6a1889d39ce31d3d5e4f883effa42c6b49a9d
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- carbon_ruby_sdk (0.2.39)
4
+ carbon_ruby_sdk (0.2.41)
5
5
  faraday (>= 1.0.1, < 3.0)
6
6
  faraday-multipart (~> 1.0, >= 1.0.4)
7
7
 
data/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  Connect external data to LLMs, no matter the source.
8
8
 
9
- [![npm](https://img.shields.io/badge/gem-v0.2.39-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.2.39)
9
+ [![npm](https://img.shields.io/badge/gem-v0.2.41-blue)](https://rubygems.org/gems/carbon_ruby_sdk/versions/0.2.41)
10
10
 
11
11
  </div>
12
12
 
@@ -111,7 +111,7 @@ Connect external data to LLMs, no matter the source.
111
111
  Add to Gemfile:
112
112
 
113
113
  ```ruby
114
- gem 'carbon_ruby_sdk', '~> 0.2.39'
114
+ gem 'carbon_ruby_sdk', '~> 0.2.41'
115
115
  ```
116
116
 
117
117
  ## Getting Started<a id="getting-started"></a>
@@ -3848,6 +3848,9 @@ result = carbon.users.update_users(
3848
3848
  ],
3849
3849
  max_files: -1,
3850
3850
  max_files_per_upload: -1,
3851
+ max_characters: -1,
3852
+ max_characters_per_file: -1,
3853
+ max_characters_per_upload: -1,
3851
3854
  )
3852
3855
  p result
3853
3856
  ```
@@ -3868,6 +3871,21 @@ Custom file upload limit for the user across a single upload. If set, then the
3868
3871
  user will not be allowed to upload more files than this limit in a single
3869
3872
  upload. If not set, or if set to -1, then the user will have no limit.
3870
3873
 
3874
+ ##### max_characters: `Integer`<a id="max_characters-integer"></a>
3875
+ Custom character upload limit for the user over *all* user's files across all
3876
+ uploads. If set, then the user will not be allowed to upload more characters
3877
+ than this limit. If not set, or if set to -1, then the user will have no limit.
3878
+
3879
+ ##### max_characters_per_file: `Integer`<a id="max_characters_per_file-integer"></a>
3880
+ A single file upload from the user can not exceed this character limit. If set,
3881
+ then the file will not be synced if it exceeds this limit. If not set, or if set
3882
+ to -1, then the user will have no limit.
3883
+
3884
+ ##### max_characters_per_upload: `Integer`<a id="max_characters_per_upload-integer"></a>
3885
+ Custom character upload limit for the user across a single upload. If set, then
3886
+ the user won't be able to sync more than this many characters in one upload. If
3887
+ not set, or if set to -1, then the user will have no limit.
3888
+
3871
3889
  #### 🔄 Return<a id="🔄-return"></a>
3872
3890
 
3873
3891
  [GenericSuccessResponse](./lib/carbon_ruby_sdk/models/generic_success_response.rb)
@@ -4046,6 +4064,7 @@ result = carbon.utilities.scrape_sitemap(
4046
4064
  download_css_and_media: false,
4047
4065
  generate_chunks_only: false,
4048
4066
  store_file_only: false,
4067
+ use_premium_proxies: false,
4049
4068
  )
4050
4069
  p result
4051
4070
  ```
@@ -4093,6 +4112,11 @@ embeddings will be generated. This overrides the skip_embedding_generation flag.
4093
4112
  If this flag is enabled, the file will be stored with Carbon, but no processing
4094
4113
  will be done.
4095
4114
 
4115
+ ##### use_premium_proxies: `Boolean`<a id="use_premium_proxies-boolean"></a>
4116
+ If the default proxies are blocked and not returning results, this flag can be
4117
+ enabled to use alternate proxies (residential and office). Scrapes might take
4118
+ longer to finish with this flag enabled.
4119
+
4096
4120
  #### 🌐 Endpoint<a id="🌐-endpoint"></a>
4097
4121
 
4098
4122
  `/scrape_sitemap` `POST`
@@ -4136,6 +4160,7 @@ result = carbon.utilities.scrape_web(
4136
4160
  "download_css_and_media" => false,
4137
4161
  "generate_chunks_only" => false,
4138
4162
  "store_file_only" => false,
4163
+ "use_premium_proxies" => false,
4139
4164
  }
4140
4165
  ],
4141
4166
  )
@@ -416,13 +416,19 @@ module Carbon
416
416
  # @param auto_sync_enabled_sources [AutoSyncEnabledSourcesProperty]
417
417
  # @param max_files [Integer] Custom file upload limit for the user over *all* user's files across all uploads. If set, then the user will not be allowed to upload more files than this limit. If not set, or if set to -1, then the user will have no limit.
418
418
  # @param max_files_per_upload [Integer] Custom file upload limit for the user across a single upload. If set, then the user will not be allowed to upload more files than this limit in a single upload. If not set, or if set to -1, then the user will have no limit.
419
+ # @param max_characters [Integer] Custom character upload limit for the user over *all* user's files across all uploads. If set, then the user will not be allowed to upload more characters than this limit. If not set, or if set to -1, then the user will have no limit.
420
+ # @param max_characters_per_file [Integer] A single file upload from the user can not exceed this character limit. If set, then the file will not be synced if it exceeds this limit. If not set, or if set to -1, then the user will have no limit.
421
+ # @param max_characters_per_upload [Integer] Custom character upload limit for the user across a single upload. If set, then the user won't be able to sync more than this many characters in one upload. If not set, or if set to -1, then the user will have no limit.
419
422
  # @param body [UpdateUsersInput]
420
423
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
421
- def update_users(customer_ids:, auto_sync_enabled_sources: SENTINEL, max_files: SENTINEL, max_files_per_upload: SENTINEL, extra: {})
424
+ def update_users(customer_ids:, auto_sync_enabled_sources: SENTINEL, max_files: SENTINEL, max_files_per_upload: SENTINEL, max_characters: SENTINEL, max_characters_per_file: SENTINEL, max_characters_per_upload: SENTINEL, extra: {})
422
425
  _body = {}
423
426
  _body[:auto_sync_enabled_sources] = auto_sync_enabled_sources if auto_sync_enabled_sources != SENTINEL
424
427
  _body[:max_files] = max_files if max_files != SENTINEL
425
428
  _body[:max_files_per_upload] = max_files_per_upload if max_files_per_upload != SENTINEL
429
+ _body[:max_characters] = max_characters if max_characters != SENTINEL
430
+ _body[:max_characters_per_file] = max_characters_per_file if max_characters_per_file != SENTINEL
431
+ _body[:max_characters_per_upload] = max_characters_per_upload if max_characters_per_upload != SENTINEL
426
432
  _body[:customer_ids] = customer_ids if customer_ids != SENTINEL
427
433
  update_users_input = _body
428
434
  api_response = update_users_with_http_info_impl(update_users_input, extra)
@@ -435,13 +441,19 @@ module Carbon
435
441
  # @param auto_sync_enabled_sources [AutoSyncEnabledSourcesProperty]
436
442
  # @param max_files [Integer] Custom file upload limit for the user over *all* user's files across all uploads. If set, then the user will not be allowed to upload more files than this limit. If not set, or if set to -1, then the user will have no limit.
437
443
  # @param max_files_per_upload [Integer] Custom file upload limit for the user across a single upload. If set, then the user will not be allowed to upload more files than this limit in a single upload. If not set, or if set to -1, then the user will have no limit.
444
+ # @param max_characters [Integer] Custom character upload limit for the user over *all* user's files across all uploads. If set, then the user will not be allowed to upload more characters than this limit. If not set, or if set to -1, then the user will have no limit.
445
+ # @param max_characters_per_file [Integer] A single file upload from the user can not exceed this character limit. If set, then the file will not be synced if it exceeds this limit. If not set, or if set to -1, then the user will have no limit.
446
+ # @param max_characters_per_upload [Integer] Custom character upload limit for the user across a single upload. If set, then the user won't be able to sync more than this many characters in one upload. If not set, or if set to -1, then the user will have no limit.
438
447
  # @param body [UpdateUsersInput]
439
448
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
440
- def update_users_with_http_info(customer_ids:, auto_sync_enabled_sources: SENTINEL, max_files: SENTINEL, max_files_per_upload: SENTINEL, extra: {})
449
+ def update_users_with_http_info(customer_ids:, auto_sync_enabled_sources: SENTINEL, max_files: SENTINEL, max_files_per_upload: SENTINEL, max_characters: SENTINEL, max_characters_per_file: SENTINEL, max_characters_per_upload: SENTINEL, extra: {})
441
450
  _body = {}
442
451
  _body[:auto_sync_enabled_sources] = auto_sync_enabled_sources if auto_sync_enabled_sources != SENTINEL
443
452
  _body[:max_files] = max_files if max_files != SENTINEL
444
453
  _body[:max_files_per_upload] = max_files_per_upload if max_files_per_upload != SENTINEL
454
+ _body[:max_characters] = max_characters if max_characters != SENTINEL
455
+ _body[:max_characters_per_file] = max_characters_per_file if max_characters_per_file != SENTINEL
456
+ _body[:max_characters_per_upload] = max_characters_per_upload if max_characters_per_upload != SENTINEL
445
457
  _body[:customer_ids] = customer_ids if customer_ids != SENTINEL
446
458
  update_users_input = _body
447
459
  update_users_with_http_info_impl(update_users_input, extra)
@@ -440,9 +440,10 @@ module Carbon
440
440
  # @param download_css_and_media [Boolean] Whether the scraper should download css and media from the page (images, fonts, etc). Scrapes might take longer to finish with this flag enabled, but the success rate is improved.
441
441
  # @param generate_chunks_only [Boolean] If this flag is enabled, the file will be chunked and stored with Carbon, but no embeddings will be generated. This overrides the skip_embedding_generation flag.
442
442
  # @param store_file_only [Boolean] If this flag is enabled, the file will be stored with Carbon, but no processing will be done.
443
+ # @param use_premium_proxies [Boolean] If the default proxies are blocked and not returning results, this flag can be enabled to use alternate proxies (residential and office). Scrapes might take longer to finish with this flag enabled.
443
444
  # @param body [SitemapScrapeRequest]
444
445
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
445
- def scrape_sitemap(url:, tags: SENTINEL, max_pages_to_scrape: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, enable_auto_sync: false, generate_sparse_vectors: false, prepend_filename_to_chunks: false, html_tags_to_skip: SENTINEL, css_classes_to_skip: SENTINEL, css_selectors_to_skip: SENTINEL, embedding_model: 'OPENAI', url_paths_to_include: SENTINEL, url_paths_to_exclude: SENTINEL, urls_to_scrape: SENTINEL, download_css_and_media: false, generate_chunks_only: false, store_file_only: false, extra: {})
446
+ def scrape_sitemap(url:, tags: SENTINEL, max_pages_to_scrape: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, enable_auto_sync: false, generate_sparse_vectors: false, prepend_filename_to_chunks: false, html_tags_to_skip: SENTINEL, css_classes_to_skip: SENTINEL, css_selectors_to_skip: SENTINEL, embedding_model: 'OPENAI', url_paths_to_include: SENTINEL, url_paths_to_exclude: SENTINEL, urls_to_scrape: SENTINEL, download_css_and_media: false, generate_chunks_only: false, store_file_only: false, use_premium_proxies: false, extra: {})
446
447
  _body = {}
447
448
  _body[:tags] = tags if tags != SENTINEL
448
449
  _body[:url] = url if url != SENTINEL
@@ -463,6 +464,7 @@ module Carbon
463
464
  _body[:download_css_and_media] = download_css_and_media if download_css_and_media != SENTINEL
464
465
  _body[:generate_chunks_only] = generate_chunks_only if generate_chunks_only != SENTINEL
465
466
  _body[:store_file_only] = store_file_only if store_file_only != SENTINEL
467
+ _body[:use_premium_proxies] = use_premium_proxies if use_premium_proxies != SENTINEL
466
468
  sitemap_scrape_request = _body
467
469
  api_response = scrape_sitemap_with_http_info_impl(sitemap_scrape_request, extra)
468
470
  api_response.data
@@ -497,9 +499,10 @@ module Carbon
497
499
  # @param download_css_and_media [Boolean] Whether the scraper should download css and media from the page (images, fonts, etc). Scrapes might take longer to finish with this flag enabled, but the success rate is improved.
498
500
  # @param generate_chunks_only [Boolean] If this flag is enabled, the file will be chunked and stored with Carbon, but no embeddings will be generated. This overrides the skip_embedding_generation flag.
499
501
  # @param store_file_only [Boolean] If this flag is enabled, the file will be stored with Carbon, but no processing will be done.
502
+ # @param use_premium_proxies [Boolean] If the default proxies are blocked and not returning results, this flag can be enabled to use alternate proxies (residential and office). Scrapes might take longer to finish with this flag enabled.
500
503
  # @param body [SitemapScrapeRequest]
501
504
  # @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
502
- def scrape_sitemap_with_http_info(url:, tags: SENTINEL, max_pages_to_scrape: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, enable_auto_sync: false, generate_sparse_vectors: false, prepend_filename_to_chunks: false, html_tags_to_skip: SENTINEL, css_classes_to_skip: SENTINEL, css_selectors_to_skip: SENTINEL, embedding_model: 'OPENAI', url_paths_to_include: SENTINEL, url_paths_to_exclude: SENTINEL, urls_to_scrape: SENTINEL, download_css_and_media: false, generate_chunks_only: false, store_file_only: false, extra: {})
505
+ def scrape_sitemap_with_http_info(url:, tags: SENTINEL, max_pages_to_scrape: SENTINEL, chunk_size: 1500, chunk_overlap: 20, skip_embedding_generation: false, enable_auto_sync: false, generate_sparse_vectors: false, prepend_filename_to_chunks: false, html_tags_to_skip: SENTINEL, css_classes_to_skip: SENTINEL, css_selectors_to_skip: SENTINEL, embedding_model: 'OPENAI', url_paths_to_include: SENTINEL, url_paths_to_exclude: SENTINEL, urls_to_scrape: SENTINEL, download_css_and_media: false, generate_chunks_only: false, store_file_only: false, use_premium_proxies: false, extra: {})
503
506
  _body = {}
504
507
  _body[:tags] = tags if tags != SENTINEL
505
508
  _body[:url] = url if url != SENTINEL
@@ -520,6 +523,7 @@ module Carbon
520
523
  _body[:download_css_and_media] = download_css_and_media if download_css_and_media != SENTINEL
521
524
  _body[:generate_chunks_only] = generate_chunks_only if generate_chunks_only != SENTINEL
522
525
  _body[:store_file_only] = store_file_only if store_file_only != SENTINEL
526
+ _body[:use_premium_proxies] = use_premium_proxies if use_premium_proxies != SENTINEL
523
527
  sitemap_scrape_request = _body
524
528
  scrape_sitemap_with_http_info_impl(sitemap_scrape_request, extra)
525
529
  end
@@ -50,6 +50,9 @@ module Carbon
50
50
  # Filter by request ID(s) which were used to sync the files
51
51
  attr_accessor :request_ids
52
52
 
53
+ # Filter by upload ID(s) which were used to sync the files
54
+ attr_accessor :upload_ids
55
+
53
56
  # The error message of the file. The query will return files with error messages that contain this string. To search for files with no error message, use an empty string.
54
57
  attr_accessor :sync_error_message
55
58
 
@@ -79,6 +82,7 @@ module Carbon
79
82
  :'include_all_children' => :'include_all_children',
80
83
  :'non_synced_only' => :'non_synced_only',
81
84
  :'request_ids' => :'request_ids',
85
+ :'upload_ids' => :'upload_ids',
82
86
  :'sync_error_message' => :'sync_error_message',
83
87
  :'include_containers' => :'include_containers',
84
88
  :'external_urls' => :'external_urls',
@@ -108,6 +112,7 @@ module Carbon
108
112
  :'include_all_children' => :'Boolean',
109
113
  :'non_synced_only' => :'Boolean',
110
114
  :'request_ids' => :'Array<String>',
115
+ :'upload_ids' => :'Array<String>',
111
116
  :'sync_error_message' => :'String',
112
117
  :'include_containers' => :'Boolean',
113
118
  :'external_urls' => :'Array<String>',
@@ -130,6 +135,7 @@ module Carbon
130
135
  :'embedding_generators',
131
136
  :'root_files_only',
132
137
  :'request_ids',
138
+ :'upload_ids',
133
139
  :'sync_error_message',
134
140
  :'include_containers',
135
141
  :'external_urls',
@@ -228,6 +234,12 @@ module Carbon
228
234
  end
229
235
  end
230
236
 
237
+ if attributes.key?(:'upload_ids')
238
+ if (value = attributes[:'upload_ids']).is_a?(Array)
239
+ self.upload_ids = value
240
+ end
241
+ end
242
+
231
243
  if attributes.key?(:'sync_error_message')
232
244
  self.sync_error_message = attributes[:'sync_error_message']
233
245
  end
@@ -257,6 +269,10 @@ module Carbon
257
269
  invalid_properties.push('invalid value for "request_ids", number of items must be less than or equal to 100.')
258
270
  end
259
271
 
272
+ if !@upload_ids.nil? && @upload_ids.length > 100
273
+ invalid_properties.push('invalid value for "upload_ids", number of items must be less than or equal to 100.')
274
+ end
275
+
260
276
  invalid_properties
261
277
  end
262
278
 
@@ -264,6 +280,7 @@ module Carbon
264
280
  # @return true if the model is valid
265
281
  def valid?
266
282
  return false if !@request_ids.nil? && @request_ids.length > 100
283
+ return false if !@upload_ids.nil? && @upload_ids.length > 100
267
284
  true
268
285
  end
269
286
 
@@ -277,6 +294,16 @@ module Carbon
277
294
  @request_ids = request_ids
278
295
  end
279
296
 
297
+ # Custom attribute writer method with validation
298
+ # @param [Object] upload_ids Value to be assigned
299
+ def upload_ids=(upload_ids)
300
+ if !upload_ids.nil? && upload_ids.length > 100
301
+ fail ArgumentError, 'invalid value for "upload_ids", number of items must be less than or equal to 100.'
302
+ end
303
+
304
+ @upload_ids = upload_ids
305
+ end
306
+
280
307
  # Checks equality by comparing each attribute.
281
308
  # @param [Object] Object to be compared
282
309
  def ==(o)
@@ -296,6 +323,7 @@ module Carbon
296
323
  include_all_children == o.include_all_children &&
297
324
  non_synced_only == o.non_synced_only &&
298
325
  request_ids == o.request_ids &&
326
+ upload_ids == o.upload_ids &&
299
327
  sync_error_message == o.sync_error_message &&
300
328
  include_containers == o.include_containers &&
301
329
  external_urls == o.external_urls &&
@@ -311,7 +339,7 @@ module Carbon
311
339
  # Calculates hash code according to all attributes.
312
340
  # @return [Integer] Hash code
313
341
  def hash
314
- [tags, source, name, tags_v2, ids, external_file_ids, sync_statuses, parent_file_ids, organization_user_data_source_id, embedding_generators, root_files_only, include_all_children, non_synced_only, request_ids, sync_error_message, include_containers, external_urls, file_types_at_source].hash
342
+ [tags, source, name, tags_v2, ids, external_file_ids, sync_statuses, parent_file_ids, organization_user_data_source_id, embedding_generators, root_files_only, include_all_children, non_synced_only, request_ids, upload_ids, sync_error_message, include_containers, external_urls, file_types_at_source].hash
315
343
  end
316
344
 
317
345
  # Builds the object from hash
@@ -114,7 +114,7 @@ module Carbon
114
114
  # Check to see if the all the properties in the model are valid
115
115
  # @return true if the model is valid
116
116
  def valid?
117
- webhook_type_validator = EnumAttributeValidator.new('String', ["ADD", "ALL_UPLOADED_FILES_QUEUED", "CANCEL", "CHECKUP", "DATA_SOURCE_READY", "EMBEDDING_STORAGE_MODIFIED", "FILES_CREATED", "FILES_SKIPPED", "FILE_DELETED", "FILE_ERROR", "FILE_READY", "FILE_STATISTICS_AGGREGATED", "FILE_SYNCING", "FILE_SYNC_LIMIT_REACHED", "MOVED_TO_COLD_STORAGE", "MOVED_TO_HOT_STORAGE", "ORGANIZATION_USER_DELETED", "RATE_LIMIT_ERROR", "REVOKE", "SPARSE_VECTOR_QUEUE_STATUS", "UPDATE", "WEBPAGE_ERROR", "WEBPAGE_READY", "WEBSCRAPE_URLS_READY"])
117
+ webhook_type_validator = EnumAttributeValidator.new('String', ["ADD", "ALL_FILES_PROCESSED", "ALL_UPLOADED_FILES_QUEUED", "CANCEL", "CHECKUP", "DATA_SOURCE_READY", "EMBEDDING_STORAGE_MODIFIED", "FILES_CREATED", "FILES_SKIPPED", "FILE_DELETED", "FILE_ERROR", "FILE_READY", "FILE_STATISTICS_AGGREGATED", "FILE_SYNCING", "FILE_SYNC_LIMIT_REACHED", "MOVED_TO_COLD_STORAGE", "MOVED_TO_HOT_STORAGE", "ORGANIZATION_USER_DELETED", "RATE_LIMIT_ERROR", "REVOKE", "SPARSE_VECTOR_QUEUE_STATUS", "UPDATE", "WEBPAGE_ERROR", "WEBPAGE_READY", "WEBSCRAPE_URLS_READY"])
118
118
  return false unless webhook_type_validator.valid?(@webhook_type)
119
119
  true
120
120
  end
@@ -122,7 +122,7 @@ module Carbon
122
122
  # Custom attribute writer method checking allowed values (enum).
123
123
  # @param [Object] webhook_type Object to be assigned
124
124
  def webhook_type=(webhook_type)
125
- validator = EnumAttributeValidator.new('String', ["ADD", "ALL_UPLOADED_FILES_QUEUED", "CANCEL", "CHECKUP", "DATA_SOURCE_READY", "EMBEDDING_STORAGE_MODIFIED", "FILES_CREATED", "FILES_SKIPPED", "FILE_DELETED", "FILE_ERROR", "FILE_READY", "FILE_STATISTICS_AGGREGATED", "FILE_SYNCING", "FILE_SYNC_LIMIT_REACHED", "MOVED_TO_COLD_STORAGE", "MOVED_TO_HOT_STORAGE", "ORGANIZATION_USER_DELETED", "RATE_LIMIT_ERROR", "REVOKE", "SPARSE_VECTOR_QUEUE_STATUS", "UPDATE", "WEBPAGE_ERROR", "WEBPAGE_READY", "WEBSCRAPE_URLS_READY"])
125
+ validator = EnumAttributeValidator.new('String', ["ADD", "ALL_FILES_PROCESSED", "ALL_UPLOADED_FILES_QUEUED", "CANCEL", "CHECKUP", "DATA_SOURCE_READY", "EMBEDDING_STORAGE_MODIFIED", "FILES_CREATED", "FILES_SKIPPED", "FILE_DELETED", "FILE_ERROR", "FILE_READY", "FILE_STATISTICS_AGGREGATED", "FILE_SYNCING", "FILE_SYNC_LIMIT_REACHED", "MOVED_TO_COLD_STORAGE", "MOVED_TO_HOT_STORAGE", "ORGANIZATION_USER_DELETED", "RATE_LIMIT_ERROR", "REVOKE", "SPARSE_VECTOR_QUEUE_STATUS", "UPDATE", "WEBPAGE_ERROR", "WEBPAGE_READY", "WEBSCRAPE_URLS_READY"])
126
126
  unless validator.valid?(webhook_type)
127
127
  fail ArgumentError, "invalid value for \"webhook_type\", must be one of #{validator.allowable_values}."
128
128
  end
@@ -55,6 +55,9 @@ module Carbon
55
55
  # If this flag is enabled, the file will be stored with Carbon, but no processing will be done.
56
56
  attr_accessor :store_file_only
57
57
 
58
+ # If the default proxies are blocked and not returning results, this flag can be enabled to use alternate proxies (residential and office). Scrapes might take longer to finish with this flag enabled.
59
+ attr_accessor :use_premium_proxies
60
+
58
61
  # Attribute mapping from ruby-style variable name to JSON key.
59
62
  def self.attribute_map
60
63
  {
@@ -76,7 +79,8 @@ module Carbon
76
79
  :'urls_to_scrape' => :'urls_to_scrape',
77
80
  :'download_css_and_media' => :'download_css_and_media',
78
81
  :'generate_chunks_only' => :'generate_chunks_only',
79
- :'store_file_only' => :'store_file_only'
82
+ :'store_file_only' => :'store_file_only',
83
+ :'use_premium_proxies' => :'use_premium_proxies'
80
84
  }
81
85
  end
82
86
 
@@ -106,7 +110,8 @@ module Carbon
106
110
  :'urls_to_scrape' => :'Array<String>',
107
111
  :'download_css_and_media' => :'Boolean',
108
112
  :'generate_chunks_only' => :'Boolean',
109
- :'store_file_only' => :'Boolean'
113
+ :'store_file_only' => :'Boolean',
114
+ :'use_premium_proxies' => :'Boolean'
110
115
  }
111
116
  end
112
117
 
@@ -255,6 +260,12 @@ module Carbon
255
260
  else
256
261
  self.store_file_only = false
257
262
  end
263
+
264
+ if attributes.key?(:'use_premium_proxies')
265
+ self.use_premium_proxies = attributes[:'use_premium_proxies']
266
+ else
267
+ self.use_premium_proxies = false
268
+ end
258
269
  end
259
270
 
260
271
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -343,7 +354,8 @@ module Carbon
343
354
  urls_to_scrape == o.urls_to_scrape &&
344
355
  download_css_and_media == o.download_css_and_media &&
345
356
  generate_chunks_only == o.generate_chunks_only &&
346
- store_file_only == o.store_file_only
357
+ store_file_only == o.store_file_only &&
358
+ use_premium_proxies == o.use_premium_proxies
347
359
  end
348
360
 
349
361
  # @see the `==` method
@@ -355,7 +367,7 @@ module Carbon
355
367
  # Calculates hash code according to all attributes.
356
368
  # @return [Integer] Hash code
357
369
  def hash
358
- [tags, url, max_pages_to_scrape, chunk_size, chunk_overlap, skip_embedding_generation, enable_auto_sync, generate_sparse_vectors, prepend_filename_to_chunks, html_tags_to_skip, css_classes_to_skip, css_selectors_to_skip, embedding_model, url_paths_to_include, url_paths_to_exclude, urls_to_scrape, download_css_and_media, generate_chunks_only, store_file_only].hash
370
+ [tags, url, max_pages_to_scrape, chunk_size, chunk_overlap, skip_embedding_generation, enable_auto_sync, generate_sparse_vectors, prepend_filename_to_chunks, html_tags_to_skip, css_classes_to_skip, css_selectors_to_skip, embedding_model, url_paths_to_include, url_paths_to_exclude, urls_to_scrape, download_css_and_media, generate_chunks_only, store_file_only, use_premium_proxies].hash
359
371
  end
360
372
 
361
373
  # Builds the object from hash
@@ -19,6 +19,15 @@ module Carbon
19
19
  # Custom file upload limit for the user across a single upload. If set, then the user will not be allowed to upload more files than this limit in a single upload. If not set, or if set to -1, then the user will have no limit.
20
20
  attr_accessor :max_files_per_upload
21
21
 
22
+ # Custom character upload limit for the user over *all* user's files across all uploads. If set, then the user will not be allowed to upload more characters than this limit. If not set, or if set to -1, then the user will have no limit.
23
+ attr_accessor :max_characters
24
+
25
+ # A single file upload from the user can not exceed this character limit. If set, then the file will not be synced if it exceeds this limit. If not set, or if set to -1, then the user will have no limit.
26
+ attr_accessor :max_characters_per_file
27
+
28
+ # Custom character upload limit for the user across a single upload. If set, then the user won't be able to sync more than this many characters in one upload. If not set, or if set to -1, then the user will have no limit.
29
+ attr_accessor :max_characters_per_upload
30
+
22
31
  # List of organization supplied user IDs
23
32
  attr_accessor :customer_ids
24
33
 
@@ -28,6 +37,9 @@ module Carbon
28
37
  :'auto_sync_enabled_sources' => :'auto_sync_enabled_sources',
29
38
  :'max_files' => :'max_files',
30
39
  :'max_files_per_upload' => :'max_files_per_upload',
40
+ :'max_characters' => :'max_characters',
41
+ :'max_characters_per_file' => :'max_characters_per_file',
42
+ :'max_characters_per_upload' => :'max_characters_per_upload',
31
43
  :'customer_ids' => :'customer_ids'
32
44
  }
33
45
  end
@@ -43,6 +55,9 @@ module Carbon
43
55
  :'auto_sync_enabled_sources' => :'AutoSyncEnabledSourcesProperty',
44
56
  :'max_files' => :'Integer',
45
57
  :'max_files_per_upload' => :'Integer',
58
+ :'max_characters' => :'Integer',
59
+ :'max_characters_per_file' => :'Integer',
60
+ :'max_characters_per_upload' => :'Integer',
46
61
  :'customer_ids' => :'Array<String>'
47
62
  }
48
63
  end
@@ -53,6 +68,9 @@ module Carbon
53
68
  :'auto_sync_enabled_sources',
54
69
  :'max_files',
55
70
  :'max_files_per_upload',
71
+ :'max_characters',
72
+ :'max_characters_per_file',
73
+ :'max_characters_per_upload',
56
74
  ])
57
75
  end
58
76
 
@@ -83,6 +101,18 @@ module Carbon
83
101
  self.max_files_per_upload = attributes[:'max_files_per_upload']
84
102
  end
85
103
 
104
+ if attributes.key?(:'max_characters')
105
+ self.max_characters = attributes[:'max_characters']
106
+ end
107
+
108
+ if attributes.key?(:'max_characters_per_file')
109
+ self.max_characters_per_file = attributes[:'max_characters_per_file']
110
+ end
111
+
112
+ if attributes.key?(:'max_characters_per_upload')
113
+ self.max_characters_per_upload = attributes[:'max_characters_per_upload']
114
+ end
115
+
86
116
  if attributes.key?(:'customer_ids')
87
117
  if (value = attributes[:'customer_ids']).is_a?(Array)
88
118
  self.customer_ids = value
@@ -102,6 +132,18 @@ module Carbon
102
132
  invalid_properties.push('invalid value for "max_files_per_upload", must be greater than or equal to -1.')
103
133
  end
104
134
 
135
+ if !@max_characters.nil? && @max_characters < -1
136
+ invalid_properties.push('invalid value for "max_characters", must be greater than or equal to -1.')
137
+ end
138
+
139
+ if !@max_characters_per_file.nil? && @max_characters_per_file < -1
140
+ invalid_properties.push('invalid value for "max_characters_per_file", must be greater than or equal to -1.')
141
+ end
142
+
143
+ if !@max_characters_per_upload.nil? && @max_characters_per_upload < -1
144
+ invalid_properties.push('invalid value for "max_characters_per_upload", must be greater than or equal to -1.')
145
+ end
146
+
105
147
  if @customer_ids.nil?
106
148
  invalid_properties.push('invalid value for "customer_ids", customer_ids cannot be nil.')
107
149
  end
@@ -118,6 +160,9 @@ module Carbon
118
160
  def valid?
119
161
  return false if !@max_files.nil? && @max_files < -1
120
162
  return false if !@max_files_per_upload.nil? && @max_files_per_upload < -1
163
+ return false if !@max_characters.nil? && @max_characters < -1
164
+ return false if !@max_characters_per_file.nil? && @max_characters_per_file < -1
165
+ return false if !@max_characters_per_upload.nil? && @max_characters_per_upload < -1
121
166
  return false if @customer_ids.nil?
122
167
  return false if @customer_ids.length > 100
123
168
  true
@@ -143,6 +188,36 @@ module Carbon
143
188
  @max_files_per_upload = max_files_per_upload
144
189
  end
145
190
 
191
+ # Custom attribute writer method with validation
192
+ # @param [Object] max_characters Value to be assigned
193
+ def max_characters=(max_characters)
194
+ if !max_characters.nil? && max_characters < -1
195
+ fail ArgumentError, 'invalid value for "max_characters", must be greater than or equal to -1.'
196
+ end
197
+
198
+ @max_characters = max_characters
199
+ end
200
+
201
+ # Custom attribute writer method with validation
202
+ # @param [Object] max_characters_per_file Value to be assigned
203
+ def max_characters_per_file=(max_characters_per_file)
204
+ if !max_characters_per_file.nil? && max_characters_per_file < -1
205
+ fail ArgumentError, 'invalid value for "max_characters_per_file", must be greater than or equal to -1.'
206
+ end
207
+
208
+ @max_characters_per_file = max_characters_per_file
209
+ end
210
+
211
+ # Custom attribute writer method with validation
212
+ # @param [Object] max_characters_per_upload Value to be assigned
213
+ def max_characters_per_upload=(max_characters_per_upload)
214
+ if !max_characters_per_upload.nil? && max_characters_per_upload < -1
215
+ fail ArgumentError, 'invalid value for "max_characters_per_upload", must be greater than or equal to -1.'
216
+ end
217
+
218
+ @max_characters_per_upload = max_characters_per_upload
219
+ end
220
+
146
221
  # Custom attribute writer method with validation
147
222
  # @param [Object] customer_ids Value to be assigned
148
223
  def customer_ids=(customer_ids)
@@ -165,6 +240,9 @@ module Carbon
165
240
  auto_sync_enabled_sources == o.auto_sync_enabled_sources &&
166
241
  max_files == o.max_files &&
167
242
  max_files_per_upload == o.max_files_per_upload &&
243
+ max_characters == o.max_characters &&
244
+ max_characters_per_file == o.max_characters_per_file &&
245
+ max_characters_per_upload == o.max_characters_per_upload &&
168
246
  customer_ids == o.customer_ids
169
247
  end
170
248
 
@@ -177,7 +255,7 @@ module Carbon
177
255
  # Calculates hash code according to all attributes.
178
256
  # @return [Integer] Hash code
179
257
  def hash
180
- [auto_sync_enabled_sources, max_files, max_files_per_upload, customer_ids].hash
258
+ [auto_sync_enabled_sources, max_files, max_files_per_upload, max_characters, max_characters_per_file, max_characters_per_upload, customer_ids].hash
181
259
  end
182
260
 
183
261
  # Builds the object from hash
@@ -19,12 +19,24 @@ module Carbon
19
19
  # Custom file upload limit for the user across a single upload. If set, then the user will not be allowed to upload more files than this limit in a single upload. If not set, or if set to -1, then the user will have no limit.
20
20
  attr_accessor :max_files_per_upload
21
21
 
22
+ # Custom character upload limit for the user over *all* user's files across all uploads. If set, then the user will not be allowed to upload more characters than this limit. If not set, or if set to -1, then the user will have no limit.
23
+ attr_accessor :max_characters
24
+
25
+ # A single file upload from the user can not exceed this character limit. If set, then the file will not be synced if it exceeds this limit. If not set, or if set to -1, then the user will have no limit.
26
+ attr_accessor :max_characters_per_file
27
+
28
+ # Custom character upload limit for the user across a single upload. If set, then the user won't be able to sync more than this many characters in one upload. If not set, or if set to -1, then the user will have no limit.
29
+ attr_accessor :max_characters_per_upload
30
+
22
31
  # Attribute mapping from ruby-style variable name to JSON key.
23
32
  def self.attribute_map
24
33
  {
25
34
  :'auto_sync_enabled_sources' => :'auto_sync_enabled_sources',
26
35
  :'max_files' => :'max_files',
27
- :'max_files_per_upload' => :'max_files_per_upload'
36
+ :'max_files_per_upload' => :'max_files_per_upload',
37
+ :'max_characters' => :'max_characters',
38
+ :'max_characters_per_file' => :'max_characters_per_file',
39
+ :'max_characters_per_upload' => :'max_characters_per_upload'
28
40
  }
29
41
  end
30
42
 
@@ -38,7 +50,10 @@ module Carbon
38
50
  {
39
51
  :'auto_sync_enabled_sources' => :'AutoSyncEnabledSourcesProperty',
40
52
  :'max_files' => :'Integer',
41
- :'max_files_per_upload' => :'Integer'
53
+ :'max_files_per_upload' => :'Integer',
54
+ :'max_characters' => :'Integer',
55
+ :'max_characters_per_file' => :'Integer',
56
+ :'max_characters_per_upload' => :'Integer'
42
57
  }
43
58
  end
44
59
 
@@ -47,7 +62,10 @@ module Carbon
47
62
  Set.new([
48
63
  :'auto_sync_enabled_sources',
49
64
  :'max_files',
50
- :'max_files_per_upload'
65
+ :'max_files_per_upload',
66
+ :'max_characters',
67
+ :'max_characters_per_file',
68
+ :'max_characters_per_upload'
51
69
  ])
52
70
  end
53
71
 
@@ -77,6 +95,18 @@ module Carbon
77
95
  if attributes.key?(:'max_files_per_upload')
78
96
  self.max_files_per_upload = attributes[:'max_files_per_upload']
79
97
  end
98
+
99
+ if attributes.key?(:'max_characters')
100
+ self.max_characters = attributes[:'max_characters']
101
+ end
102
+
103
+ if attributes.key?(:'max_characters_per_file')
104
+ self.max_characters_per_file = attributes[:'max_characters_per_file']
105
+ end
106
+
107
+ if attributes.key?(:'max_characters_per_upload')
108
+ self.max_characters_per_upload = attributes[:'max_characters_per_upload']
109
+ end
80
110
  end
81
111
 
82
112
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -91,6 +121,18 @@ module Carbon
91
121
  invalid_properties.push('invalid value for "max_files_per_upload", must be greater than or equal to -1.')
92
122
  end
93
123
 
124
+ if !@max_characters.nil? && @max_characters < -1
125
+ invalid_properties.push('invalid value for "max_characters", must be greater than or equal to -1.')
126
+ end
127
+
128
+ if !@max_characters_per_file.nil? && @max_characters_per_file < -1
129
+ invalid_properties.push('invalid value for "max_characters_per_file", must be greater than or equal to -1.')
130
+ end
131
+
132
+ if !@max_characters_per_upload.nil? && @max_characters_per_upload < -1
133
+ invalid_properties.push('invalid value for "max_characters_per_upload", must be greater than or equal to -1.')
134
+ end
135
+
94
136
  invalid_properties
95
137
  end
96
138
 
@@ -99,6 +141,9 @@ module Carbon
99
141
  def valid?
100
142
  return false if !@max_files.nil? && @max_files < -1
101
143
  return false if !@max_files_per_upload.nil? && @max_files_per_upload < -1
144
+ return false if !@max_characters.nil? && @max_characters < -1
145
+ return false if !@max_characters_per_file.nil? && @max_characters_per_file < -1
146
+ return false if !@max_characters_per_upload.nil? && @max_characters_per_upload < -1
102
147
  true
103
148
  end
104
149
 
@@ -122,6 +167,36 @@ module Carbon
122
167
  @max_files_per_upload = max_files_per_upload
123
168
  end
124
169
 
170
+ # Custom attribute writer method with validation
171
+ # @param [Object] max_characters Value to be assigned
172
+ def max_characters=(max_characters)
173
+ if !max_characters.nil? && max_characters < -1
174
+ fail ArgumentError, 'invalid value for "max_characters", must be greater than or equal to -1.'
175
+ end
176
+
177
+ @max_characters = max_characters
178
+ end
179
+
180
+ # Custom attribute writer method with validation
181
+ # @param [Object] max_characters_per_file Value to be assigned
182
+ def max_characters_per_file=(max_characters_per_file)
183
+ if !max_characters_per_file.nil? && max_characters_per_file < -1
184
+ fail ArgumentError, 'invalid value for "max_characters_per_file", must be greater than or equal to -1.'
185
+ end
186
+
187
+ @max_characters_per_file = max_characters_per_file
188
+ end
189
+
190
+ # Custom attribute writer method with validation
191
+ # @param [Object] max_characters_per_upload Value to be assigned
192
+ def max_characters_per_upload=(max_characters_per_upload)
193
+ if !max_characters_per_upload.nil? && max_characters_per_upload < -1
194
+ fail ArgumentError, 'invalid value for "max_characters_per_upload", must be greater than or equal to -1.'
195
+ end
196
+
197
+ @max_characters_per_upload = max_characters_per_upload
198
+ end
199
+
125
200
  # Checks equality by comparing each attribute.
126
201
  # @param [Object] Object to be compared
127
202
  def ==(o)
@@ -129,7 +204,10 @@ module Carbon
129
204
  self.class == o.class &&
130
205
  auto_sync_enabled_sources == o.auto_sync_enabled_sources &&
131
206
  max_files == o.max_files &&
132
- max_files_per_upload == o.max_files_per_upload
207
+ max_files_per_upload == o.max_files_per_upload &&
208
+ max_characters == o.max_characters &&
209
+ max_characters_per_file == o.max_characters_per_file &&
210
+ max_characters_per_upload == o.max_characters_per_upload
133
211
  end
134
212
 
135
213
  # @see the `==` method
@@ -141,7 +219,7 @@ module Carbon
141
219
  # Calculates hash code according to all attributes.
142
220
  # @return [Integer] Hash code
143
221
  def hash
144
- [auto_sync_enabled_sources, max_files, max_files_per_upload].hash
222
+ [auto_sync_enabled_sources, max_files, max_files_per_upload, max_characters, max_characters_per_file, max_characters_per_upload].hash
145
223
  end
146
224
 
147
225
  # Builds the object from hash
@@ -20,12 +20,24 @@ module Carbon
20
20
  # Custom file upload limit for the user across a single upload. If set, then the user will not be allowed to upload more files than this limit in a single upload. If not set, or if set to -1, then the user will have no limit.
21
21
  attr_accessor :max_files_per_upload
22
22
 
23
+ # Custom character upload limit for the user over *all* user's files across all uploads. If set, then the user will not be allowed to upload more characters than this limit. If not set, or if set to -1, then the user will have no limit.
24
+ attr_accessor :max_characters
25
+
26
+ # A single file upload from the user can not exceed this character limit. If set, then the file will not be synced if it exceeds this limit. If not set, or if set to -1, then the user will have no limit.
27
+ attr_accessor :max_characters_per_file
28
+
29
+ # Custom character upload limit for the user across a single upload. If set, then the user won't be able to sync more than this many characters in one upload. If not set, or if set to -1, then the user will have no limit.
30
+ attr_accessor :max_characters_per_upload
31
+
23
32
  # Attribute mapping from ruby-style variable name to JSON key.
24
33
  def self.attribute_map
25
34
  {
26
35
  :'auto_sync_enabled_sources' => :'auto_sync_enabled_sources',
27
36
  :'max_files' => :'max_files',
28
- :'max_files_per_upload' => :'max_files_per_upload'
37
+ :'max_files_per_upload' => :'max_files_per_upload',
38
+ :'max_characters' => :'max_characters',
39
+ :'max_characters_per_file' => :'max_characters_per_file',
40
+ :'max_characters_per_upload' => :'max_characters_per_upload'
29
41
  }
30
42
  end
31
43
 
@@ -39,7 +51,10 @@ module Carbon
39
51
  {
40
52
  :'auto_sync_enabled_sources' => :'AutoSyncEnabledSourcesProperty',
41
53
  :'max_files' => :'Integer',
42
- :'max_files_per_upload' => :'Integer'
54
+ :'max_files_per_upload' => :'Integer',
55
+ :'max_characters' => :'Integer',
56
+ :'max_characters_per_file' => :'Integer',
57
+ :'max_characters_per_upload' => :'Integer'
43
58
  }
44
59
  end
45
60
 
@@ -48,7 +63,10 @@ module Carbon
48
63
  Set.new([
49
64
  :'auto_sync_enabled_sources',
50
65
  :'max_files',
51
- :'max_files_per_upload'
66
+ :'max_files_per_upload',
67
+ :'max_characters',
68
+ :'max_characters_per_file',
69
+ :'max_characters_per_upload'
52
70
  ])
53
71
  end
54
72
 
@@ -78,6 +96,18 @@ module Carbon
78
96
  if attributes.key?(:'max_files_per_upload')
79
97
  self.max_files_per_upload = attributes[:'max_files_per_upload']
80
98
  end
99
+
100
+ if attributes.key?(:'max_characters')
101
+ self.max_characters = attributes[:'max_characters']
102
+ end
103
+
104
+ if attributes.key?(:'max_characters_per_file')
105
+ self.max_characters_per_file = attributes[:'max_characters_per_file']
106
+ end
107
+
108
+ if attributes.key?(:'max_characters_per_upload')
109
+ self.max_characters_per_upload = attributes[:'max_characters_per_upload']
110
+ end
81
111
  end
82
112
 
83
113
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -92,6 +122,18 @@ module Carbon
92
122
  invalid_properties.push('invalid value for "max_files_per_upload", must be greater than or equal to -1.')
93
123
  end
94
124
 
125
+ if !@max_characters.nil? && @max_characters < -1
126
+ invalid_properties.push('invalid value for "max_characters", must be greater than or equal to -1.')
127
+ end
128
+
129
+ if !@max_characters_per_file.nil? && @max_characters_per_file < -1
130
+ invalid_properties.push('invalid value for "max_characters_per_file", must be greater than or equal to -1.')
131
+ end
132
+
133
+ if !@max_characters_per_upload.nil? && @max_characters_per_upload < -1
134
+ invalid_properties.push('invalid value for "max_characters_per_upload", must be greater than or equal to -1.')
135
+ end
136
+
95
137
  invalid_properties
96
138
  end
97
139
 
@@ -100,6 +142,9 @@ module Carbon
100
142
  def valid?
101
143
  return false if !@max_files.nil? && @max_files < -1
102
144
  return false if !@max_files_per_upload.nil? && @max_files_per_upload < -1
145
+ return false if !@max_characters.nil? && @max_characters < -1
146
+ return false if !@max_characters_per_file.nil? && @max_characters_per_file < -1
147
+ return false if !@max_characters_per_upload.nil? && @max_characters_per_upload < -1
103
148
  true
104
149
  end
105
150
 
@@ -123,6 +168,36 @@ module Carbon
123
168
  @max_files_per_upload = max_files_per_upload
124
169
  end
125
170
 
171
+ # Custom attribute writer method with validation
172
+ # @param [Object] max_characters Value to be assigned
173
+ def max_characters=(max_characters)
174
+ if !max_characters.nil? && max_characters < -1
175
+ fail ArgumentError, 'invalid value for "max_characters", must be greater than or equal to -1.'
176
+ end
177
+
178
+ @max_characters = max_characters
179
+ end
180
+
181
+ # Custom attribute writer method with validation
182
+ # @param [Object] max_characters_per_file Value to be assigned
183
+ def max_characters_per_file=(max_characters_per_file)
184
+ if !max_characters_per_file.nil? && max_characters_per_file < -1
185
+ fail ArgumentError, 'invalid value for "max_characters_per_file", must be greater than or equal to -1.'
186
+ end
187
+
188
+ @max_characters_per_file = max_characters_per_file
189
+ end
190
+
191
+ # Custom attribute writer method with validation
192
+ # @param [Object] max_characters_per_upload Value to be assigned
193
+ def max_characters_per_upload=(max_characters_per_upload)
194
+ if !max_characters_per_upload.nil? && max_characters_per_upload < -1
195
+ fail ArgumentError, 'invalid value for "max_characters_per_upload", must be greater than or equal to -1.'
196
+ end
197
+
198
+ @max_characters_per_upload = max_characters_per_upload
199
+ end
200
+
126
201
  # Checks equality by comparing each attribute.
127
202
  # @param [Object] Object to be compared
128
203
  def ==(o)
@@ -130,7 +205,10 @@ module Carbon
130
205
  self.class == o.class &&
131
206
  auto_sync_enabled_sources == o.auto_sync_enabled_sources &&
132
207
  max_files == o.max_files &&
133
- max_files_per_upload == o.max_files_per_upload
208
+ max_files_per_upload == o.max_files_per_upload &&
209
+ max_characters == o.max_characters &&
210
+ max_characters_per_file == o.max_characters_per_file &&
211
+ max_characters_per_upload == o.max_characters_per_upload
134
212
  end
135
213
 
136
214
  # @see the `==` method
@@ -142,7 +220,7 @@ module Carbon
142
220
  # Calculates hash code according to all attributes.
143
221
  # @return [Integer] Hash code
144
222
  def hash
145
- [auto_sync_enabled_sources, max_files, max_files_per_upload].hash
223
+ [auto_sync_enabled_sources, max_files, max_files_per_upload, max_characters, max_characters_per_file, max_characters_per_upload].hash
146
224
  end
147
225
 
148
226
  # Builds the object from hash
@@ -69,6 +69,8 @@ module Carbon
69
69
 
70
70
  attr_accessor :request_id
71
71
 
72
+ attr_accessor :upload_id
73
+
72
74
  attr_accessor :sync_properties
73
75
 
74
76
  attr_accessor :messages_metadata
@@ -117,6 +119,7 @@ module Carbon
117
119
  :'source_created_at' => :'source_created_at',
118
120
  :'generate_sparse_vectors' => :'generate_sparse_vectors',
119
121
  :'request_id' => :'request_id',
122
+ :'upload_id' => :'upload_id',
120
123
  :'sync_properties' => :'sync_properties',
121
124
  :'messages_metadata' => :'messages_metadata',
122
125
  :'file_contents_deleted' => :'file_contents_deleted',
@@ -165,6 +168,7 @@ module Carbon
165
168
  :'source_created_at' => :'Time',
166
169
  :'generate_sparse_vectors' => :'Boolean',
167
170
  :'request_id' => :'String',
171
+ :'upload_id' => :'String',
168
172
  :'sync_properties' => :'Object',
169
173
  :'messages_metadata' => :'Object',
170
174
  :'file_contents_deleted' => :'Boolean',
@@ -200,6 +204,7 @@ module Carbon
200
204
  :'source_created_at',
201
205
  :'generate_sparse_vectors',
202
206
  :'request_id',
207
+ :'upload_id',
203
208
  :'hot_storage_time_to_live',
204
209
  ])
205
210
  end
@@ -337,6 +342,10 @@ module Carbon
337
342
  self.request_id = attributes[:'request_id']
338
343
  end
339
344
 
345
+ if attributes.key?(:'upload_id')
346
+ self.upload_id = attributes[:'upload_id']
347
+ end
348
+
340
349
  if attributes.key?(:'sync_properties')
341
350
  self.sync_properties = attributes[:'sync_properties']
342
351
  end
@@ -494,6 +503,7 @@ module Carbon
494
503
  source_created_at == o.source_created_at &&
495
504
  generate_sparse_vectors == o.generate_sparse_vectors &&
496
505
  request_id == o.request_id &&
506
+ upload_id == o.upload_id &&
497
507
  sync_properties == o.sync_properties &&
498
508
  messages_metadata == o.messages_metadata &&
499
509
  file_contents_deleted == o.file_contents_deleted &&
@@ -513,7 +523,7 @@ module Carbon
513
523
  # Calculates hash code according to all attributes.
514
524
  # @return [Integer] Hash code
515
525
  def hash
516
- [tags, id, source, organization_id, organization_supplied_user_id, organization_user_data_source_id, external_file_id, external_url, sync_status, sync_error_message, last_sync, file_statistics, file_metadata, embedding_properties, chunk_size, chunk_overlap, chunk_properties, ocr_properties, ocr_job_started_at, name, parent_id, enable_auto_sync, presigned_url, parsed_text_url, additional_presigned_urls, skip_embedding_generation, source_created_at, generate_sparse_vectors, request_id, sync_properties, messages_metadata, file_contents_deleted, supports_cold_storage, hot_storage_time_to_live, embedding_storage_status, created_at, updated_at].hash
526
+ [tags, id, source, organization_id, organization_supplied_user_id, organization_user_data_source_id, external_file_id, external_url, sync_status, sync_error_message, last_sync, file_statistics, file_metadata, embedding_properties, chunk_size, chunk_overlap, chunk_properties, ocr_properties, ocr_job_started_at, name, parent_id, enable_auto_sync, presigned_url, parsed_text_url, additional_presigned_urls, skip_embedding_generation, source_created_at, generate_sparse_vectors, request_id, upload_id, sync_properties, messages_metadata, file_contents_deleted, supports_cold_storage, hot_storage_time_to_live, embedding_storage_status, created_at, updated_at].hash
517
527
  end
518
528
 
519
529
  # Builds the object from hash
@@ -51,6 +51,9 @@ module Carbon
51
51
  # If this flag is enabled, the file will be stored with Carbon, but no processing will be done.
52
52
  attr_accessor :store_file_only
53
53
 
54
+ # If the default proxies are blocked and not returning results, this flag can be enabled to use alternate proxies (residential and office). Scrapes might take longer to finish with this flag enabled.
55
+ attr_accessor :use_premium_proxies
56
+
54
57
  # Attribute mapping from ruby-style variable name to JSON key.
55
58
  def self.attribute_map
56
59
  {
@@ -71,7 +74,8 @@ module Carbon
71
74
  :'url_paths_to_include' => :'url_paths_to_include',
72
75
  :'download_css_and_media' => :'download_css_and_media',
73
76
  :'generate_chunks_only' => :'generate_chunks_only',
74
- :'store_file_only' => :'store_file_only'
77
+ :'store_file_only' => :'store_file_only',
78
+ :'use_premium_proxies' => :'use_premium_proxies'
75
79
  }
76
80
  end
77
81
 
@@ -100,7 +104,8 @@ module Carbon
100
104
  :'url_paths_to_include' => :'Array<String>',
101
105
  :'download_css_and_media' => :'Boolean',
102
106
  :'generate_chunks_only' => :'Boolean',
103
- :'store_file_only' => :'Boolean'
107
+ :'store_file_only' => :'Boolean',
108
+ :'use_premium_proxies' => :'Boolean'
104
109
  }
105
110
  end
106
111
 
@@ -244,6 +249,12 @@ module Carbon
244
249
  else
245
250
  self.store_file_only = false
246
251
  end
252
+
253
+ if attributes.key?(:'use_premium_proxies')
254
+ self.use_premium_proxies = attributes[:'use_premium_proxies']
255
+ else
256
+ self.use_premium_proxies = false
257
+ end
247
258
  end
248
259
 
249
260
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -331,7 +342,8 @@ module Carbon
331
342
  url_paths_to_include == o.url_paths_to_include &&
332
343
  download_css_and_media == o.download_css_and_media &&
333
344
  generate_chunks_only == o.generate_chunks_only &&
334
- store_file_only == o.store_file_only
345
+ store_file_only == o.store_file_only &&
346
+ use_premium_proxies == o.use_premium_proxies
335
347
  end
336
348
 
337
349
  # @see the `==` method
@@ -343,7 +355,7 @@ module Carbon
343
355
  # Calculates hash code according to all attributes.
344
356
  # @return [Integer] Hash code
345
357
  def hash
346
- [tags, url, recursion_depth, max_pages_to_scrape, chunk_size, chunk_overlap, skip_embedding_generation, enable_auto_sync, generate_sparse_vectors, prepend_filename_to_chunks, html_tags_to_skip, css_classes_to_skip, css_selectors_to_skip, embedding_model, url_paths_to_include, download_css_and_media, generate_chunks_only, store_file_only].hash
358
+ [tags, url, recursion_depth, max_pages_to_scrape, chunk_size, chunk_overlap, skip_embedding_generation, enable_auto_sync, generate_sparse_vectors, prepend_filename_to_chunks, html_tags_to_skip, css_classes_to_skip, css_selectors_to_skip, embedding_model, url_paths_to_include, download_css_and_media, generate_chunks_only, store_file_only, use_premium_proxies].hash
347
359
  end
348
360
 
349
361
  # Builds the object from hash
@@ -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.39'
10
+ VERSION = '0.2.41'
11
11
  end
@@ -103,6 +103,12 @@ describe Carbon::OrganizationUserFilesToSyncFilters do
103
103
  end
104
104
  end
105
105
 
106
+ describe 'test attribute "upload_ids"' do
107
+ it 'should work' do
108
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
109
+ end
110
+ end
111
+
106
112
  describe 'test attribute "sync_error_message"' do
107
113
  it 'should work' do
108
114
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -22,7 +22,7 @@ describe Carbon::SentWebhookPayload do
22
22
  describe 'test attribute "webhook_type"' do
23
23
  it 'should work' do
24
24
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
25
- # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["ADD", "ALL_UPLOADED_FILES_QUEUED", "CANCEL", "CHECKUP", "DATA_SOURCE_READY", "EMBEDDING_STORAGE_MODIFIED", "FILES_CREATED", "FILES_SKIPPED", "FILE_DELETED", "FILE_ERROR", "FILE_READY", "FILE_STATISTICS_AGGREGATED", "FILE_SYNCING", "FILE_SYNC_LIMIT_REACHED", "MOVED_TO_COLD_STORAGE", "MOVED_TO_HOT_STORAGE", "ORGANIZATION_USER_DELETED", "RATE_LIMIT_ERROR", "REVOKE", "SPARSE_VECTOR_QUEUE_STATUS", "UPDATE", "WEBPAGE_ERROR", "WEBPAGE_READY", "WEBSCRAPE_URLS_READY"])
25
+ # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["ADD", "ALL_FILES_PROCESSED", "ALL_UPLOADED_FILES_QUEUED", "CANCEL", "CHECKUP", "DATA_SOURCE_READY", "EMBEDDING_STORAGE_MODIFIED", "FILES_CREATED", "FILES_SKIPPED", "FILE_DELETED", "FILE_ERROR", "FILE_READY", "FILE_STATISTICS_AGGREGATED", "FILE_SYNCING", "FILE_SYNC_LIMIT_REACHED", "MOVED_TO_COLD_STORAGE", "MOVED_TO_HOT_STORAGE", "ORGANIZATION_USER_DELETED", "RATE_LIMIT_ERROR", "REVOKE", "SPARSE_VECTOR_QUEUE_STATUS", "UPDATE", "WEBPAGE_ERROR", "WEBPAGE_READY", "WEBSCRAPE_URLS_READY"])
26
26
  # validator.allowable_values.each do |value|
27
27
  # expect { instance.webhook_type = value }.not_to raise_error
28
28
  # end
@@ -133,4 +133,10 @@ describe Carbon::SitemapScrapeRequest do
133
133
  end
134
134
  end
135
135
 
136
+ describe 'test attribute "use_premium_proxies"' do
137
+ it 'should work' do
138
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
139
+ end
140
+ end
141
+
136
142
  end
@@ -37,6 +37,24 @@ describe Carbon::UpdateUsersInput do
37
37
  end
38
38
  end
39
39
 
40
+ describe 'test attribute "max_characters"' do
41
+ it 'should work' do
42
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
43
+ end
44
+ end
45
+
46
+ describe 'test attribute "max_characters_per_file"' do
47
+ it 'should work' do
48
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
49
+ end
50
+ end
51
+
52
+ describe 'test attribute "max_characters_per_upload"' do
53
+ it 'should work' do
54
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
55
+ end
56
+ end
57
+
40
58
  describe 'test attribute "customer_ids"' do
41
59
  it 'should work' do
42
60
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -37,4 +37,22 @@ describe Carbon::UserConfigurationNullable do
37
37
  end
38
38
  end
39
39
 
40
+ describe 'test attribute "max_characters"' do
41
+ it 'should work' do
42
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
43
+ end
44
+ end
45
+
46
+ describe 'test attribute "max_characters_per_file"' do
47
+ it 'should work' do
48
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
49
+ end
50
+ end
51
+
52
+ describe 'test attribute "max_characters_per_upload"' do
53
+ it 'should work' do
54
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
55
+ end
56
+ end
57
+
40
58
  end
@@ -37,4 +37,22 @@ describe Carbon::UserConfiguration do
37
37
  end
38
38
  end
39
39
 
40
+ describe 'test attribute "max_characters"' do
41
+ it 'should work' do
42
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
43
+ end
44
+ end
45
+
46
+ describe 'test attribute "max_characters_per_file"' do
47
+ it 'should work' do
48
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
49
+ end
50
+ end
51
+
52
+ describe 'test attribute "max_characters_per_upload"' do
53
+ it 'should work' do
54
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
55
+ end
56
+ end
57
+
40
58
  end
@@ -193,6 +193,12 @@ describe Carbon::UserFile do
193
193
  end
194
194
  end
195
195
 
196
+ describe 'test attribute "upload_id"' do
197
+ it 'should work' do
198
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
199
+ end
200
+ end
201
+
196
202
  describe 'test attribute "sync_properties"' do
197
203
  it 'should work' do
198
204
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -127,4 +127,10 @@ describe Carbon::WebscrapeRequest do
127
127
  end
128
128
  end
129
129
 
130
+ describe 'test attribute "use_premium_proxies"' do
131
+ it 'should work' do
132
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
133
+ end
134
+ end
135
+
130
136
  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.39
4
+ version: 0.2.41
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-09 00:00:00.000000000 Z
11
+ date: 2024-10-16 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday