context.dev 2.21.0 → 2.22.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (229) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +24 -0
  3. data/README.md +1 -1
  4. data/lib/context_dev/client.rb +4 -9
  5. data/lib/context_dev/models/batch_cancel_params.rb +2 -2
  6. data/lib/context_dev/models/batch_cancel_response.rb +16 -21
  7. data/lib/context_dev/models/batch_delete_params.rb +2 -2
  8. data/lib/context_dev/models/batch_delete_response.rb +8 -8
  9. data/lib/context_dev/models/batch_get_results_params.rb +2 -2
  10. data/lib/context_dev/models/batch_get_results_response.rb +17 -22
  11. data/lib/context_dev/models/batch_list_response.rb +38 -47
  12. data/lib/context_dev/models/batch_retrieve_params.rb +2 -2
  13. data/lib/context_dev/models/batch_retrieve_response.rb +37 -46
  14. data/lib/context_dev/models/batch_submit_params.rb +80 -109
  15. data/lib/context_dev/models/batch_submit_response.rb +18 -28
  16. data/lib/context_dev/models/brand_retrieve_params.rb +90 -149
  17. data/lib/context_dev/models/brand_retrieve_response.rb +18 -22
  18. data/lib/context_dev/models/brand_search_params.rb +2 -3
  19. data/lib/context_dev/models/brand_search_response.rb +8 -8
  20. data/lib/context_dev/models/crawl_controls.rb +1 -2
  21. data/lib/context_dev/models/feedback_submit_params.rb +2 -2
  22. data/lib/context_dev/models/feedback_submit_response.rb +8 -8
  23. data/lib/context_dev/models/industry_retrieve_naics_params.rb +17 -32
  24. data/lib/context_dev/models/industry_retrieve_naics_response.rb +10 -10
  25. data/lib/context_dev/models/industry_retrieve_sic_params.rb +20 -39
  26. data/lib/context_dev/models/industry_retrieve_sic_response.rb +10 -10
  27. data/lib/context_dev/models/intake.rb +7 -13
  28. data/lib/context_dev/models/log_list_response.rb +14 -10
  29. data/lib/context_dev/models/log_retrieve_response.rb +15 -41
  30. data/lib/context_dev/models/monitor_create_params.rb +238 -72
  31. data/lib/context_dev/models/monitor_create_response.rb +364 -175
  32. data/lib/context_dev/models/monitor_delete_params.rb +3 -1
  33. data/lib/context_dev/models/monitor_delete_response.rb +44 -1
  34. data/lib/context_dev/models/monitor_get_credit_usage_response.rb +43 -1
  35. data/lib/context_dev/models/monitor_get_limits_response.rb +47 -7
  36. data/lib/context_dev/models/monitor_list_account_changes_response.rb +143 -20
  37. data/lib/context_dev/models/monitor_list_account_runs_response.rb +50 -8
  38. data/lib/context_dev/models/monitor_list_changes_params.rb +2 -1
  39. data/lib/context_dev/models/monitor_list_changes_response.rb +143 -20
  40. data/lib/context_dev/models/monitor_list_params.rb +3 -3
  41. data/lib/context_dev/models/monitor_list_response.rb +304 -106
  42. data/lib/context_dev/models/monitor_list_runs_params.rb +2 -1
  43. data/lib/context_dev/models/monitor_list_runs_response.rb +50 -8
  44. data/lib/context_dev/models/monitor_retrieve_change_params.rb +3 -1
  45. data/lib/context_dev/models/monitor_retrieve_change_response.rb +45 -15
  46. data/lib/context_dev/models/monitor_retrieve_params.rb +3 -1
  47. data/lib/context_dev/models/monitor_retrieve_response.rb +361 -171
  48. data/lib/context_dev/models/monitor_retrieve_run_params.rb +6 -2
  49. data/lib/context_dev/models/monitor_retrieve_run_response.rb +45 -8
  50. data/lib/context_dev/models/monitor_rotate_webhook_secret_params.rb +3 -1
  51. data/lib/context_dev/models/monitor_rotate_webhook_secret_response.rb +364 -172
  52. data/lib/context_dev/models/monitor_run_params.rb +3 -1
  53. data/lib/context_dev/models/monitor_run_response.rb +42 -4
  54. data/lib/context_dev/models/monitor_update_params.rb +239 -71
  55. data/lib/context_dev/models/monitor_update_response.rb +361 -171
  56. data/lib/context_dev/models/news_search_params.rb +10 -6
  57. data/lib/context_dev/models/news_search_response.rb +8 -8
  58. data/lib/context_dev/models/parse_handle_params.rb +9 -20
  59. data/lib/context_dev/models/parse_handle_response.rb +8 -8
  60. data/lib/context_dev/models/person_enrich_params.rb +76 -50
  61. data/lib/context_dev/models/person_enrich_response.rb +8 -8
  62. data/lib/context_dev/models/utility_prefetch_params.rb +15 -29
  63. data/lib/context_dev/models/utility_prefetch_response.rb +10 -10
  64. data/lib/context_dev/models/web_answers_params.rb +28 -47
  65. data/lib/context_dev/models/web_answers_response.rb +9 -8
  66. data/lib/context_dev/models/web_extract_competitors_params.rb +17 -32
  67. data/lib/context_dev/models/web_extract_competitors_response.rb +8 -8
  68. data/lib/context_dev/models/web_extract_styleguide_params.rb +22 -44
  69. data/lib/context_dev/models/web_extract_styleguide_response.rb +34 -44
  70. data/lib/context_dev/models/web_map_urls_params.rb +30 -51
  71. data/lib/context_dev/models/web_map_urls_response.rb +8 -8
  72. data/lib/context_dev/models/web_scrape_params.rb +193 -191
  73. data/lib/context_dev/models/web_scrape_response.rb +219 -95
  74. data/lib/context_dev/models/web_screenshot_params.rb +20 -39
  75. data/lib/context_dev/models/web_screenshot_response.rb +18 -28
  76. data/lib/context_dev/models/web_search_params.rb +76 -65
  77. data/lib/context_dev/models/web_search_response.rb +68 -27
  78. data/lib/context_dev/models/web_web_crawl_md_params.rb +41 -70
  79. data/lib/context_dev/models/web_web_crawl_md_response.rb +11 -15
  80. data/lib/context_dev/models/webhook_delivery.rb +3 -7
  81. data/lib/context_dev/models/webhooks/attempt.rb +3 -3
  82. data/lib/context_dev/models/webhooks/delivery.rb +16 -11
  83. data/lib/context_dev/models/webhooks/delivery_list_attempts_params.rb +2 -6
  84. data/lib/context_dev/models/webhooks/delivery_list_attempts_response.rb +8 -8
  85. data/lib/context_dev/models/webhooks/delivery_list_params.rb +4 -4
  86. data/lib/context_dev/models/webhooks/delivery_list_response.rb +8 -8
  87. data/lib/context_dev/models/webhooks/delivery_retrieve_params.rb +2 -6
  88. data/lib/context_dev/models/webhooks/delivery_retrieve_response.rb +8 -8
  89. data/lib/context_dev/models/webhooks/delivery_retry_params.rb +4 -4
  90. data/lib/context_dev/models/webhooks/delivery_retry_response.rb +8 -8
  91. data/lib/context_dev/models/webhooks/delivery_summary.rb +16 -11
  92. data/lib/context_dev/resources/batch.rb +17 -16
  93. data/lib/context_dev/resources/brand.rb +6 -8
  94. data/lib/context_dev/resources/feedback.rb +4 -5
  95. data/lib/context_dev/resources/industry.rb +9 -11
  96. data/lib/context_dev/resources/logs.rb +4 -5
  97. data/lib/context_dev/resources/monitors.rb +50 -53
  98. data/lib/context_dev/resources/news.rb +4 -8
  99. data/lib/context_dev/resources/parse.rb +4 -5
  100. data/lib/context_dev/resources/people.rb +11 -13
  101. data/lib/context_dev/resources/utility.rb +4 -11
  102. data/lib/context_dev/resources/web.rb +69 -94
  103. data/lib/context_dev/resources/webhooks/deliveries.rb +10 -18
  104. data/lib/context_dev/resources/webhooks.rb +1 -1
  105. data/lib/context_dev/version.rb +1 -1
  106. data/rbi/context_dev/client.rbi +4 -9
  107. data/rbi/context_dev/models/batch_cancel_params.rbi +2 -2
  108. data/rbi/context_dev/models/batch_cancel_response.rbi +17 -21
  109. data/rbi/context_dev/models/batch_delete_params.rbi +2 -2
  110. data/rbi/context_dev/models/batch_delete_response.rbi +9 -9
  111. data/rbi/context_dev/models/batch_get_results_params.rbi +2 -2
  112. data/rbi/context_dev/models/batch_get_results_response.rbi +18 -26
  113. data/rbi/context_dev/models/batch_list_response.rbi +41 -53
  114. data/rbi/context_dev/models/batch_retrieve_params.rbi +2 -2
  115. data/rbi/context_dev/models/batch_retrieve_response.rbi +40 -52
  116. data/rbi/context_dev/models/batch_submit_params.rbi +87 -147
  117. data/rbi/context_dev/models/batch_submit_response.rbi +19 -31
  118. data/rbi/context_dev/models/brand_retrieve_params.rbi +99 -190
  119. data/rbi/context_dev/models/brand_retrieve_response.rbi +19 -25
  120. data/rbi/context_dev/models/brand_search_params.rbi +2 -4
  121. data/rbi/context_dev/models/brand_search_response.rbi +9 -9
  122. data/rbi/context_dev/models/crawl_controls.rbi +1 -2
  123. data/rbi/context_dev/models/feedback_submit_params.rbi +2 -2
  124. data/rbi/context_dev/models/feedback_submit_response.rbi +9 -9
  125. data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +19 -42
  126. data/rbi/context_dev/models/industry_retrieve_naics_response.rbi +11 -11
  127. data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +22 -51
  128. data/rbi/context_dev/models/industry_retrieve_sic_response.rbi +11 -11
  129. data/rbi/context_dev/models/intake.rbi +7 -19
  130. data/rbi/context_dev/models/log_list_response.rbi +13 -11
  131. data/rbi/context_dev/models/log_retrieve_response.rbi +13 -76
  132. data/rbi/context_dev/models/monitor_create_params.rbi +418 -78
  133. data/rbi/context_dev/models/monitor_create_response.rbi +654 -287
  134. data/rbi/context_dev/models/monitor_delete_params.rbi +6 -1
  135. data/rbi/context_dev/models/monitor_delete_response.rbi +89 -3
  136. data/rbi/context_dev/models/monitor_get_credit_usage_response.rbi +77 -3
  137. data/rbi/context_dev/models/monitor_get_limits_response.rbi +83 -10
  138. data/rbi/context_dev/models/monitor_list_account_changes_response.rbi +236 -24
  139. data/rbi/context_dev/models/monitor_list_account_runs_response.rbi +86 -12
  140. data/rbi/context_dev/models/monitor_list_changes_params.rbi +2 -0
  141. data/rbi/context_dev/models/monitor_list_changes_response.rbi +234 -24
  142. data/rbi/context_dev/models/monitor_list_params.rbi +4 -4
  143. data/rbi/context_dev/models/monitor_list_response.rbi +502 -130
  144. data/rbi/context_dev/models/monitor_list_runs_params.rbi +2 -0
  145. data/rbi/context_dev/models/monitor_list_runs_response.rbi +84 -12
  146. data/rbi/context_dev/models/monitor_retrieve_change_params.rbi +6 -1
  147. data/rbi/context_dev/models/monitor_retrieve_change_response.rbi +79 -15
  148. data/rbi/context_dev/models/monitor_retrieve_params.rbi +6 -1
  149. data/rbi/context_dev/models/monitor_retrieve_response.rbi +654 -283
  150. data/rbi/context_dev/models/monitor_retrieve_run_params.rbi +9 -1
  151. data/rbi/context_dev/models/monitor_retrieve_run_response.rbi +77 -9
  152. data/rbi/context_dev/models/monitor_rotate_webhook_secret_params.rbi +6 -1
  153. data/rbi/context_dev/models/monitor_rotate_webhook_secret_response.rbi +659 -288
  154. data/rbi/context_dev/models/monitor_run_params.rbi +6 -1
  155. data/rbi/context_dev/models/monitor_run_response.rbi +82 -9
  156. data/rbi/context_dev/models/monitor_update_params.rbi +420 -75
  157. data/rbi/context_dev/models/monitor_update_response.rbi +650 -281
  158. data/rbi/context_dev/models/news_search_params.rbi +10 -2
  159. data/rbi/context_dev/models/news_search_response.rbi +9 -9
  160. data/rbi/context_dev/models/parse_handle_params.rbi +10 -29
  161. data/rbi/context_dev/models/parse_handle_response.rbi +9 -9
  162. data/rbi/context_dev/models/person_enrich_params.rbi +86 -44
  163. data/rbi/context_dev/models/person_enrich_response.rbi +9 -9
  164. data/rbi/context_dev/models/utility_prefetch_params.rbi +15 -27
  165. data/rbi/context_dev/models/utility_prefetch_response.rbi +11 -11
  166. data/rbi/context_dev/models/web_answers_params.rbi +33 -63
  167. data/rbi/context_dev/models/web_answers_response.rbi +11 -9
  168. data/rbi/context_dev/models/web_extract_competitors_params.rbi +19 -42
  169. data/rbi/context_dev/models/web_extract_competitors_response.rbi +9 -9
  170. data/rbi/context_dev/models/web_extract_styleguide_params.rbi +25 -61
  171. data/rbi/context_dev/models/web_extract_styleguide_response.rbi +36 -51
  172. data/rbi/context_dev/models/web_map_urls_params.rbi +33 -68
  173. data/rbi/context_dev/models/web_map_urls_response.rbi +9 -9
  174. data/rbi/context_dev/models/web_scrape_params.rbi +212 -206
  175. data/rbi/context_dev/models/web_scrape_response.rbi +296 -120
  176. data/rbi/context_dev/models/web_screenshot_params.rbi +22 -51
  177. data/rbi/context_dev/models/web_screenshot_response.rbi +20 -35
  178. data/rbi/context_dev/models/web_search_params.rbi +114 -82
  179. data/rbi/context_dev/models/web_search_response.rbi +145 -33
  180. data/rbi/context_dev/models/web_web_crawl_md_params.rbi +45 -95
  181. data/rbi/context_dev/models/web_web_crawl_md_response.rbi +12 -18
  182. data/rbi/context_dev/models/webhook_delivery.rbi +3 -9
  183. data/rbi/context_dev/models/webhooks/attempt.rbi +3 -3
  184. data/rbi/context_dev/models/webhooks/delivery.rbi +14 -11
  185. data/rbi/context_dev/models/webhooks/delivery_list_attempts_params.rbi +2 -4
  186. data/rbi/context_dev/models/webhooks/delivery_list_attempts_response.rbi +9 -9
  187. data/rbi/context_dev/models/webhooks/delivery_list_params.rbi +4 -4
  188. data/rbi/context_dev/models/webhooks/delivery_list_response.rbi +9 -9
  189. data/rbi/context_dev/models/webhooks/delivery_retrieve_params.rbi +2 -4
  190. data/rbi/context_dev/models/webhooks/delivery_retrieve_response.rbi +9 -9
  191. data/rbi/context_dev/models/webhooks/delivery_retry_params.rbi +4 -4
  192. data/rbi/context_dev/models/webhooks/delivery_retry_response.rbi +9 -9
  193. data/rbi/context_dev/models/webhooks/delivery_summary.rbi +14 -11
  194. data/rbi/context_dev/resources/batch.rbi +19 -18
  195. data/rbi/context_dev/resources/brand.rbi +6 -9
  196. data/rbi/context_dev/resources/feedback.rbi +4 -5
  197. data/rbi/context_dev/resources/industry.rbi +11 -27
  198. data/rbi/context_dev/resources/logs.rbi +4 -5
  199. data/rbi/context_dev/resources/monitors.rbi +71 -49
  200. data/rbi/context_dev/resources/news.rbi +4 -8
  201. data/rbi/context_dev/resources/parse.rbi +7 -14
  202. data/rbi/context_dev/resources/people.rbi +15 -13
  203. data/rbi/context_dev/resources/utility.rbi +4 -11
  204. data/rbi/context_dev/resources/web.rbi +89 -190
  205. data/rbi/context_dev/resources/webhooks/deliveries.rbi +10 -12
  206. data/rbi/context_dev/resources/webhooks.rbi +1 -1
  207. data/sig/context_dev/models/log_retrieve_response.rbs +0 -28
  208. data/sig/context_dev/models/monitor_create_params.rbs +113 -0
  209. data/sig/context_dev/models/monitor_create_response.rbs +203 -53
  210. data/sig/context_dev/models/monitor_delete_response.rbs +46 -3
  211. data/sig/context_dev/models/monitor_get_credit_usage_response.rbs +36 -3
  212. data/sig/context_dev/models/monitor_get_limits_response.rbs +36 -3
  213. data/sig/context_dev/models/monitor_list_account_changes_response.rbs +111 -8
  214. data/sig/context_dev/models/monitor_list_account_runs_response.rbs +36 -3
  215. data/sig/context_dev/models/monitor_list_changes_response.rbs +111 -8
  216. data/sig/context_dev/models/monitor_list_response.rbs +149 -3
  217. data/sig/context_dev/models/monitor_list_runs_response.rbs +36 -3
  218. data/sig/context_dev/models/monitor_retrieve_change_response.rbs +33 -0
  219. data/sig/context_dev/models/monitor_retrieve_response.rbs +203 -53
  220. data/sig/context_dev/models/monitor_retrieve_run_response.rbs +33 -0
  221. data/sig/context_dev/models/monitor_rotate_webhook_secret_response.rbs +203 -53
  222. data/sig/context_dev/models/monitor_run_response.rbs +48 -3
  223. data/sig/context_dev/models/monitor_update_params.rbs +113 -0
  224. data/sig/context_dev/models/monitor_update_response.rbs +203 -53
  225. data/sig/context_dev/models/web_scrape_response.rbs +204 -27
  226. data/sig/context_dev/models/web_search_params.rbs +25 -0
  227. data/sig/context_dev/models/web_search_response.rbs +48 -0
  228. data/sig/context_dev/resources/web.rbs +1 -0
  229. metadata +2 -2
