context.dev 2.5.0 → 2.7.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +23 -0
- data/README.md +1 -1
- data/lib/context_dev/client.rb +4 -0
- data/lib/context_dev/models/batch_cancel_params.rb +22 -0
- data/lib/context_dev/models/batch_cancel_response.rb +241 -0
- data/lib/context_dev/models/batch_get_results_params.rb +42 -0
- data/lib/context_dev/models/batch_get_results_response.rb +463 -0
- data/lib/context_dev/models/batch_list_params.rb +94 -0
- data/lib/context_dev/models/batch_list_response.rb +379 -0
- data/lib/context_dev/models/batch_retrieve_params.rb +22 -0
- data/lib/context_dev/models/batch_retrieve_response.rb +373 -0
- data/lib/context_dev/models/batch_submit_params.rb +56 -0
- data/lib/context_dev/models/batch_submit_response.rb +614 -0
- data/lib/context_dev/models/crawl_controls.rb +126 -0
- data/lib/context_dev/models/failure.rb +27 -0
- data/lib/context_dev/models/intake.rb +62 -0
- data/lib/context_dev/models/monitor_create_params.rb +141 -127
- data/lib/context_dev/models/monitor_create_response.rb +34 -10
- data/lib/context_dev/models/monitor_list_response.rb +21 -7
- data/lib/context_dev/models/monitor_retrieve_response.rb +21 -7
- data/lib/context_dev/models/monitor_update_params.rb +21 -7
- data/lib/context_dev/models/monitor_update_response.rb +21 -7
- data/lib/context_dev/models/page_error_count.rb +26 -0
- data/lib/context_dev/models/web_screenshot_params.rb +5 -7
- data/lib/context_dev/models/web_web_crawl_md_params.rb +5 -7
- data/lib/context_dev/models/web_web_scrape_html_params.rb +5 -7
- data/lib/context_dev/models/web_web_scrape_html_response.rb +93 -1
- data/lib/context_dev/models/web_web_scrape_md_params.rb +5 -7
- data/lib/context_dev/models/web_web_scrape_md_response.rb +93 -1
- data/lib/context_dev/models.rb +18 -0
- data/lib/context_dev/resources/batch.rb +152 -0
- data/lib/context_dev/resources/monitors.rb +5 -5
- data/lib/context_dev/resources/web.rb +4 -4
- data/lib/context_dev/version.rb +1 -1
- data/lib/context_dev.rb +15 -0
- data/rbi/context_dev/client.rbi +3 -0
- data/rbi/context_dev/models/batch_cancel_params.rbi +40 -0
- data/rbi/context_dev/models/batch_cancel_response.rbi +424 -0
- data/rbi/context_dev/models/batch_get_results_params.rbi +70 -0
- data/rbi/context_dev/models/batch_get_results_response.rbi +848 -0
- data/rbi/context_dev/models/batch_list_params.rbi +166 -0
- data/rbi/context_dev/models/batch_list_response.rbi +713 -0
- data/rbi/context_dev/models/batch_retrieve_params.rbi +40 -0
- data/rbi/context_dev/models/batch_retrieve_response.rbi +672 -0
- data/rbi/context_dev/models/batch_submit_params.rbi +105 -0
- data/rbi/context_dev/models/batch_submit_response.rbi +1330 -0
- data/rbi/context_dev/models/crawl_controls.rbi +252 -0
- data/rbi/context_dev/models/failure.rbi +35 -0
- data/rbi/context_dev/models/intake.rbi +88 -0
- data/rbi/context_dev/models/monitor_create_params.rbi +274 -242
- data/rbi/context_dev/models/monitor_create_response.rbi +38 -7
- data/rbi/context_dev/models/monitor_list_response.rbi +24 -5
- data/rbi/context_dev/models/monitor_retrieve_response.rbi +24 -5
- data/rbi/context_dev/models/monitor_update_params.rbi +24 -5
- data/rbi/context_dev/models/monitor_update_response.rbi +24 -5
- data/rbi/context_dev/models/page_error_count.rbi +34 -0
- data/rbi/context_dev/models/web_screenshot_params.rbi +6 -9
- data/rbi/context_dev/models/web_web_crawl_md_params.rbi +6 -9
- data/rbi/context_dev/models/web_web_scrape_html_params.rbi +6 -9
- data/rbi/context_dev/models/web_web_scrape_html_response.rbi +182 -0
- data/rbi/context_dev/models/web_web_scrape_md_params.rbi +6 -9
- data/rbi/context_dev/models/web_web_scrape_md_response.rbi +180 -0
- data/rbi/context_dev/models.rbi +18 -0
- data/rbi/context_dev/resources/batch.rbi +117 -0
- data/rbi/context_dev/resources/monitors.rbi +12 -12
- data/rbi/context_dev/resources/web.rbi +8 -12
- data/sig/context_dev/client.rbs +2 -0
- data/sig/context_dev/models/batch_cancel_params.rbs +23 -0
- data/sig/context_dev/models/batch_cancel_response.rbs +174 -0
- data/sig/context_dev/models/batch_get_results_params.rbs +36 -0
- data/sig/context_dev/models/batch_get_results_response.rbs +399 -0
- data/sig/context_dev/models/batch_list_params.rbs +94 -0
- data/sig/context_dev/models/batch_list_response.rbs +283 -0
- data/sig/context_dev/models/batch_retrieve_params.rbs +23 -0
- data/sig/context_dev/models/batch_retrieve_response.rbs +262 -0
- data/sig/context_dev/models/batch_submit_params.rbs +52 -0
- data/sig/context_dev/models/batch_submit_response.rbs +542 -0
- data/sig/context_dev/models/crawl_controls.rbs +114 -0
- data/sig/context_dev/models/failure.rbs +15 -0
- data/sig/context_dev/models/intake.rbs +40 -0
- data/sig/context_dev/models/monitor_create_params.rbs +117 -97
- data/sig/context_dev/models/monitor_create_response.rbs +18 -1
- data/sig/context_dev/models/monitor_list_response.rbs +13 -1
- data/sig/context_dev/models/monitor_retrieve_response.rbs +13 -1
- data/sig/context_dev/models/monitor_update_params.rbs +13 -1
- data/sig/context_dev/models/monitor_update_response.rbs +13 -1
- data/sig/context_dev/models/page_error_count.rbs +15 -0
- data/sig/context_dev/models/web_web_scrape_html_response.rbs +85 -0
- data/sig/context_dev/models/web_web_scrape_md_response.rbs +85 -0
- data/sig/context_dev/models.rbs +18 -0
- data/sig/context_dev/resources/batch.rbs +41 -0
- data/sig/context_dev/resources/monitors.rbs +2 -2
- metadata +47 -2
|
@@ -187,7 +187,7 @@ module ContextDev
|
|
|
187
187
|
# Detect exact changes. For page targets, this means visible text diffs. For sitemap targets, this means URL additions and removals.
|
|
188
188
|
variant :exact, -> { ContextDev::Models::MonitorListResponse::Data::ChangeDetection::Exact }
|
|
189
189
|
|
|
190
|
-
# Detect meaning-level changes to
|
|
190
|
+
# Detect meaning-level changes to page content, ignoring cosmetic or instruction-irrelevant differences. Which changes are meaningful is judged against the page or extract target's `instructions` (and an extract target's `schema`, when provided).
|
|
191
191
|
variant :semantic, -> { ContextDev::Models::MonitorListResponse::Data::ChangeDetection::Semantic }
|
|
192
192
|
|
|
193
193
|
class Exact < ContextDev::Internal::Type::BaseModel
|
|
@@ -215,9 +215,10 @@ module ContextDev
|
|
|
215
215
|
optional :confidence_threshold, Float
|
|
216
216
|
|
|
217
217
|
# @!method initialize(confidence_threshold: nil, type: :semantic)
|
|
218
|
-
# Detect meaning-level changes to
|
|
219
|
-
#
|
|
220
|
-
# extract target's `instructions` (and
|
|
218
|
+
# Detect meaning-level changes to page content, ignoring cosmetic or
|
|
219
|
+
# instruction-irrelevant differences. Which changes are meaningful is judged
|
|
220
|
+
# against the page or extract target's `instructions` (and an extract target's
|
|
221
|
+
# `schema`, when provided).
|
|
221
222
|
#
|
|
222
223
|
# @param confidence_threshold [Float]
|
|
223
224
|
# @param type [Symbol, :semantic]
|
|
@@ -323,7 +324,7 @@ module ContextDev
|
|
|
323
324
|
|
|
324
325
|
discriminator :type
|
|
325
326
|
|
|
326
|
-
# Watch a single web page.
|
|
327
|
+
# Watch a single web page. Exact detection reports visible-text diffs; semantic detection judges confirmed stable diffs against `instructions`.
|
|
327
328
|
variant :page, -> { ContextDev::Models::MonitorListResponse::Data::Target::Page }
|
|
328
329
|
|
|
329
330
|
# Watch a sitemap for URL additions and removals. Crawled URLs are normalized (lowercased host, no trailing slash/fragment) and scoped to the monitored site and its subdomains before comparison. On a detected difference the sitemap is re-fetched within the same run and only URLs both observations agree on are reported, suppressing transient crawl flaps.
|
|
@@ -343,17 +344,30 @@ module ContextDev
|
|
|
343
344
|
# @return [String]
|
|
344
345
|
required :url, String
|
|
345
346
|
|
|
347
|
+
# @!attribute instructions
|
|
348
|
+
# Plain-language goal describing which page changes matter. When provided without
|
|
349
|
+
# change_detection, semantic detection is inferred.
|
|
350
|
+
#
|
|
351
|
+
# @return [String, nil]
|
|
352
|
+
optional :instructions, String
|
|
353
|
+
|
|
346
354
|
# @!attribute normalize_whitespace
|
|
347
355
|
# Normalize whitespace before comparing or analyzing text.
|
|
348
356
|
#
|
|
349
357
|
# @return [Boolean, nil]
|
|
350
358
|
optional :normalize_whitespace, ContextDev::Internal::Type::Boolean
|
|
351
359
|
|
|
352
|
-
# @!method initialize(url:, normalize_whitespace: nil, type: :page)
|
|
353
|
-
#
|
|
360
|
+
# @!method initialize(url:, instructions: nil, normalize_whitespace: nil, type: :page)
|
|
361
|
+
# Some parameter documentations has been truncated, see
|
|
362
|
+
# {ContextDev::Models::MonitorListResponse::Data::Target::Page} for more details.
|
|
363
|
+
#
|
|
364
|
+
# Watch a single web page. Exact detection reports visible-text diffs; semantic
|
|
365
|
+
# detection judges confirmed stable diffs against `instructions`.
|
|
354
366
|
#
|
|
355
367
|
# @param url [String]
|
|
356
368
|
#
|
|
369
|
+
# @param instructions [String] Plain-language goal describing which page changes matter. When provided without
|
|
370
|
+
#
|
|
357
371
|
# @param normalize_whitespace [Boolean] Normalize whitespace before comparing or analyzing text.
|
|
358
372
|
#
|
|
359
373
|
# @param type [Symbol, :page]
|
|
@@ -164,7 +164,7 @@ module ContextDev
|
|
|
164
164
|
# Detect exact changes. For page targets, this means visible text diffs. For sitemap targets, this means URL additions and removals.
|
|
165
165
|
variant :exact, -> { ContextDev::Models::MonitorRetrieveResponse::ChangeDetection::Exact }
|
|
166
166
|
|
|
167
|
-
# Detect meaning-level changes to
|
|
167
|
+
# Detect meaning-level changes to page content, ignoring cosmetic or instruction-irrelevant differences. Which changes are meaningful is judged against the page or extract target's `instructions` (and an extract target's `schema`, when provided).
|
|
168
168
|
variant :semantic, -> { ContextDev::Models::MonitorRetrieveResponse::ChangeDetection::Semantic }
|
|
169
169
|
|
|
170
170
|
class Exact < ContextDev::Internal::Type::BaseModel
|
|
@@ -192,9 +192,10 @@ module ContextDev
|
|
|
192
192
|
optional :confidence_threshold, Float
|
|
193
193
|
|
|
194
194
|
# @!method initialize(confidence_threshold: nil, type: :semantic)
|
|
195
|
-
# Detect meaning-level changes to
|
|
196
|
-
#
|
|
197
|
-
# extract target's `instructions` (and
|
|
195
|
+
# Detect meaning-level changes to page content, ignoring cosmetic or
|
|
196
|
+
# instruction-irrelevant differences. Which changes are meaningful is judged
|
|
197
|
+
# against the page or extract target's `instructions` (and an extract target's
|
|
198
|
+
# `schema`, when provided).
|
|
198
199
|
#
|
|
199
200
|
# @param confidence_threshold [Float]
|
|
200
201
|
# @param type [Symbol, :semantic]
|
|
@@ -300,7 +301,7 @@ module ContextDev
|
|
|
300
301
|
|
|
301
302
|
discriminator :type
|
|
302
303
|
|
|
303
|
-
# Watch a single web page.
|
|
304
|
+
# Watch a single web page. Exact detection reports visible-text diffs; semantic detection judges confirmed stable diffs against `instructions`.
|
|
304
305
|
variant :page, -> { ContextDev::Models::MonitorRetrieveResponse::Target::Page }
|
|
305
306
|
|
|
306
307
|
# Watch a sitemap for URL additions and removals. Crawled URLs are normalized (lowercased host, no trailing slash/fragment) and scoped to the monitored site and its subdomains before comparison. On a detected difference the sitemap is re-fetched within the same run and only URLs both observations agree on are reported, suppressing transient crawl flaps.
|
|
@@ -320,17 +321,30 @@ module ContextDev
|
|
|
320
321
|
# @return [String]
|
|
321
322
|
required :url, String
|
|
322
323
|
|
|
324
|
+
# @!attribute instructions
|
|
325
|
+
# Plain-language goal describing which page changes matter. When provided without
|
|
326
|
+
# change_detection, semantic detection is inferred.
|
|
327
|
+
#
|
|
328
|
+
# @return [String, nil]
|
|
329
|
+
optional :instructions, String
|
|
330
|
+
|
|
323
331
|
# @!attribute normalize_whitespace
|
|
324
332
|
# Normalize whitespace before comparing or analyzing text.
|
|
325
333
|
#
|
|
326
334
|
# @return [Boolean, nil]
|
|
327
335
|
optional :normalize_whitespace, ContextDev::Internal::Type::Boolean
|
|
328
336
|
|
|
329
|
-
# @!method initialize(url:, normalize_whitespace: nil, type: :page)
|
|
330
|
-
#
|
|
337
|
+
# @!method initialize(url:, instructions: nil, normalize_whitespace: nil, type: :page)
|
|
338
|
+
# Some parameter documentations has been truncated, see
|
|
339
|
+
# {ContextDev::Models::MonitorRetrieveResponse::Target::Page} for more details.
|
|
340
|
+
#
|
|
341
|
+
# Watch a single web page. Exact detection reports visible-text diffs; semantic
|
|
342
|
+
# detection judges confirmed stable diffs against `instructions`.
|
|
331
343
|
#
|
|
332
344
|
# @param url [String]
|
|
333
345
|
#
|
|
346
|
+
# @param instructions [String] Plain-language goal describing which page changes matter. When provided without
|
|
347
|
+
#
|
|
334
348
|
# @param normalize_whitespace [Boolean] Normalize whitespace before comparing or analyzing text.
|
|
335
349
|
#
|
|
336
350
|
# @param type [Symbol, :page]
|
|
@@ -86,7 +86,7 @@ module ContextDev
|
|
|
86
86
|
# Detect exact changes. For page targets, this means visible text diffs. For sitemap targets, this means URL additions and removals.
|
|
87
87
|
variant :exact, -> { ContextDev::MonitorUpdateParams::ChangeDetection::Exact }
|
|
88
88
|
|
|
89
|
-
# Detect meaning-level changes to
|
|
89
|
+
# Detect meaning-level changes to page content, ignoring cosmetic or instruction-irrelevant differences. Which changes are meaningful is judged against the page or extract target's `instructions` (and an extract target's `schema`, when provided).
|
|
90
90
|
variant :semantic, -> { ContextDev::MonitorUpdateParams::ChangeDetection::Semantic }
|
|
91
91
|
|
|
92
92
|
class Exact < ContextDev::Internal::Type::BaseModel
|
|
@@ -114,9 +114,10 @@ module ContextDev
|
|
|
114
114
|
optional :confidence_threshold, Float
|
|
115
115
|
|
|
116
116
|
# @!method initialize(confidence_threshold: nil, type: :semantic)
|
|
117
|
-
# Detect meaning-level changes to
|
|
118
|
-
#
|
|
119
|
-
# extract target's `instructions` (and
|
|
117
|
+
# Detect meaning-level changes to page content, ignoring cosmetic or
|
|
118
|
+
# instruction-irrelevant differences. Which changes are meaningful is judged
|
|
119
|
+
# against the page or extract target's `instructions` (and an extract target's
|
|
120
|
+
# `schema`, when provided).
|
|
120
121
|
#
|
|
121
122
|
# @param confidence_threshold [Float]
|
|
122
123
|
# @param type [Symbol, :semantic]
|
|
@@ -198,7 +199,7 @@ module ContextDev
|
|
|
198
199
|
|
|
199
200
|
discriminator :type
|
|
200
201
|
|
|
201
|
-
# Watch a single web page.
|
|
202
|
+
# Watch a single web page. Exact detection reports visible-text diffs; semantic detection judges confirmed stable diffs against `instructions`.
|
|
202
203
|
variant :page, -> { ContextDev::MonitorUpdateParams::Target::Page }
|
|
203
204
|
|
|
204
205
|
# Watch a sitemap for URL additions and removals. Crawled URLs are normalized (lowercased host, no trailing slash/fragment) and scoped to the monitored site and its subdomains before comparison. On a detected difference the sitemap is re-fetched within the same run and only URLs both observations agree on are reported, suppressing transient crawl flaps.
|
|
@@ -218,17 +219,30 @@ module ContextDev
|
|
|
218
219
|
# @return [String]
|
|
219
220
|
required :url, String
|
|
220
221
|
|
|
222
|
+
# @!attribute instructions
|
|
223
|
+
# Plain-language goal describing which page changes matter. When provided without
|
|
224
|
+
# change_detection, semantic detection is inferred.
|
|
225
|
+
#
|
|
226
|
+
# @return [String, nil]
|
|
227
|
+
optional :instructions, String
|
|
228
|
+
|
|
221
229
|
# @!attribute normalize_whitespace
|
|
222
230
|
# Normalize whitespace before comparing or analyzing text.
|
|
223
231
|
#
|
|
224
232
|
# @return [Boolean, nil]
|
|
225
233
|
optional :normalize_whitespace, ContextDev::Internal::Type::Boolean
|
|
226
234
|
|
|
227
|
-
# @!method initialize(url:, normalize_whitespace: nil, type: :page)
|
|
228
|
-
#
|
|
235
|
+
# @!method initialize(url:, instructions: nil, normalize_whitespace: nil, type: :page)
|
|
236
|
+
# Some parameter documentations has been truncated, see
|
|
237
|
+
# {ContextDev::Models::MonitorUpdateParams::Target::Page} for more details.
|
|
238
|
+
#
|
|
239
|
+
# Watch a single web page. Exact detection reports visible-text diffs; semantic
|
|
240
|
+
# detection judges confirmed stable diffs against `instructions`.
|
|
229
241
|
#
|
|
230
242
|
# @param url [String]
|
|
231
243
|
#
|
|
244
|
+
# @param instructions [String] Plain-language goal describing which page changes matter. When provided without
|
|
245
|
+
#
|
|
232
246
|
# @param normalize_whitespace [Boolean] Normalize whitespace before comparing or analyzing text.
|
|
233
247
|
#
|
|
234
248
|
# @param type [Symbol, :page]
|
|
@@ -164,7 +164,7 @@ module ContextDev
|
|
|
164
164
|
# Detect exact changes. For page targets, this means visible text diffs. For sitemap targets, this means URL additions and removals.
|
|
165
165
|
variant :exact, -> { ContextDev::Models::MonitorUpdateResponse::ChangeDetection::Exact }
|
|
166
166
|
|
|
167
|
-
# Detect meaning-level changes to
|
|
167
|
+
# Detect meaning-level changes to page content, ignoring cosmetic or instruction-irrelevant differences. Which changes are meaningful is judged against the page or extract target's `instructions` (and an extract target's `schema`, when provided).
|
|
168
168
|
variant :semantic, -> { ContextDev::Models::MonitorUpdateResponse::ChangeDetection::Semantic }
|
|
169
169
|
|
|
170
170
|
class Exact < ContextDev::Internal::Type::BaseModel
|
|
@@ -192,9 +192,10 @@ module ContextDev
|
|
|
192
192
|
optional :confidence_threshold, Float
|
|
193
193
|
|
|
194
194
|
# @!method initialize(confidence_threshold: nil, type: :semantic)
|
|
195
|
-
# Detect meaning-level changes to
|
|
196
|
-
#
|
|
197
|
-
# extract target's `instructions` (and
|
|
195
|
+
# Detect meaning-level changes to page content, ignoring cosmetic or
|
|
196
|
+
# instruction-irrelevant differences. Which changes are meaningful is judged
|
|
197
|
+
# against the page or extract target's `instructions` (and an extract target's
|
|
198
|
+
# `schema`, when provided).
|
|
198
199
|
#
|
|
199
200
|
# @param confidence_threshold [Float]
|
|
200
201
|
# @param type [Symbol, :semantic]
|
|
@@ -300,7 +301,7 @@ module ContextDev
|
|
|
300
301
|
|
|
301
302
|
discriminator :type
|
|
302
303
|
|
|
303
|
-
# Watch a single web page.
|
|
304
|
+
# Watch a single web page. Exact detection reports visible-text diffs; semantic detection judges confirmed stable diffs against `instructions`.
|
|
304
305
|
variant :page, -> { ContextDev::Models::MonitorUpdateResponse::Target::Page }
|
|
305
306
|
|
|
306
307
|
# Watch a sitemap for URL additions and removals. Crawled URLs are normalized (lowercased host, no trailing slash/fragment) and scoped to the monitored site and its subdomains before comparison. On a detected difference the sitemap is re-fetched within the same run and only URLs both observations agree on are reported, suppressing transient crawl flaps.
|
|
@@ -320,17 +321,30 @@ module ContextDev
|
|
|
320
321
|
# @return [String]
|
|
321
322
|
required :url, String
|
|
322
323
|
|
|
324
|
+
# @!attribute instructions
|
|
325
|
+
# Plain-language goal describing which page changes matter. When provided without
|
|
326
|
+
# change_detection, semantic detection is inferred.
|
|
327
|
+
#
|
|
328
|
+
# @return [String, nil]
|
|
329
|
+
optional :instructions, String
|
|
330
|
+
|
|
323
331
|
# @!attribute normalize_whitespace
|
|
324
332
|
# Normalize whitespace before comparing or analyzing text.
|
|
325
333
|
#
|
|
326
334
|
# @return [Boolean, nil]
|
|
327
335
|
optional :normalize_whitespace, ContextDev::Internal::Type::Boolean
|
|
328
336
|
|
|
329
|
-
# @!method initialize(url:, normalize_whitespace: nil, type: :page)
|
|
330
|
-
#
|
|
337
|
+
# @!method initialize(url:, instructions: nil, normalize_whitespace: nil, type: :page)
|
|
338
|
+
# Some parameter documentations has been truncated, see
|
|
339
|
+
# {ContextDev::Models::MonitorUpdateResponse::Target::Page} for more details.
|
|
340
|
+
#
|
|
341
|
+
# Watch a single web page. Exact detection reports visible-text diffs; semantic
|
|
342
|
+
# detection judges confirmed stable diffs against `instructions`.
|
|
331
343
|
#
|
|
332
344
|
# @param url [String]
|
|
333
345
|
#
|
|
346
|
+
# @param instructions [String] Plain-language goal describing which page changes matter. When provided without
|
|
347
|
+
#
|
|
334
348
|
# @param normalize_whitespace [Boolean] Normalize whitespace before comparing or analyzing text.
|
|
335
349
|
#
|
|
336
350
|
# @param type [Symbol, :page]
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module ContextDev
|
|
4
|
+
module Models
|
|
5
|
+
class PageErrorCount < ContextDev::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute code
|
|
7
|
+
# Error code for these failures.
|
|
8
|
+
#
|
|
9
|
+
# @return [String]
|
|
10
|
+
required :code, String
|
|
11
|
+
|
|
12
|
+
# @!attribute count
|
|
13
|
+
# Pages that failed with this code.
|
|
14
|
+
#
|
|
15
|
+
# @return [Integer]
|
|
16
|
+
required :count, Integer
|
|
17
|
+
|
|
18
|
+
# @!method initialize(code:, count:)
|
|
19
|
+
# Page failures sharing one error code.
|
|
20
|
+
#
|
|
21
|
+
# @param code [String] Error code for these failures.
|
|
22
|
+
#
|
|
23
|
+
# @param count [Integer] Pages that failed with this code.
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
end
|
|
@@ -15,9 +15,8 @@ module ContextDev
|
|
|
15
15
|
optional :color_scheme, enum: -> { ContextDev::WebScreenshotParams::ColorScheme }
|
|
16
16
|
|
|
17
17
|
# @!attribute country
|
|
18
|
-
#
|
|
19
|
-
#
|
|
20
|
-
# countries. When provided, Context.dev fetches the target page from that country.
|
|
18
|
+
# Fetch the target page through a residential proxy in this country (ISO 3166-1
|
|
19
|
+
# alpha-2).
|
|
21
20
|
#
|
|
22
21
|
# @return [Symbol, ContextDev::Models::WebScreenshotParams::Country, nil]
|
|
23
22
|
optional :country, enum: -> { ContextDev::WebScreenshotParams::Country }
|
|
@@ -128,7 +127,7 @@ module ContextDev
|
|
|
128
127
|
#
|
|
129
128
|
# @param color_scheme [Symbol, ContextDev::Models::WebScreenshotParams::ColorScheme] Optional parameter to choose the site's visual theme in the screenshot. Use 'lig
|
|
130
129
|
#
|
|
131
|
-
# @param country [Symbol, ContextDev::Models::WebScreenshotParams::Country]
|
|
130
|
+
# @param country [Symbol, ContextDev::Models::WebScreenshotParams::Country] Fetch the target page through a residential proxy in this country (ISO 3166-1 al
|
|
132
131
|
#
|
|
133
132
|
# @param direct_url [String] A specific URL to screenshot directly, bypassing domain resolution (e.g., 'https
|
|
134
133
|
#
|
|
@@ -168,9 +167,8 @@ module ContextDev
|
|
|
168
167
|
# @return [Array<Symbol>]
|
|
169
168
|
end
|
|
170
169
|
|
|
171
|
-
#
|
|
172
|
-
#
|
|
173
|
-
# countries. When provided, Context.dev fetches the target page from that country.
|
|
170
|
+
# Fetch the target page through a residential proxy in this country (ISO 3166-1
|
|
171
|
+
# alpha-2).
|
|
174
172
|
module Country
|
|
175
173
|
extend ContextDev::Internal::Type::Enum
|
|
176
174
|
|
|
@@ -14,9 +14,8 @@ module ContextDev
|
|
|
14
14
|
required :url, String
|
|
15
15
|
|
|
16
16
|
# @!attribute country
|
|
17
|
-
#
|
|
18
|
-
#
|
|
19
|
-
# countries. When provided, Context.dev fetches the target page from that country.
|
|
17
|
+
# Fetch the target page through a residential proxy in this country (ISO 3166-1
|
|
18
|
+
# alpha-2).
|
|
20
19
|
#
|
|
21
20
|
# @return [Symbol, ContextDev::Models::WebWebCrawlMdParams::Country, nil]
|
|
22
21
|
optional :country, enum: -> { ContextDev::WebWebCrawlMdParams::Country }
|
|
@@ -164,7 +163,7 @@ module ContextDev
|
|
|
164
163
|
#
|
|
165
164
|
# @param url [String] The starting URL for the crawl (must include http:// or https:// protocol)
|
|
166
165
|
#
|
|
167
|
-
# @param country [Symbol, ContextDev::Models::WebWebCrawlMdParams::Country]
|
|
166
|
+
# @param country [Symbol, ContextDev::Models::WebWebCrawlMdParams::Country] Fetch the target page through a residential proxy in this country (ISO 3166-1 al
|
|
168
167
|
#
|
|
169
168
|
# @param exclude_selectors [Array<String>] CSS selectors to remove before each crawled page is converted to Markdown. Appli
|
|
170
169
|
#
|
|
@@ -206,9 +205,8 @@ module ContextDev
|
|
|
206
205
|
#
|
|
207
206
|
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
|
|
208
207
|
|
|
209
|
-
#
|
|
210
|
-
#
|
|
211
|
-
# countries. When provided, Context.dev fetches the target page from that country.
|
|
208
|
+
# Fetch the target page through a residential proxy in this country (ISO 3166-1
|
|
209
|
+
# alpha-2).
|
|
212
210
|
module Country
|
|
213
211
|
extend ContextDev::Internal::Type::Enum
|
|
214
212
|
|
|
@@ -24,9 +24,8 @@ module ContextDev
|
|
|
24
24
|
nil?: true
|
|
25
25
|
|
|
26
26
|
# @!attribute country
|
|
27
|
-
#
|
|
28
|
-
#
|
|
29
|
-
# countries. When provided, Context.dev fetches the target page from that country.
|
|
27
|
+
# Fetch the target page through a residential proxy in this country (ISO 3166-1
|
|
28
|
+
# alpha-2).
|
|
30
29
|
#
|
|
31
30
|
# @return [Symbol, ContextDev::Models::WebWebScrapeHTMLParams::Country, nil]
|
|
32
31
|
optional :country, enum: -> { ContextDev::WebWebScrapeHTMLParams::Country }
|
|
@@ -131,7 +130,7 @@ module ContextDev
|
|
|
131
130
|
#
|
|
132
131
|
# @param actions [Array<ContextDev::Models::WebWebScrapeHTMLParams::Action::Wait, ContextDev::Models::WebWebScrapeHTMLParams::Action::Perform>, nil] Optional browser actions executed in array order after the page loads and before
|
|
133
132
|
#
|
|
134
|
-
# @param country [Symbol, ContextDev::Models::WebWebScrapeHTMLParams::Country]
|
|
133
|
+
# @param country [Symbol, ContextDev::Models::WebWebScrapeHTMLParams::Country] Fetch the target page through a residential proxy in this country (ISO 3166-1 al
|
|
135
134
|
#
|
|
136
135
|
# @param exclude_selectors [Array<String>, nil] CSS selectors to remove from the result. Applied after includeSelectors. Exclusi
|
|
137
136
|
#
|
|
@@ -212,9 +211,8 @@ module ContextDev
|
|
|
212
211
|
# @return [Array(ContextDev::Models::WebWebScrapeHTMLParams::Action::Wait, ContextDev::Models::WebWebScrapeHTMLParams::Action::Perform)]
|
|
213
212
|
end
|
|
214
213
|
|
|
215
|
-
#
|
|
216
|
-
#
|
|
217
|
-
# countries. When provided, Context.dev fetches the target page from that country.
|
|
214
|
+
# Fetch the target page through a residential proxy in this country (ISO 3166-1
|
|
215
|
+
# alpha-2).
|
|
218
216
|
module Country
|
|
219
217
|
extend ContextDev::Internal::Type::Enum
|
|
220
218
|
|
|
@@ -39,6 +39,21 @@ module ContextDev
|
|
|
39
39
|
# @return [String]
|
|
40
40
|
required :url, String
|
|
41
41
|
|
|
42
|
+
# @!attribute actions_applied
|
|
43
|
+
# One verified outcome per requested browser action, in request order.
|
|
44
|
+
#
|
|
45
|
+
# @return [Array<ContextDev::Models::WebWebScrapeHTMLResponse::ActionsApplied>, nil]
|
|
46
|
+
optional :actions_applied,
|
|
47
|
+
-> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebWebScrapeHTMLResponse::ActionsApplied] },
|
|
48
|
+
api_name: :actionsApplied
|
|
49
|
+
|
|
50
|
+
# @!attribute actions_html_stale
|
|
51
|
+
# True when an action was applied but the returned content could not be refreshed
|
|
52
|
+
# afterward.
|
|
53
|
+
#
|
|
54
|
+
# @return [Boolean, nil]
|
|
55
|
+
optional :actions_html_stale, ContextDev::Internal::Type::Boolean, api_name: :actionsHtmlStale
|
|
56
|
+
|
|
42
57
|
# @!attribute key_metadata
|
|
43
58
|
# Metadata about the API key used for the request. Included in every response
|
|
44
59
|
# whenever a valid API key is provided, even when the response status is not 200.
|
|
@@ -46,7 +61,7 @@ module ContextDev
|
|
|
46
61
|
# @return [ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata, nil]
|
|
47
62
|
optional :key_metadata, -> { ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata }
|
|
48
63
|
|
|
49
|
-
# @!method initialize(html:, metadata:, success:, type:, url:, key_metadata: nil)
|
|
64
|
+
# @!method initialize(html:, metadata:, success:, type:, url:, actions_applied: nil, actions_html_stale: nil, key_metadata: nil)
|
|
50
65
|
# Some parameter documentations has been truncated, see
|
|
51
66
|
# {ContextDev::Models::WebWebScrapeHTMLResponse} for more details.
|
|
52
67
|
#
|
|
@@ -60,6 +75,10 @@ module ContextDev
|
|
|
60
75
|
#
|
|
61
76
|
# @param url [String] The URL that was scraped
|
|
62
77
|
#
|
|
78
|
+
# @param actions_applied [Array<ContextDev::Models::WebWebScrapeHTMLResponse::ActionsApplied>] One verified outcome per requested browser action, in request order.
|
|
79
|
+
#
|
|
80
|
+
# @param actions_html_stale [Boolean] True when an action was applied but the returned content could not be refreshed
|
|
81
|
+
#
|
|
63
82
|
# @param key_metadata [ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
|
|
64
83
|
|
|
65
84
|
# @see ContextDev::Models::WebWebScrapeHTMLResponse#metadata
|
|
@@ -349,6 +368,79 @@ module ContextDev
|
|
|
349
368
|
# @return [Array<Symbol>]
|
|
350
369
|
end
|
|
351
370
|
|
|
371
|
+
class ActionsApplied < ContextDev::Internal::Type::BaseModel
|
|
372
|
+
# @!attribute instruction
|
|
373
|
+
#
|
|
374
|
+
# @return [String]
|
|
375
|
+
required :instruction, String
|
|
376
|
+
|
|
377
|
+
# @!attribute status
|
|
378
|
+
# Applied means the requested page state was visibly verified. Failed means it was
|
|
379
|
+
# not verified. Skipped means it was not attempted.
|
|
380
|
+
#
|
|
381
|
+
# @return [Symbol, ContextDev::Models::WebWebScrapeHTMLResponse::ActionsApplied::Status]
|
|
382
|
+
required :status, enum: -> { ContextDev::Models::WebWebScrapeHTMLResponse::ActionsApplied::Status }
|
|
383
|
+
|
|
384
|
+
# @!attribute completion_evidence
|
|
385
|
+
# Visible page evidence used to verify an applied action.
|
|
386
|
+
#
|
|
387
|
+
# @return [String, nil]
|
|
388
|
+
optional :completion_evidence, String, api_name: :completionEvidence
|
|
389
|
+
|
|
390
|
+
# @!attribute duration_ms
|
|
391
|
+
#
|
|
392
|
+
# @return [Float, nil]
|
|
393
|
+
optional :duration_ms, Float, api_name: :durationMs
|
|
394
|
+
|
|
395
|
+
# @!attribute error
|
|
396
|
+
#
|
|
397
|
+
# @return [String, nil]
|
|
398
|
+
optional :error, String
|
|
399
|
+
|
|
400
|
+
# @!attribute method_
|
|
401
|
+
#
|
|
402
|
+
# @return [String, nil]
|
|
403
|
+
optional :method_, String, api_name: :method
|
|
404
|
+
|
|
405
|
+
# @!attribute target_description
|
|
406
|
+
#
|
|
407
|
+
# @return [String, nil]
|
|
408
|
+
optional :target_description, String, api_name: :targetDescription
|
|
409
|
+
|
|
410
|
+
# @!method initialize(instruction:, status:, completion_evidence: nil, duration_ms: nil, error: nil, method_: nil, target_description: nil)
|
|
411
|
+
# Some parameter documentations has been truncated, see
|
|
412
|
+
# {ContextDev::Models::WebWebScrapeHTMLResponse::ActionsApplied} for more details.
|
|
413
|
+
#
|
|
414
|
+
# @param instruction [String]
|
|
415
|
+
#
|
|
416
|
+
# @param status [Symbol, ContextDev::Models::WebWebScrapeHTMLResponse::ActionsApplied::Status] Applied means the requested page state was visibly verified. Failed means it was
|
|
417
|
+
#
|
|
418
|
+
# @param completion_evidence [String] Visible page evidence used to verify an applied action.
|
|
419
|
+
#
|
|
420
|
+
# @param duration_ms [Float]
|
|
421
|
+
#
|
|
422
|
+
# @param error [String]
|
|
423
|
+
#
|
|
424
|
+
# @param method_ [String]
|
|
425
|
+
#
|
|
426
|
+
# @param target_description [String]
|
|
427
|
+
|
|
428
|
+
# Applied means the requested page state was visibly verified. Failed means it was
|
|
429
|
+
# not verified. Skipped means it was not attempted.
|
|
430
|
+
#
|
|
431
|
+
# @see ContextDev::Models::WebWebScrapeHTMLResponse::ActionsApplied#status
|
|
432
|
+
module Status
|
|
433
|
+
extend ContextDev::Internal::Type::Enum
|
|
434
|
+
|
|
435
|
+
APPLIED = :applied
|
|
436
|
+
FAILED = :failed
|
|
437
|
+
SKIPPED = :skipped
|
|
438
|
+
|
|
439
|
+
# @!method self.values
|
|
440
|
+
# @return [Array<Symbol>]
|
|
441
|
+
end
|
|
442
|
+
end
|
|
443
|
+
|
|
352
444
|
# @see ContextDev::Models::WebWebScrapeHTMLResponse#key_metadata
|
|
353
445
|
class KeyMetadata < ContextDev::Internal::Type::BaseModel
|
|
354
446
|
# @!attribute credits_consumed
|
|
@@ -25,9 +25,8 @@ module ContextDev
|
|
|
25
25
|
nil?: true
|
|
26
26
|
|
|
27
27
|
# @!attribute country
|
|
28
|
-
#
|
|
29
|
-
#
|
|
30
|
-
# countries. When provided, Context.dev fetches the target page from that country.
|
|
28
|
+
# Fetch the target page through a residential proxy in this country (ISO 3166-1
|
|
29
|
+
# alpha-2).
|
|
31
30
|
#
|
|
32
31
|
# @return [Symbol, ContextDev::Models::WebWebScrapeMdParams::Country, nil]
|
|
33
32
|
optional :country, enum: -> { ContextDev::WebWebScrapeMdParams::Country }
|
|
@@ -150,7 +149,7 @@ module ContextDev
|
|
|
150
149
|
#
|
|
151
150
|
# @param actions [Array<ContextDev::Models::WebWebScrapeMdParams::Action::Wait, ContextDev::Models::WebWebScrapeMdParams::Action::Perform>, nil] Optional browser actions executed in array order after the page loads and before
|
|
152
151
|
#
|
|
153
|
-
# @param country [Symbol, ContextDev::Models::WebWebScrapeMdParams::Country]
|
|
152
|
+
# @param country [Symbol, ContextDev::Models::WebWebScrapeMdParams::Country] Fetch the target page through a residential proxy in this country (ISO 3166-1 al
|
|
154
153
|
#
|
|
155
154
|
# @param exclude_selectors [Array<String>, nil] CSS selectors to remove before conversion to Markdown. Applied after includeSele
|
|
156
155
|
#
|
|
@@ -237,9 +236,8 @@ module ContextDev
|
|
|
237
236
|
# @return [Array(ContextDev::Models::WebWebScrapeMdParams::Action::Wait, ContextDev::Models::WebWebScrapeMdParams::Action::Perform)]
|
|
238
237
|
end
|
|
239
238
|
|
|
240
|
-
#
|
|
241
|
-
#
|
|
242
|
-
# countries. When provided, Context.dev fetches the target page from that country.
|
|
239
|
+
# Fetch the target page through a residential proxy in this country (ISO 3166-1
|
|
240
|
+
# alpha-2).
|
|
243
241
|
module Country
|
|
244
242
|
extend ContextDev::Internal::Type::Enum
|
|
245
243
|
|