@@ -29,8 +29,8 @@ module ContextDev
29
29
  sig { params(tags: T::Array[String]).void }
30
30
  attr_writer :tags
31
31
 
32
- # Completion webhook settings. Cannot be combined with webhookUrl. Omitting retry
33
- # preserves legacy delivery; retry: {} opts into durable retries.
32
+ # Where to send the batch's final-status event. Omit `retry` for one attempt; `{}`
33
+ # uses the default retry schedule.
34
34
  sig { returns(T.nilable(ContextDev::BatchSubmitParams::Webhook)) }
35
35
  attr_reader :webhook
36
36
 
@@ -47,8 +47,8 @@ module ContextDev
47
47
  sig { params(webhook_url: String).void }
48
48
  attr_writer :webhook_url
49
49
 
50
- # Any string unique to this submission. Retries with the same key return the
51
- # original batch.
50
+ # Unique key per submission. Retrying with the same key and body returns the
51
+ # original batch; a different body returns `409`.
52
52
  sig { returns(T.nilable(String)) }
53
53
  attr_reader :idempotency_key
54
54
 
@@ -74,14 +74,14 @@ module ContextDev
74
74
  input:,
75
75
  # Tags stored on the batch. Filter the batch list by them later.
76
76
  tags: nil,
77
- # Completion webhook settings. Cannot be combined with webhookUrl. Omitting retry
78
- # preserves legacy delivery; retry: {} opts into durable retries.
77
+ # Where to send the batch's final-status event. Omit `retry` for one attempt; `{}`
78
+ # uses the default retry schedule.
79
79
  webhook: nil,
80
80
  # Legacy URL notified when the batch finishes. Preserves one best-effort attempt.
81
81
  # Cannot be combined with webhook.
82
82
  webhook_url: nil,
83
- # Any string unique to this submission. Retries with the same key return the
84
- # original batch.
83
+ # Unique key per submission. Retrying with the same key and body returns the
84
+ # original batch; a different body returns `409`.
85
85
  idempotency_key: nil,
86
86
  request_options: {}
87
87
  )
@@ -142,7 +142,7 @@ module ContextDev
142
142
  sig { returns(Symbol) }
143
143
  attr_accessor :mode
144
144
 
145
- # Scrape up to 25K URLs in one batch.
145
+ # Scrape a list of up to 25,000 URLs.
146
146
  sig do
147
147
  params(
148
148
  data:
@@ -336,8 +336,7 @@ module ContextDev
336
336
  )
337
337
  end
338
338
 
339
- # Fetch the target page through a residential proxy in this country (ISO 3166-1
340
- # alpha-2).
339
+ # Fetch from this country (ISO 3166-1 alpha-2).
341
340
  sig do
342
341
  returns(
343
342
  T.nilable(
@@ -360,8 +359,7 @@ module ContextDev
360
359
  sig { returns(T.nilable(T::Array[String])) }
361
360
  attr_accessor :exclude_selectors
362
361
 
363
- # Also include each page's HTML in its result record, as an `html` field alongside
364
- # the Markdown.
362
+ # Also return each page's HTML in `html`.
365
363
  sig { returns(T.nilable(T::Boolean)) }
366
364
  attr_reader :include_html
367
365
 
@@ -382,14 +380,13 @@ module ContextDev
382
380
  sig { params(include_links: T::Boolean).void }
383
381
  attr_writer :include_links
384
382
 
385
- # Keep only the subtrees matching these CSS selectors. Filtered pages are always
386
- # fetched fresh, ignoring `maxAgeMs`.
383
+ # Keep only elements matching these CSS selectors. Filtered pages ignore
384
+ # `maxAgeMs`.
387
385
  sig { returns(T.nilable(T::Array[String])) }
388
386
  attr_accessor :include_selectors
389
387
 
390
- # Return a cached result if a prior scrape for the same parameters exists and is
391
- # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
392
- # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
388
+ # Maximum cache age in milliseconds. Defaults to 3 days (259200000 ms). Maximum: 1
389
+ # year (31536000000 ms). `0` fetches fresh.
393
390
  sig { returns(T.nilable(Integer)) }
394
391
  attr_accessor :max_age_ms
395
392
 
@@ -412,8 +409,7 @@ module ContextDev
412
409
  end
413
410
  attr_writer :pdf
414
411
 
415
- # Wait briefly for CSS and transition animations to settle before extraction, on
416
- # pages that render in a browser.
412
+ # Wait for CSS animations to finish before extracting, on browser-rendered pages.
417
413
  sig { returns(T.nilable(T::Boolean)) }
418
414
  attr_reader :settle_animations
419
415
 
@@ -461,31 +457,27 @@ module ContextDev
461
457
  ).returns(T.attached_class)
462
458
  end
463
459
  def self.new(
464
- # Fetch the target page through a residential proxy in this country (ISO 3166-1
465
- # alpha-2).
460
+ # Fetch from this country (ISO 3166-1 alpha-2).
466
461
  country: nil,
467
462
  # Remove elements matching these CSS selectors. Applied after `includeSelectors`,
468
463
  # so an element matching both is removed.
469
464
  exclude_selectors: nil,
470
- # Also include each page's HTML in its result record, as an `html` field alongside
471
- # the Markdown.
465
+ # Also return each page's HTML in `html`.
472
466
  include_html: nil,
473
467
  # Include image references in the Markdown.
474
468
  include_images: nil,
475
469
  # Include links in the Markdown.
476
470
  include_links: nil,
477
- # Keep only the subtrees matching these CSS selectors. Filtered pages are always
478
- # fetched fresh, ignoring `maxAgeMs`.
471
+ # Keep only elements matching these CSS selectors. Filtered pages ignore
472
+ # `maxAgeMs`.
479
473
  include_selectors: nil,
480
- # Return a cached result if a prior scrape for the same parameters exists and is
481
- # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
482
- # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
474
+ # Maximum cache age in milliseconds. Defaults to 3 days (259200000 ms). Maximum: 1
475
+ # year (31536000000 ms). `0` fetches fresh.
483
476
  max_age_ms: nil,
484
477
  # PDF parsing controls. Use start/end to limit text extraction and embedded-image
485
478
  # detection/OCR to an inclusive 1-based page range.
486
479
  pdf: nil,
487
- # Wait briefly for CSS and transition animations to settle before extraction, on
488
- # pages that render in a browser.
480
+ # Wait for CSS animations to finish before extracting, on browser-rendered pages.
489
481
  settle_animations: nil,
490
482
  # Shorten inline base64 image data.
491
483
  shorten_base64_images: nil,
@@ -519,8 +511,7 @@ module ContextDev
519
511
  def to_hash
520
512
  end
521
513
 
522
- # Fetch the target page through a residential proxy in this country (ISO 3166-1
523
- # alpha-2).
514
+ # Fetch from this country (ISO 3166-1 alpha-2).
524
515
  module Country
525
516
  extend ContextDev::Internal::Type::Enum
526
517
 
@@ -1582,18 +1573,14 @@ module ContextDev
1582
1573
  sig { params(end_: Integer).void }
1583
1574
  attr_writer :end_
1584
1575
 
1585
- # When true, OCR the selected PDF pages that have no usable text layer (scans),
1586
- # replacing each recovered page's text with the OCR result while pages with a real
1587
- # text layer keep it. Billed at 1 credit per page OCR actually recovered, on top
1588
- # of the base request cost. When false, no OCR runs.
1576
+ # Read scanned PDF pages with OCR; preserve pages that already have text.
1589
1577
  sig { returns(T.nilable(T::Boolean)) }
1590
1578
  attr_reader :ocr
1591
1579
 
1592
1580
  sig { params(ocr: T::Boolean).void }
1593
1581
  attr_writer :ocr
1594
1582
 
1595
- # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and
1596
- # a 400 PDF_SKIPPED is returned.
1583
+ # Parse PDF URLs. When false, PDFs fail with `PDF_SKIPPED`.
1597
1584
  sig { returns(T.nilable(T::Boolean)) }
1598
1585
  attr_reader :should_parse
1599
1586
 
@@ -1621,13 +1608,9 @@ module ContextDev
1621
1608
  # Last 1-based PDF page to parse. When omitted, parsing ends at the last page.
1622
1609
  # Must be greater than or equal to start when both are provided.
1623
1610
  end_: nil,
1624
- # When true, OCR the selected PDF pages that have no usable text layer (scans),
1625
- # replacing each recovered page's text with the OCR result while pages with a real
1626
- # text layer keep it. Billed at 1 credit per page OCR actually recovered, on top
1627
- # of the base request cost. When false, no OCR runs.
1611
+ # Read scanned PDF pages with OCR; preserve pages that already have text.
1628
1612
  ocr: nil,
1629
- # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and
1630
- # a 400 PDF_SKIPPED is returned.
1613
+ # Parse PDF URLs. When false, PDFs fail with `PDF_SKIPPED`.
1631
1614
  should_parse: nil,
1632
1615
  # First 1-based PDF page to parse. When omitted, parsing starts at the first page.
1633
1616
  start: nil
@@ -1798,8 +1781,7 @@ module ContextDev
1798
1781
  )
1799
1782
  end
1800
1783
 
1801
- # Fetch the target page through a residential proxy in this country (ISO 3166-1
1802
- # alpha-2).
1784
+ # Fetch from this country (ISO 3166-1 alpha-2).
1803
1785
  sig do
1804
1786
  returns(
1805
1787
  T.nilable(
@@ -1822,14 +1804,13 @@ module ContextDev
1822
1804
  sig { returns(T.nilable(T::Array[String])) }
1823
1805
  attr_accessor :exclude_selectors
1824
1806
 
1825
- # Keep only the subtrees matching these CSS selectors. Filtered pages are always
1826
- # fetched fresh, ignoring `maxAgeMs`.
1807
+ # Keep only elements matching these CSS selectors. Filtered pages ignore
1808
+ # `maxAgeMs`.
1827
1809
  sig { returns(T.nilable(T::Array[String])) }
1828
1810
  attr_accessor :include_selectors
1829
1811
 
1830
- # Return a cached result if a prior scrape for the same parameters exists and is
1831
- # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
1832
- # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
1812
+ # Maximum cache age in milliseconds. Defaults to 3 days (259200000 ms). Maximum: 1
1813
+ # year (31536000000 ms). `0` fetches fresh.
1833
1814
  sig { returns(T.nilable(Integer)) }
1834
1815
  attr_accessor :max_age_ms
1835
1816
 
@@ -1852,8 +1833,7 @@ module ContextDev
1852
1833
  end
1853
1834
  attr_writer :pdf
1854
1835
 
1855
- # Wait briefly for CSS and transition animations to settle before extraction, on
1856
- # pages that render in a browser.
1836
+ # Wait for CSS animations to finish before extracting, on browser-rendered pages.
1857
1837
  sig { returns(T.nilable(T::Boolean)) }
1858
1838
  attr_reader :settle_animations
1859
1839
 
@@ -1890,24 +1870,21 @@ module ContextDev
1890
1870
  ).returns(T.attached_class)
1891
1871
  end
1892
1872
  def self.new(
1893
- # Fetch the target page through a residential proxy in this country (ISO 3166-1
1894
- # alpha-2).
1873
+ # Fetch from this country (ISO 3166-1 alpha-2).
1895
1874
  country: nil,
1896
1875
  # Remove elements matching these CSS selectors. Applied after `includeSelectors`,
1897
1876
  # so an element matching both is removed.
1898
1877
  exclude_selectors: nil,
1899
- # Keep only the subtrees matching these CSS selectors. Filtered pages are always
1900
- # fetched fresh, ignoring `maxAgeMs`.
1878
+ # Keep only elements matching these CSS selectors. Filtered pages ignore
1879
+ # `maxAgeMs`.
1901
1880
  include_selectors: nil,
1902
- # Return a cached result if a prior scrape for the same parameters exists and is
1903
- # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
1904
- # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
1881
+ # Maximum cache age in milliseconds. Defaults to 3 days (259200000 ms). Maximum: 1
1882
+ # year (31536000000 ms). `0` fetches fresh.
1905
1883
  max_age_ms: nil,
1906
1884
  # PDF parsing controls. Use start/end to limit text extraction and embedded-image
1907
1885
  # detection/OCR to an inclusive 1-based page range.
1908
1886
  pdf: nil,
1909
- # Wait briefly for CSS and transition animations to settle before extraction, on
1910
- # pages that render in a browser.
1887
+ # Wait for CSS animations to finish before extracting, on browser-rendered pages.
1911
1888
  settle_animations: nil,
1912
1889
  # Return the main content without navigation or footers.
1913
1890
  use_main_content_only: nil,
@@ -1935,8 +1912,7 @@ module ContextDev
1935
1912
  def to_hash
1936
1913
  end
1937
1914
 
1938
- # Fetch the target page through a residential proxy in this country (ISO 3166-1
1939
- # alpha-2).
1915
+ # Fetch from this country (ISO 3166-1 alpha-2).
1940
1916
  module Country
1941
1917
  extend ContextDev::Internal::Type::Enum
1942
1918
 
@@ -2998,18 +2974,14 @@ module ContextDev
2998
2974
  sig { params(end_: Integer).void }
2999
2975
  attr_writer :end_
3000
2976
 
3001
- # When true, OCR the selected PDF pages that have no usable text layer (scans),
3002
- # replacing each recovered page's text with the OCR result while pages with a real
3003
- # text layer keep it. Billed at 1 credit per page OCR actually recovered, on top
3004
- # of the base request cost. When false, no OCR runs.
2977
+ # Read scanned PDF pages with OCR; preserve pages that already have text.
3005
2978
  sig { returns(T.nilable(T::Boolean)) }
3006
2979
  attr_reader :ocr
3007
2980
 
3008
2981
  sig { params(ocr: T::Boolean).void }
3009
2982
  attr_writer :ocr
3010
2983
 
3011
- # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and
3012
- # a 400 PDF_SKIPPED is returned.
2984
+ # Parse PDF URLs. When false, PDFs fail with `PDF_SKIPPED`.
3013
2985
  sig { returns(T.nilable(T::Boolean)) }
3014
2986
  attr_reader :should_parse
3015
2987
 
@@ -3037,13 +3009,9 @@ module ContextDev
3037
3009
  # Last 1-based PDF page to parse. When omitted, parsing ends at the last page.
3038
3010
  # Must be greater than or equal to start when both are provided.
3039
3011
  end_: nil,
3040
- # When true, OCR the selected PDF pages that have no usable text layer (scans),
3041
- # replacing each recovered page's text with the OCR result while pages with a real
3042
- # text layer keep it. Billed at 1 credit per page OCR actually recovered, on top
3043
- # of the base request cost. When false, no OCR runs.
3012
+ # Read scanned PDF pages with OCR; preserve pages that already have text.
3044
3013
  ocr: nil,
3045
- # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and
3046
- # a 400 PDF_SKIPPED is returned.
3014
+ # Parse PDF URLs. When false, PDFs fail with `PDF_SKIPPED`.
3047
3015
  should_parse: nil,
3048
3016
  # First 1-based PDF page to parse. When omitted, parsing starts at the first page.
3049
3017
  start: nil
@@ -3520,8 +3488,7 @@ module ContextDev
3520
3488
  )
3521
3489
  end
3522
3490
 
3523
- # Fetch the target page through a residential proxy in this country (ISO 3166-1
3524
- # alpha-2).
3491
+ # Fetch from this country (ISO 3166-1 alpha-2).
3525
3492
  sig do
3526
3493
  returns(
3527
3494
  T.nilable(
@@ -3544,8 +3511,7 @@ module ContextDev
3544
3511
  sig { returns(T.nilable(T::Array[String])) }
3545
3512
  attr_accessor :exclude_selectors
3546
3513
 
3547
- # Also include each page's HTML in its result record, as an `html` field alongside
3548
- # the Markdown.
3514
+ # Also return each page's HTML in `html`.
3549
3515
  sig { returns(T.nilable(T::Boolean)) }
3550
3516
  attr_reader :include_html
3551
3517
 
@@ -3566,14 +3532,13 @@ module ContextDev
3566
3532
  sig { params(include_links: T::Boolean).void }
3567
3533
  attr_writer :include_links
3568
3534
 
3569
- # Keep only the subtrees matching these CSS selectors. Filtered pages are always
3570
- # fetched fresh, ignoring `maxAgeMs`.
3535
+ # Keep only elements matching these CSS selectors. Filtered pages ignore
3536
+ # `maxAgeMs`.
3571
3537
  sig { returns(T.nilable(T::Array[String])) }
3572
3538
  attr_accessor :include_selectors
3573
3539
 
3574
- # Return a cached result if a prior scrape for the same parameters exists and is
3575
- # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
3576
- # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
3540
+ # Maximum cache age in milliseconds. Defaults to 3 days (259200000 ms). Maximum: 1
3541
+ # year (31536000000 ms). `0` fetches fresh.
3577
3542
  sig { returns(T.nilable(Integer)) }
3578
3543
  attr_accessor :max_age_ms
3579
3544
 
@@ -3596,8 +3561,7 @@ module ContextDev
3596
3561
  end
3597
3562
  attr_writer :pdf
3598
3563
 
3599
- # Wait briefly for CSS and transition animations to settle before extraction, on
3600
- # pages that render in a browser.
3564
+ # Wait for CSS animations to finish before extracting, on browser-rendered pages.
3601
3565
  sig { returns(T.nilable(T::Boolean)) }
3602
3566
  attr_reader :settle_animations
3603
3567
 
@@ -3645,31 +3609,27 @@ module ContextDev
3645
3609
  ).returns(T.attached_class)
3646
3610
  end
3647
3611
  def self.new(
3648
- # Fetch the target page through a residential proxy in this country (ISO 3166-1
3649
- # alpha-2).
3612
+ # Fetch from this country (ISO 3166-1 alpha-2).
3650
3613
  country: nil,
3651
3614
  # Remove elements matching these CSS selectors. Applied after `includeSelectors`,
3652
3615
  # so an element matching both is removed.
3653
3616
  exclude_selectors: nil,
3654
- # Also include each page's HTML in its result record, as an `html` field alongside
3655
- # the Markdown.
3617
+ # Also return each page's HTML in `html`.
3656
3618
  include_html: nil,
3657
3619
  # Include image references in the Markdown.
3658
3620
  include_images: nil,
3659
3621
  # Include links in the Markdown.
3660
3622
  include_links: nil,
3661
- # Keep only the subtrees matching these CSS selectors. Filtered pages are always
3662
- # fetched fresh, ignoring `maxAgeMs`.
3623
+ # Keep only elements matching these CSS selectors. Filtered pages ignore
3624
+ # `maxAgeMs`.
3663
3625
  include_selectors: nil,
3664
- # Return a cached result if a prior scrape for the same parameters exists and is
3665
- # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
3666
- # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
3626
+ # Maximum cache age in milliseconds. Defaults to 3 days (259200000 ms). Maximum: 1
3627
+ # year (31536000000 ms). `0` fetches fresh.
3667
3628
  max_age_ms: nil,
3668
3629
  # PDF parsing controls. Use start/end to limit text extraction and embedded-image
3669
3630
  # detection/OCR to an inclusive 1-based page range.
3670
3631
  pdf: nil,
3671
- # Wait briefly for CSS and transition animations to settle before extraction, on
3672
- # pages that render in a browser.
3632
+ # Wait for CSS animations to finish before extracting, on browser-rendered pages.
3673
3633
  settle_animations: nil,
3674
3634
  # Shorten inline base64 image data.
3675
3635
  shorten_base64_images: nil,
@@ -3703,8 +3663,7 @@ module ContextDev
3703
3663
  def to_hash
3704
3664
  end
3705
3665
 
3706
- # Fetch the target page through a residential proxy in this country (ISO 3166-1
3707
- # alpha-2).
3666
+ # Fetch from this country (ISO 3166-1 alpha-2).
3708
3667
  module Country
3709
3668
  extend ContextDev::Internal::Type::Enum
3710
3669
 
@@ -4766,18 +4725,14 @@ module ContextDev
4766
4725
  sig { params(end_: Integer).void }
4767
4726
  attr_writer :end_
4768
4727
 
4769
- # When true, OCR the selected PDF pages that have no usable text layer (scans),
4770
- # replacing each recovered page's text with the OCR result while pages with a real
4771
- # text layer keep it. Billed at 1 credit per page OCR actually recovered, on top
4772
- # of the base request cost. When false, no OCR runs.
4728
+ # Read scanned PDF pages with OCR; preserve pages that already have text.
4773
4729
  sig { returns(T.nilable(T::Boolean)) }
4774
4730
  attr_reader :ocr
4775
4731
 
4776
4732
  sig { params(ocr: T::Boolean).void }
4777
4733
  attr_writer :ocr
4778
4734
 
4779
- # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and
4780
- # a 400 PDF_SKIPPED is returned.
4735
+ # Parse PDF URLs. When false, PDFs fail with `PDF_SKIPPED`.
4781
4736
  sig { returns(T.nilable(T::Boolean)) }
4782
4737
  attr_reader :should_parse
4783
4738
 
@@ -4805,13 +4760,9 @@ module ContextDev
4805
4760
  # Last 1-based PDF page to parse. When omitted, parsing ends at the last page.
4806
4761
  # Must be greater than or equal to start when both are provided.
4807
4762
  end_: nil,
4808
- # When true, OCR the selected PDF pages that have no usable text layer (scans),
4809
- # replacing each recovered page's text with the OCR result while pages with a real
4810
- # text layer keep it. Billed at 1 credit per page OCR actually recovered, on top
4811
- # of the base request cost. When false, no OCR runs.
4763
+ # Read scanned PDF pages with OCR; preserve pages that already have text.
4812
4764
  ocr: nil,
4813
- # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and
4814
- # a 400 PDF_SKIPPED is returned.
4765
+ # Parse PDF URLs. When false, PDFs fail with `PDF_SKIPPED`.
4815
4766
  should_parse: nil,
4816
4767
  # First 1-based PDF page to parse. When omitted, parsing starts at the first page.
4817
4768
  start: nil
@@ -5206,8 +5157,7 @@ module ContextDev
5206
5157
  )
5207
5158
  end
5208
5159
 
5209
- # Fetch the target page through a residential proxy in this country (ISO 3166-1
5210
- # alpha-2).
5160
+ # Fetch from this country (ISO 3166-1 alpha-2).
5211
5161
  sig do
5212
5162
  returns(
5213
5163
  T.nilable(
@@ -5230,14 +5180,13 @@ module ContextDev
5230
5180
  sig { returns(T.nilable(T::Array[String])) }
5231
5181
  attr_accessor :exclude_selectors
5232
5182
 
5233
- # Keep only the subtrees matching these CSS selectors. Filtered pages are always
5234
- # fetched fresh, ignoring `maxAgeMs`.
5183
+ # Keep only elements matching these CSS selectors. Filtered pages ignore
5184
+ # `maxAgeMs`.
5235
5185
  sig { returns(T.nilable(T::Array[String])) }
5236
5186
  attr_accessor :include_selectors
5237
5187
 
5238
- # Return a cached result if a prior scrape for the same parameters exists and is
5239
- # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
5240
- # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
5188
+ # Maximum cache age in milliseconds. Defaults to 3 days (259200000 ms). Maximum: 1
5189
+ # year (31536000000 ms). `0` fetches fresh.
5241
5190
  sig { returns(T.nilable(Integer)) }
5242
5191
  attr_accessor :max_age_ms
5243
5192
 
@@ -5260,8 +5209,7 @@ module ContextDev
5260
5209
  end
5261
5210
  attr_writer :pdf
5262
5211
 
5263
- # Wait briefly for CSS and transition animations to settle before extraction, on
5264
- # pages that render in a browser.
5212
+ # Wait for CSS animations to finish before extracting, on browser-rendered pages.
5265
5213
  sig { returns(T.nilable(T::Boolean)) }
5266
5214
  attr_reader :settle_animations
5267
5215
 
@@ -5298,24 +5246,21 @@ module ContextDev
5298
5246
  ).returns(T.attached_class)
5299
5247
  end
5300
5248
  def self.new(
5301
- # Fetch the target page through a residential proxy in this country (ISO 3166-1
5302
- # alpha-2).
5249
+ # Fetch from this country (ISO 3166-1 alpha-2).
5303
5250
  country: nil,
5304
5251
  # Remove elements matching these CSS selectors. Applied after `includeSelectors`,
5305
5252
  # so an element matching both is removed.
5306
5253
  exclude_selectors: nil,
5307
- # Keep only the subtrees matching these CSS selectors. Filtered pages are always
5308
- # fetched fresh, ignoring `maxAgeMs`.
5254
+ # Keep only elements matching these CSS selectors. Filtered pages ignore
5255
+ # `maxAgeMs`.
5309
5256
  include_selectors: nil,
5310
- # Return a cached result if a prior scrape for the same parameters exists and is
5311
- # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
5312
- # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
5257
+ # Maximum cache age in milliseconds. Defaults to 3 days (259200000 ms). Maximum: 1
5258
+ # year (31536000000 ms). `0` fetches fresh.
5313
5259
  max_age_ms: nil,
5314
5260
  # PDF parsing controls. Use start/end to limit text extraction and embedded-image
5315
5261
  # detection/OCR to an inclusive 1-based page range.
5316
5262
  pdf: nil,
5317
- # Wait briefly for CSS and transition animations to settle before extraction, on
5318
- # pages that render in a browser.
5263
+ # Wait for CSS animations to finish before extracting, on browser-rendered pages.
5319
5264
  settle_animations: nil,
5320
5265
  # Return the main content without navigation or footers.
5321
5266
  use_main_content_only: nil,
@@ -5343,8 +5288,7 @@ module ContextDev
5343
5288
  def to_hash
5344
5289
  end
5345
5290
 
5346
- # Fetch the target page through a residential proxy in this country (ISO 3166-1
5347
- # alpha-2).
5291
+ # Fetch from this country (ISO 3166-1 alpha-2).
5348
5292
  module Country
5349
5293
  extend ContextDev::Internal::Type::Enum
5350
5294
 
@@ -6406,18 +6350,14 @@ module ContextDev
6406
6350
  sig { params(end_: Integer).void }
6407
6351
  attr_writer :end_
6408
6352
 
6409
- # When true, OCR the selected PDF pages that have no usable text layer (scans),
6410
- # replacing each recovered page's text with the OCR result while pages with a real
6411
- # text layer keep it. Billed at 1 credit per page OCR actually recovered, on top
6412
- # of the base request cost. When false, no OCR runs.
6353
+ # Read scanned PDF pages with OCR; preserve pages that already have text.
6413
6354
  sig { returns(T.nilable(T::Boolean)) }
6414
6355
  attr_reader :ocr
6415
6356
 
6416
6357
  sig { params(ocr: T::Boolean).void }
6417
6358
  attr_writer :ocr
6418
6359
 
6419
- # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and
6420
- # a 400 PDF_SKIPPED is returned.
6360
+ # Parse PDF URLs. When false, PDFs fail with `PDF_SKIPPED`.
6421
6361
  sig { returns(T.nilable(T::Boolean)) }
6422
6362
  attr_reader :should_parse
6423
6363
 
@@ -6445,13 +6385,9 @@ module ContextDev
6445
6385
  # Last 1-based PDF page to parse. When omitted, parsing ends at the last page.
6446
6386
  # Must be greater than or equal to start when both are provided.
6447
6387
  end_: nil,
6448
- # When true, OCR the selected PDF pages that have no usable text layer (scans),
6449
- # replacing each recovered page's text with the OCR result while pages with a real
6450
- # text layer keep it. Billed at 1 credit per page OCR actually recovered, on top
6451
- # of the base request cost. When false, no OCR runs.
6388
+ # Read scanned PDF pages with OCR; preserve pages that already have text.
6452
6389
  ocr: nil,
6453
- # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and
6454
- # a 400 PDF_SKIPPED is returned.
6390
+ # Parse PDF URLs. When false, PDFs fail with `PDF_SKIPPED`.
6455
6391
  should_parse: nil,
6456
6392
  # First 1-based PDF page to parse. When omitted, parsing starts at the first page.
6457
6393
  start: nil
@@ -6504,6 +6440,8 @@ module ContextDev
6504
6440
  )
6505
6441
  end
6506
6442
 
6443
+ # Public HTTP(S) URL that receives batch completion, failure, or cancellation
6444
+ # events.
6507
6445
  sig { returns(String) }
6508
6446
  attr_accessor :url
6509
6447
 
@@ -6514,14 +6452,16 @@ module ContextDev
6514
6452
  sig { params(retry_: ContextDev::RetryConfig::OrHash).void }
6515
6453
  attr_writer :retry_
6516
6454
 
6517
- # Completion webhook settings. Cannot be combined with webhookUrl. Omitting retry
6518
- # preserves legacy delivery; retry: {} opts into durable retries.
6455
+ # Where to send the batch's final-status event. Omit `retry` for one attempt; `{}`
6456
+ # uses the default retry schedule.
6519
6457
  sig do
6520
6458
  params(url: String, retry_: ContextDev::RetryConfig::OrHash).returns(
6521
6459
  T.attached_class
6522
6460
  )
6523
6461
  end
6524
6462
  def self.new(
6463
+ # Public HTTP(S) URL that receives batch completion, failure, or cancellation
6464
+ # events.
6525
6465
  url:,
6526
6466
  # Webhook retry settings. Use {} for the default schedule.
6527
6467
  retry_: nil