context.dev 1.35.0 → 2.0.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 +35 -0
- data/README.md +24 -17
- data/lib/context_dev/client.rb +7 -0
- data/lib/context_dev/models/brand_retrieve_params.rb +1036 -174
- data/lib/context_dev/models/monitor_create_params.rb +361 -0
- data/lib/context_dev/models/monitor_create_response.rb +484 -0
- data/lib/context_dev/models/monitor_delete_params.rb +20 -0
- data/lib/context_dev/models/monitor_delete_response.rb +22 -0
- data/lib/context_dev/models/monitor_list_account_changes_params.rb +93 -0
- data/lib/context_dev/models/monitor_list_account_changes_response.rb +199 -0
- data/lib/context_dev/models/monitor_list_account_runs_params.rb +55 -0
- data/lib/context_dev/models/monitor_list_account_runs_response.rb +227 -0
- data/lib/context_dev/models/monitor_list_changes_params.rb +57 -0
- data/lib/context_dev/models/monitor_list_changes_response.rb +198 -0
- data/lib/context_dev/models/monitor_list_params.rb +161 -0
- data/lib/context_dev/models/monitor_list_response.rb +507 -0
- data/lib/context_dev/models/monitor_list_runs_params.rb +62 -0
- data/lib/context_dev/models/monitor_list_runs_response.rb +227 -0
- data/lib/context_dev/models/monitor_retrieve_change_params.rb +20 -0
- data/lib/context_dev/models/monitor_retrieve_change_response.rb +271 -0
- data/lib/context_dev/models/monitor_retrieve_params.rb +20 -0
- data/lib/context_dev/models/monitor_retrieve_response.rb +484 -0
- data/lib/context_dev/models/monitor_run_params.rb +20 -0
- data/lib/context_dev/models/monitor_run_response.rb +35 -0
- data/lib/context_dev/models/monitor_update_params.rb +368 -0
- data/lib/context_dev/models/monitor_update_response.rb +484 -0
- data/lib/context_dev/models/utility_prefetch_params.rb +70 -6
- data/lib/context_dev/models/utility_prefetch_response.rb +23 -1
- data/lib/context_dev/models/web_extract_response.rb +17 -1
- data/lib/context_dev/models/web_extract_styleguide_params.rb +22 -1
- data/lib/context_dev/models/web_screenshot_params.rb +245 -1
- data/lib/context_dev/models/web_search_params.rb +270 -3
- data/lib/context_dev/models/web_web_crawl_md_params.rb +236 -1
- data/lib/context_dev/models/web_web_scrape_html_params.rb +234 -1
- data/lib/context_dev/models/web_web_scrape_html_response.rb +10 -2
- data/lib/context_dev/models/web_web_scrape_images_params.rb +12 -1
- data/lib/context_dev/models/web_web_scrape_md_params.rb +234 -1
- data/lib/context_dev/models.rb +20 -12
- data/lib/context_dev/resources/ai.rb +0 -33
- data/lib/context_dev/resources/brand.rb +7 -204
- data/lib/context_dev/resources/monitors.rb +352 -0
- data/lib/context_dev/resources/utility.rb +9 -35
- data/lib/context_dev/resources/web.rb +36 -8
- data/lib/context_dev/version.rb +1 -1
- data/lib/context_dev.rb +23 -14
- data/rbi/context_dev/client.rbi +6 -0
- data/rbi/context_dev/models/brand_retrieve_params.rbi +3792 -679
- data/rbi/context_dev/models/monitor_create_params.rbi +640 -0
- data/rbi/context_dev/models/monitor_create_response.rbi +820 -0
- data/rbi/context_dev/models/monitor_delete_params.rbi +35 -0
- data/rbi/context_dev/models/monitor_delete_response.rbi +29 -0
- data/rbi/context_dev/models/monitor_list_account_changes_params.rbi +211 -0
- data/rbi/context_dev/models/monitor_list_account_changes_response.rbi +376 -0
- data/rbi/context_dev/models/monitor_list_account_runs_params.rbi +125 -0
- data/rbi/context_dev/models/monitor_list_account_runs_response.rbi +464 -0
- data/rbi/context_dev/models/monitor_list_changes_params.rbi +91 -0
- data/rbi/context_dev/models/monitor_list_changes_response.rbi +372 -0
- data/rbi/context_dev/models/monitor_list_params.rbi +332 -0
- data/rbi/context_dev/models/monitor_list_response.rbi +885 -0
- data/rbi/context_dev/models/monitor_list_runs_params.rbi +125 -0
- data/rbi/context_dev/models/monitor_list_runs_response.rbi +455 -0
- data/rbi/context_dev/models/monitor_retrieve_change_params.rbi +38 -0
- data/rbi/context_dev/models/monitor_retrieve_change_response.rbi +478 -0
- data/rbi/context_dev/models/monitor_retrieve_params.rbi +38 -0
- data/rbi/context_dev/models/monitor_retrieve_response.rbi +828 -0
- data/rbi/context_dev/models/monitor_run_params.rbi +35 -0
- data/rbi/context_dev/models/monitor_run_response.rbi +48 -0
- data/rbi/context_dev/models/monitor_update_params.rbi +680 -0
- data/rbi/context_dev/models/monitor_update_response.rbi +820 -0
- data/rbi/context_dev/models/utility_prefetch_params.rbi +129 -7
- data/rbi/context_dev/models/utility_prefetch_response.rbi +55 -3
- data/rbi/context_dev/models/web_extract_response.rbi +10 -0
- data/rbi/context_dev/models/web_extract_styleguide_params.rbi +59 -0
- data/rbi/context_dev/models/web_screenshot_params.rbi +295 -0
- data/rbi/context_dev/models/web_search_params.rbi +288 -2
- data/rbi/context_dev/models/web_web_crawl_md_params.rbi +260 -0
- data/rbi/context_dev/models/web_web_scrape_html_params.rbi +465 -0
- data/rbi/context_dev/models/web_web_scrape_html_response.rbi +29 -3
- data/rbi/context_dev/models/web_web_scrape_images_params.rbi +17 -0
- data/rbi/context_dev/models/web_web_scrape_md_params.rbi +259 -0
- data/rbi/context_dev/models.rbi +23 -15
- data/rbi/context_dev/resources/ai.rbi +0 -28
- data/rbi/context_dev/resources/brand.rbi +13 -228
- data/rbi/context_dev/resources/monitors.rbi +286 -0
- data/rbi/context_dev/resources/utility.rbi +14 -29
- data/rbi/context_dev/resources/web.rbi +56 -1
- data/sig/context_dev/client.rbs +2 -0
- data/sig/context_dev/models/brand_retrieve_params.rbs +1560 -281
- data/sig/context_dev/models/monitor_create_params.rbs +311 -0
- data/sig/context_dev/models/monitor_create_response.rbs +369 -0
- data/sig/context_dev/models/monitor_delete_params.rbs +23 -0
- data/sig/context_dev/models/monitor_delete_response.rbs +15 -0
- data/sig/context_dev/models/monitor_list_account_changes_params.rbs +104 -0
- data/sig/context_dev/models/monitor_list_account_changes_response.rbs +176 -0
- data/sig/context_dev/models/monitor_list_account_runs_params.rbs +58 -0
- data/sig/context_dev/models/monitor_list_account_runs_response.rbs +184 -0
- data/sig/context_dev/models/monitor_list_changes_params.rbs +61 -0
- data/sig/context_dev/models/monitor_list_changes_response.rbs +176 -0
- data/sig/context_dev/models/monitor_list_params.rbs +160 -0
- data/sig/context_dev/models/monitor_list_response.rbs +396 -0
- data/sig/context_dev/models/monitor_list_runs_params.rbs +63 -0
- data/sig/context_dev/models/monitor_list_runs_response.rbs +184 -0
- data/sig/context_dev/models/monitor_retrieve_change_params.rbs +23 -0
- data/sig/context_dev/models/monitor_retrieve_change_response.rbs +228 -0
- data/sig/context_dev/models/monitor_retrieve_params.rbs +23 -0
- data/sig/context_dev/models/monitor_retrieve_response.rbs +369 -0
- data/sig/context_dev/models/monitor_run_params.rbs +23 -0
- data/sig/context_dev/models/monitor_run_response.rbs +18 -0
- data/sig/context_dev/models/monitor_update_params.rbs +331 -0
- data/sig/context_dev/models/monitor_update_response.rbs +369 -0
- data/sig/context_dev/models/utility_prefetch_params.rbs +52 -4
- data/sig/context_dev/models/utility_prefetch_response.rbs +22 -3
- data/sig/context_dev/models/web_extract_response.rbs +5 -0
- data/sig/context_dev/models/web_extract_styleguide_params.rbs +20 -0
- data/sig/context_dev/models/web_screenshot_params.rbs +446 -0
- data/sig/context_dev/models/web_search_params.rbs +503 -0
- data/sig/context_dev/models/web_web_crawl_md_params.rbs +433 -0
- data/sig/context_dev/models/web_web_scrape_html_params.rbs +433 -0
- data/sig/context_dev/models/web_web_scrape_html_response.rbs +8 -0
- data/sig/context_dev/models/web_web_scrape_images_params.rbs +7 -0
- data/sig/context_dev/models/web_web_scrape_md_params.rbs +433 -0
- data/sig/context_dev/models.rbs +20 -12
- data/sig/context_dev/resources/ai.rbs +0 -8
- data/sig/context_dev/resources/brand.rbs +1 -56
- data/sig/context_dev/resources/monitors.rbs +101 -0
- data/sig/context_dev/resources/utility.rbs +2 -7
- data/sig/context_dev/resources/web.rbs +12 -0
- metadata +71 -44
- data/lib/context_dev/models/ai_ai_query_params.rb +0 -235
- data/lib/context_dev/models/ai_ai_query_response.rb +0 -133
- data/lib/context_dev/models/brand_identify_from_transaction_params.rb +0 -474
- data/lib/context_dev/models/brand_identify_from_transaction_response.rb +0 -1074
- data/lib/context_dev/models/brand_retrieve_by_email_params.rb +0 -195
- data/lib/context_dev/models/brand_retrieve_by_email_response.rb +0 -1071
- data/lib/context_dev/models/brand_retrieve_by_isin_params.rb +0 -195
- data/lib/context_dev/models/brand_retrieve_by_isin_response.rb +0 -1070
- data/lib/context_dev/models/brand_retrieve_by_name_params.rb +0 -452
- data/lib/context_dev/models/brand_retrieve_by_name_response.rb +0 -1070
- data/lib/context_dev/models/brand_retrieve_by_ticker_params.rb +0 -283
- data/lib/context_dev/models/brand_retrieve_by_ticker_response.rb +0 -1072
- data/lib/context_dev/models/utility_prefetch_by_email_params.rb +0 -37
- data/lib/context_dev/models/utility_prefetch_by_email_response.rb +0 -68
- data/rbi/context_dev/models/ai_ai_query_params.rbi +0 -504
- data/rbi/context_dev/models/ai_ai_query_response.rbi +0 -267
- data/rbi/context_dev/models/brand_identify_from_transaction_params.rbi +0 -2020
- data/rbi/context_dev/models/brand_identify_from_transaction_response.rbi +0 -3515
- data/rbi/context_dev/models/brand_retrieve_by_email_params.rbi +0 -743
- data/rbi/context_dev/models/brand_retrieve_by_email_response.rbi +0 -3511
- data/rbi/context_dev/models/brand_retrieve_by_isin_params.rbi +0 -743
- data/rbi/context_dev/models/brand_retrieve_by_isin_response.rbi +0 -3510
- data/rbi/context_dev/models/brand_retrieve_by_name_params.rbi +0 -1982
- data/rbi/context_dev/models/brand_retrieve_by_name_response.rbi +0 -3510
- data/rbi/context_dev/models/brand_retrieve_by_ticker_params.rbi +0 -1153
- data/rbi/context_dev/models/brand_retrieve_by_ticker_response.rbi +0 -3512
- data/rbi/context_dev/models/utility_prefetch_by_email_params.rbi +0 -65
- data/rbi/context_dev/models/utility_prefetch_by_email_response.rbi +0 -132
- data/sig/context_dev/models/ai_ai_query_params.rbs +0 -218
- data/sig/context_dev/models/ai_ai_query_response.rbs +0 -121
- data/sig/context_dev/models/brand_identify_from_transaction_params.rbs +0 -822
- data/sig/context_dev/models/brand_identify_from_transaction_response.rbs +0 -1441
- data/sig/context_dev/models/brand_retrieve_by_email_params.rbs +0 -305
- data/sig/context_dev/models/brand_retrieve_by_email_response.rbs +0 -1441
- data/sig/context_dev/models/brand_retrieve_by_isin_params.rbs +0 -305
- data/sig/context_dev/models/brand_retrieve_by_isin_response.rbs +0 -1441
- data/sig/context_dev/models/brand_retrieve_by_name_params.rbs +0 -801
- data/sig/context_dev/models/brand_retrieve_by_name_response.rbs +0 -1441
- data/sig/context_dev/models/brand_retrieve_by_ticker_params.rbs +0 -467
- data/sig/context_dev/models/brand_retrieve_by_ticker_response.rbs +0 -1441
- data/sig/context_dev/models/utility_prefetch_by_email_params.rbs +0 -30
- data/sig/context_dev/models/utility_prefetch_by_email_response.rbs +0 -64
|
@@ -13,6 +13,14 @@ module ContextDev
|
|
|
13
13
|
# @return [String]
|
|
14
14
|
required :url, String
|
|
15
15
|
|
|
16
|
+
# @!attribute country
|
|
17
|
+
# Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev
|
|
18
|
+
# residential proxy exit location. Must be one of Context.dev's supported
|
|
19
|
+
# countries. When provided, Context.dev fetches the target page from that country.
|
|
20
|
+
#
|
|
21
|
+
# @return [Symbol, ContextDev::Models::WebWebCrawlMdParams::Country, nil]
|
|
22
|
+
optional :country, enum: -> { ContextDev::WebWebCrawlMdParams::Country }
|
|
23
|
+
|
|
16
24
|
# @!attribute exclude_selectors
|
|
17
25
|
# CSS selectors to remove before each crawled page is converted to Markdown.
|
|
18
26
|
# Applied after includeSelectors. Exclusion takes precedence: an element matching
|
|
@@ -84,6 +92,14 @@ module ContextDev
|
|
|
84
92
|
# @return [ContextDev::Models::WebWebCrawlMdParams::Pdf, nil]
|
|
85
93
|
optional :pdf, -> { ContextDev::WebWebCrawlMdParams::Pdf }
|
|
86
94
|
|
|
95
|
+
# @!attribute settle_animations
|
|
96
|
+
# When true, waits briefly for CSS and transition animations to settle before
|
|
97
|
+
# extracting each crawled page. Defaults to false. This adds a bit of latency in
|
|
98
|
+
# exchange for more stable output on animated pages.
|
|
99
|
+
#
|
|
100
|
+
# @return [Boolean, nil]
|
|
101
|
+
optional :settle_animations, ContextDev::Internal::Type::Boolean, api_name: :settleAnimations
|
|
102
|
+
|
|
87
103
|
# @!attribute shorten_base64_images
|
|
88
104
|
# Truncate base64-encoded image data in the Markdown output
|
|
89
105
|
#
|
|
@@ -127,12 +143,14 @@ module ContextDev
|
|
|
127
143
|
# @return [Integer, nil]
|
|
128
144
|
optional :wait_for_ms, Integer, api_name: :waitForMs
|
|
129
145
|
|
|
130
|
-
# @!method initialize(url:, exclude_selectors: nil, follow_subdomains: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, shorten_base64_images: nil, stop_after_ms: nil, timeout_ms: nil, url_regex: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {})
|
|
146
|
+
# @!method initialize(url:, country: nil, exclude_selectors: nil, follow_subdomains: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, settle_animations: nil, shorten_base64_images: nil, stop_after_ms: nil, timeout_ms: nil, url_regex: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {})
|
|
131
147
|
# Some parameter documentations has been truncated, see
|
|
132
148
|
# {ContextDev::Models::WebWebCrawlMdParams} for more details.
|
|
133
149
|
#
|
|
134
150
|
# @param url [String] The starting URL for the crawl (must include http:// or https:// protocol)
|
|
135
151
|
#
|
|
152
|
+
# @param country [Symbol, ContextDev::Models::WebWebCrawlMdParams::Country] Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev r
|
|
153
|
+
#
|
|
136
154
|
# @param exclude_selectors [Array<String>] CSS selectors to remove before each crawled page is converted to Markdown. Appli
|
|
137
155
|
#
|
|
138
156
|
# @param follow_subdomains [Boolean] When true, follow links on subdomains of the starting URL's domain (e.g. docs.ex
|
|
@@ -153,6 +171,8 @@ module ContextDev
|
|
|
153
171
|
#
|
|
154
172
|
# @param pdf [ContextDev::Models::WebWebCrawlMdParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and OCR to an inclu
|
|
155
173
|
#
|
|
174
|
+
# @param settle_animations [Boolean] When true, waits briefly for CSS and transition animations to settle before extr
|
|
175
|
+
#
|
|
156
176
|
# @param shorten_base64_images [Boolean] Truncate base64-encoded image data in the Markdown output
|
|
157
177
|
#
|
|
158
178
|
# @param stop_after_ms [Integer] Soft time budget for the crawl in milliseconds. After each scrape, the crawler c
|
|
@@ -167,6 +187,221 @@ module ContextDev
|
|
|
167
187
|
#
|
|
168
188
|
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
|
|
169
189
|
|
|
190
|
+
# Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev
|
|
191
|
+
# residential proxy exit location. Must be one of Context.dev's supported
|
|
192
|
+
# countries. When provided, Context.dev fetches the target page from that country.
|
|
193
|
+
module Country
|
|
194
|
+
extend ContextDev::Internal::Type::Enum
|
|
195
|
+
|
|
196
|
+
AD = :ad
|
|
197
|
+
AE = :ae
|
|
198
|
+
AF = :af
|
|
199
|
+
AG = :ag
|
|
200
|
+
AI = :ai
|
|
201
|
+
AL = :al
|
|
202
|
+
AM = :am
|
|
203
|
+
AO = :ao
|
|
204
|
+
AR = :ar
|
|
205
|
+
AT = :at
|
|
206
|
+
AU = :au
|
|
207
|
+
AW = :aw
|
|
208
|
+
AZ = :az
|
|
209
|
+
BA = :ba
|
|
210
|
+
BB = :bb
|
|
211
|
+
BD = :bd
|
|
212
|
+
BE = :be
|
|
213
|
+
BF = :bf
|
|
214
|
+
BG = :bg
|
|
215
|
+
BH = :bh
|
|
216
|
+
BI = :bi
|
|
217
|
+
BJ = :bj
|
|
218
|
+
BM = :bm
|
|
219
|
+
BN = :bn
|
|
220
|
+
BO = :bo
|
|
221
|
+
BQ = :bq
|
|
222
|
+
BR = :br
|
|
223
|
+
BS = :bs
|
|
224
|
+
BW = :bw
|
|
225
|
+
BY = :by
|
|
226
|
+
BZ = :bz
|
|
227
|
+
CA = :ca
|
|
228
|
+
CD = :cd
|
|
229
|
+
CF = :cf
|
|
230
|
+
CG = :cg
|
|
231
|
+
CH = :ch
|
|
232
|
+
CI = :ci
|
|
233
|
+
CL = :cl
|
|
234
|
+
CM = :cm
|
|
235
|
+
CN = :cn
|
|
236
|
+
CO = :co
|
|
237
|
+
CR = :cr
|
|
238
|
+
CV = :cv
|
|
239
|
+
CW = :cw
|
|
240
|
+
CY = :cy
|
|
241
|
+
CZ = :cz
|
|
242
|
+
DE = :de
|
|
243
|
+
DJ = :dj
|
|
244
|
+
DK = :dk
|
|
245
|
+
DM = :dm
|
|
246
|
+
DO = :do
|
|
247
|
+
DZ = :dz
|
|
248
|
+
EC = :ec
|
|
249
|
+
EE = :ee
|
|
250
|
+
EG = :eg
|
|
251
|
+
ES = :es
|
|
252
|
+
ET = :et
|
|
253
|
+
FI = :fi
|
|
254
|
+
FJ = :fj
|
|
255
|
+
FR = :fr
|
|
256
|
+
GA = :ga
|
|
257
|
+
GB = :gb
|
|
258
|
+
GD = :gd
|
|
259
|
+
GE = :ge
|
|
260
|
+
GF = :gf
|
|
261
|
+
GG = :gg
|
|
262
|
+
GH = :gh
|
|
263
|
+
GM = :gm
|
|
264
|
+
GN = :gn
|
|
265
|
+
GP = :gp
|
|
266
|
+
GQ = :gq
|
|
267
|
+
GR = :gr
|
|
268
|
+
GT = :gt
|
|
269
|
+
GU = :gu
|
|
270
|
+
GW = :gw
|
|
271
|
+
GY = :gy
|
|
272
|
+
HK = :hk
|
|
273
|
+
HN = :hn
|
|
274
|
+
HR = :hr
|
|
275
|
+
HT = :ht
|
|
276
|
+
HU = :hu
|
|
277
|
+
ID = :id
|
|
278
|
+
IE = :ie
|
|
279
|
+
IL = :il
|
|
280
|
+
IM = :im
|
|
281
|
+
IN = :in
|
|
282
|
+
IQ = :iq
|
|
283
|
+
IR = :ir
|
|
284
|
+
IS = :is
|
|
285
|
+
IT = :it
|
|
286
|
+
JE = :je
|
|
287
|
+
JM = :jm
|
|
288
|
+
JO = :jo
|
|
289
|
+
JP = :jp
|
|
290
|
+
KE = :ke
|
|
291
|
+
KG = :kg
|
|
292
|
+
KH = :kh
|
|
293
|
+
KN = :kn
|
|
294
|
+
KR = :kr
|
|
295
|
+
KW = :kw
|
|
296
|
+
KY = :ky
|
|
297
|
+
KZ = :kz
|
|
298
|
+
LA = :la
|
|
299
|
+
LB = :lb
|
|
300
|
+
LC = :lc
|
|
301
|
+
LK = :lk
|
|
302
|
+
LR = :lr
|
|
303
|
+
LS = :ls
|
|
304
|
+
LT = :lt
|
|
305
|
+
LU = :lu
|
|
306
|
+
LV = :lv
|
|
307
|
+
LY = :ly
|
|
308
|
+
MA = :ma
|
|
309
|
+
MC = :mc
|
|
310
|
+
MD = :md
|
|
311
|
+
ME = :me
|
|
312
|
+
MF = :mf
|
|
313
|
+
MG = :mg
|
|
314
|
+
MK = :mk
|
|
315
|
+
ML = :ml
|
|
316
|
+
MM = :mm
|
|
317
|
+
MN = :mn
|
|
318
|
+
MO = :mo
|
|
319
|
+
MQ = :mq
|
|
320
|
+
MR = :mr
|
|
321
|
+
MT = :mt
|
|
322
|
+
MU = :mu
|
|
323
|
+
MV = :mv
|
|
324
|
+
MW = :mw
|
|
325
|
+
MX = :mx
|
|
326
|
+
MY = :my
|
|
327
|
+
MZ = :mz
|
|
328
|
+
NA = :na
|
|
329
|
+
NC = :nc
|
|
330
|
+
NE = :ne
|
|
331
|
+
NG = :ng
|
|
332
|
+
NI = :ni
|
|
333
|
+
NL = :nl
|
|
334
|
+
NO = :no
|
|
335
|
+
NP = :np
|
|
336
|
+
NZ = :nz
|
|
337
|
+
OM = :om
|
|
338
|
+
PA = :pa
|
|
339
|
+
PE = :pe
|
|
340
|
+
PF = :pf
|
|
341
|
+
PG = :pg
|
|
342
|
+
PH = :ph
|
|
343
|
+
PK = :pk
|
|
344
|
+
PL = :pl
|
|
345
|
+
PR = :pr
|
|
346
|
+
PS = :ps
|
|
347
|
+
PT = :pt
|
|
348
|
+
PY = :py
|
|
349
|
+
QA = :qa
|
|
350
|
+
RE = :re
|
|
351
|
+
RO = :ro
|
|
352
|
+
RS = :rs
|
|
353
|
+
RU = :ru
|
|
354
|
+
RW = :rw
|
|
355
|
+
SA = :sa
|
|
356
|
+
SC = :sc
|
|
357
|
+
SD = :sd
|
|
358
|
+
SE = :se
|
|
359
|
+
SG = :sg
|
|
360
|
+
SI = :si
|
|
361
|
+
SK = :sk
|
|
362
|
+
SL = :sl
|
|
363
|
+
SM = :sm
|
|
364
|
+
SN = :sn
|
|
365
|
+
SO = :so
|
|
366
|
+
SR = :sr
|
|
367
|
+
SS = :ss
|
|
368
|
+
ST = :st
|
|
369
|
+
SV = :sv
|
|
370
|
+
SX = :sx
|
|
371
|
+
SY = :sy
|
|
372
|
+
SZ = :sz
|
|
373
|
+
TC = :tc
|
|
374
|
+
TD = :td
|
|
375
|
+
TG = :tg
|
|
376
|
+
TH = :th
|
|
377
|
+
TJ = :tj
|
|
378
|
+
TL = :tl
|
|
379
|
+
TM = :tm
|
|
380
|
+
TN = :tn
|
|
381
|
+
TR = :tr
|
|
382
|
+
TT = :tt
|
|
383
|
+
TW = :tw
|
|
384
|
+
TZ = :tz
|
|
385
|
+
UA = :ua
|
|
386
|
+
UG = :ug
|
|
387
|
+
US = :us
|
|
388
|
+
UY = :uy
|
|
389
|
+
UZ = :uz
|
|
390
|
+
VC = :vc
|
|
391
|
+
VE = :ve
|
|
392
|
+
VG = :vg
|
|
393
|
+
VI = :vi
|
|
394
|
+
VN = :vn
|
|
395
|
+
YE = :ye
|
|
396
|
+
YT = :yt
|
|
397
|
+
ZA = :za
|
|
398
|
+
ZM = :zm
|
|
399
|
+
ZW = :zw
|
|
400
|
+
|
|
401
|
+
# @!method self.values
|
|
402
|
+
# @return [Array<Symbol>]
|
|
403
|
+
end
|
|
404
|
+
|
|
170
405
|
class Pdf < ContextDev::Internal::Type::BaseModel
|
|
171
406
|
# @!attribute end_
|
|
172
407
|
# Last 1-based PDF page to parse. When omitted, parsing ends at the last page.
|
|
@@ -13,6 +13,13 @@ module ContextDev
|
|
|
13
13
|
# @return [String]
|
|
14
14
|
required :url, String
|
|
15
15
|
|
|
16
|
+
# @!attribute country
|
|
17
|
+
# Two-letter ISO 3166-1 alpha-2 country code for the website request location.
|
|
18
|
+
# When provided, Context.dev fetches the target page from that country.
|
|
19
|
+
#
|
|
20
|
+
# @return [Symbol, ContextDev::Models::WebWebScrapeHTMLParams::Country, nil]
|
|
21
|
+
optional :country, enum: -> { ContextDev::WebWebScrapeHTMLParams::Country }
|
|
22
|
+
|
|
16
23
|
# @!attribute exclude_selectors
|
|
17
24
|
# CSS selectors to remove from the result. Applied after includeSelectors.
|
|
18
25
|
# Exclusion takes precedence: an element matching both is removed. Examples:
|
|
@@ -58,6 +65,14 @@ module ContextDev
|
|
|
58
65
|
# @return [ContextDev::Models::WebWebScrapeHTMLParams::Pdf, nil]
|
|
59
66
|
optional :pdf, -> { ContextDev::WebWebScrapeHTMLParams::Pdf }
|
|
60
67
|
|
|
68
|
+
# @!attribute settle_animations
|
|
69
|
+
# When true, waits briefly for CSS and transition animations to settle before
|
|
70
|
+
# extracting HTML. Defaults to false. This adds a bit of latency in exchange for
|
|
71
|
+
# more stable output on animated pages.
|
|
72
|
+
#
|
|
73
|
+
# @return [Boolean, nil]
|
|
74
|
+
optional :settle_animations, ContextDev::Internal::Type::Boolean
|
|
75
|
+
|
|
61
76
|
# @!attribute timeout_ms
|
|
62
77
|
# Optional timeout in milliseconds for the request. If the request takes longer
|
|
63
78
|
# than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
@@ -80,12 +95,14 @@ module ContextDev
|
|
|
80
95
|
# @return [Integer, nil]
|
|
81
96
|
optional :wait_for_ms, Integer
|
|
82
97
|
|
|
83
|
-
# @!method initialize(url:, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {})
|
|
98
|
+
# @!method initialize(url:, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, settle_animations: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {})
|
|
84
99
|
# Some parameter documentations has been truncated, see
|
|
85
100
|
# {ContextDev::Models::WebWebScrapeHTMLParams} for more details.
|
|
86
101
|
#
|
|
87
102
|
# @param url [String] Full URL to scrape (must include http:// or https:// protocol)
|
|
88
103
|
#
|
|
104
|
+
# @param country [Symbol, ContextDev::Models::WebWebScrapeHTMLParams::Country] Two-letter ISO 3166-1 alpha-2 country code for the website request location. Whe
|
|
105
|
+
#
|
|
89
106
|
# @param exclude_selectors [Array<String>] CSS selectors to remove from the result. Applied after includeSelectors. Exclusi
|
|
90
107
|
#
|
|
91
108
|
# @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob
|
|
@@ -98,6 +115,8 @@ module ContextDev
|
|
|
98
115
|
#
|
|
99
116
|
# @param pdf [ContextDev::Models::WebWebScrapeHTMLParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and OCR to an inclu
|
|
100
117
|
#
|
|
118
|
+
# @param settle_animations [Boolean] When true, waits briefly for CSS and transition animations to settle before extr
|
|
119
|
+
#
|
|
101
120
|
# @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
|
|
102
121
|
#
|
|
103
122
|
# @param use_main_content_only [Boolean] When true, return only the page's main content in the HTML response, excluding h
|
|
@@ -106,6 +125,220 @@ module ContextDev
|
|
|
106
125
|
#
|
|
107
126
|
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
|
|
108
127
|
|
|
128
|
+
# Two-letter ISO 3166-1 alpha-2 country code for the website request location.
|
|
129
|
+
# When provided, Context.dev fetches the target page from that country.
|
|
130
|
+
module Country
|
|
131
|
+
extend ContextDev::Internal::Type::Enum
|
|
132
|
+
|
|
133
|
+
AD = :ad
|
|
134
|
+
AE = :ae
|
|
135
|
+
AF = :af
|
|
136
|
+
AG = :ag
|
|
137
|
+
AI = :ai
|
|
138
|
+
AL = :al
|
|
139
|
+
AM = :am
|
|
140
|
+
AO = :ao
|
|
141
|
+
AR = :ar
|
|
142
|
+
AT = :at
|
|
143
|
+
AU = :au
|
|
144
|
+
AW = :aw
|
|
145
|
+
AZ = :az
|
|
146
|
+
BA = :ba
|
|
147
|
+
BB = :bb
|
|
148
|
+
BD = :bd
|
|
149
|
+
BE = :be
|
|
150
|
+
BF = :bf
|
|
151
|
+
BG = :bg
|
|
152
|
+
BH = :bh
|
|
153
|
+
BI = :bi
|
|
154
|
+
BJ = :bj
|
|
155
|
+
BM = :bm
|
|
156
|
+
BN = :bn
|
|
157
|
+
BO = :bo
|
|
158
|
+
BQ = :bq
|
|
159
|
+
BR = :br
|
|
160
|
+
BS = :bs
|
|
161
|
+
BW = :bw
|
|
162
|
+
BY = :by
|
|
163
|
+
BZ = :bz
|
|
164
|
+
CA = :ca
|
|
165
|
+
CD = :cd
|
|
166
|
+
CF = :cf
|
|
167
|
+
CG = :cg
|
|
168
|
+
CH = :ch
|
|
169
|
+
CI = :ci
|
|
170
|
+
CL = :cl
|
|
171
|
+
CM = :cm
|
|
172
|
+
CN = :cn
|
|
173
|
+
CO = :co
|
|
174
|
+
CR = :cr
|
|
175
|
+
CV = :cv
|
|
176
|
+
CW = :cw
|
|
177
|
+
CY = :cy
|
|
178
|
+
CZ = :cz
|
|
179
|
+
DE = :de
|
|
180
|
+
DJ = :dj
|
|
181
|
+
DK = :dk
|
|
182
|
+
DM = :dm
|
|
183
|
+
DO = :do
|
|
184
|
+
DZ = :dz
|
|
185
|
+
EC = :ec
|
|
186
|
+
EE = :ee
|
|
187
|
+
EG = :eg
|
|
188
|
+
ES = :es
|
|
189
|
+
ET = :et
|
|
190
|
+
FI = :fi
|
|
191
|
+
FJ = :fj
|
|
192
|
+
FR = :fr
|
|
193
|
+
GA = :ga
|
|
194
|
+
GB = :gb
|
|
195
|
+
GD = :gd
|
|
196
|
+
GE = :ge
|
|
197
|
+
GF = :gf
|
|
198
|
+
GG = :gg
|
|
199
|
+
GH = :gh
|
|
200
|
+
GM = :gm
|
|
201
|
+
GN = :gn
|
|
202
|
+
GP = :gp
|
|
203
|
+
GQ = :gq
|
|
204
|
+
GR = :gr
|
|
205
|
+
GT = :gt
|
|
206
|
+
GU = :gu
|
|
207
|
+
GW = :gw
|
|
208
|
+
GY = :gy
|
|
209
|
+
HK = :hk
|
|
210
|
+
HN = :hn
|
|
211
|
+
HR = :hr
|
|
212
|
+
HT = :ht
|
|
213
|
+
HU = :hu
|
|
214
|
+
ID = :id
|
|
215
|
+
IE = :ie
|
|
216
|
+
IL = :il
|
|
217
|
+
IM = :im
|
|
218
|
+
IN = :in
|
|
219
|
+
IQ = :iq
|
|
220
|
+
IR = :ir
|
|
221
|
+
IS = :is
|
|
222
|
+
IT = :it
|
|
223
|
+
JE = :je
|
|
224
|
+
JM = :jm
|
|
225
|
+
JO = :jo
|
|
226
|
+
JP = :jp
|
|
227
|
+
KE = :ke
|
|
228
|
+
KG = :kg
|
|
229
|
+
KH = :kh
|
|
230
|
+
KN = :kn
|
|
231
|
+
KR = :kr
|
|
232
|
+
KW = :kw
|
|
233
|
+
KY = :ky
|
|
234
|
+
KZ = :kz
|
|
235
|
+
LA = :la
|
|
236
|
+
LB = :lb
|
|
237
|
+
LC = :lc
|
|
238
|
+
LK = :lk
|
|
239
|
+
LR = :lr
|
|
240
|
+
LS = :ls
|
|
241
|
+
LT = :lt
|
|
242
|
+
LU = :lu
|
|
243
|
+
LV = :lv
|
|
244
|
+
LY = :ly
|
|
245
|
+
MA = :ma
|
|
246
|
+
MC = :mc
|
|
247
|
+
MD = :md
|
|
248
|
+
ME = :me
|
|
249
|
+
MF = :mf
|
|
250
|
+
MG = :mg
|
|
251
|
+
MK = :mk
|
|
252
|
+
ML = :ml
|
|
253
|
+
MM = :mm
|
|
254
|
+
MN = :mn
|
|
255
|
+
MO = :mo
|
|
256
|
+
MQ = :mq
|
|
257
|
+
MR = :mr
|
|
258
|
+
MT = :mt
|
|
259
|
+
MU = :mu
|
|
260
|
+
MV = :mv
|
|
261
|
+
MW = :mw
|
|
262
|
+
MX = :mx
|
|
263
|
+
MY = :my
|
|
264
|
+
MZ = :mz
|
|
265
|
+
NA = :na
|
|
266
|
+
NC = :nc
|
|
267
|
+
NE = :ne
|
|
268
|
+
NG = :ng
|
|
269
|
+
NI = :ni
|
|
270
|
+
NL = :nl
|
|
271
|
+
NO = :no
|
|
272
|
+
NP = :np
|
|
273
|
+
NZ = :nz
|
|
274
|
+
OM = :om
|
|
275
|
+
PA = :pa
|
|
276
|
+
PE = :pe
|
|
277
|
+
PF = :pf
|
|
278
|
+
PG = :pg
|
|
279
|
+
PH = :ph
|
|
280
|
+
PK = :pk
|
|
281
|
+
PL = :pl
|
|
282
|
+
PR = :pr
|
|
283
|
+
PS = :ps
|
|
284
|
+
PT = :pt
|
|
285
|
+
PY = :py
|
|
286
|
+
QA = :qa
|
|
287
|
+
RE = :re
|
|
288
|
+
RO = :ro
|
|
289
|
+
RS = :rs
|
|
290
|
+
RU = :ru
|
|
291
|
+
RW = :rw
|
|
292
|
+
SA = :sa
|
|
293
|
+
SC = :sc
|
|
294
|
+
SD = :sd
|
|
295
|
+
SE = :se
|
|
296
|
+
SG = :sg
|
|
297
|
+
SI = :si
|
|
298
|
+
SK = :sk
|
|
299
|
+
SL = :sl
|
|
300
|
+
SM = :sm
|
|
301
|
+
SN = :sn
|
|
302
|
+
SO = :so
|
|
303
|
+
SR = :sr
|
|
304
|
+
SS = :ss
|
|
305
|
+
ST = :st
|
|
306
|
+
SV = :sv
|
|
307
|
+
SX = :sx
|
|
308
|
+
SY = :sy
|
|
309
|
+
SZ = :sz
|
|
310
|
+
TC = :tc
|
|
311
|
+
TD = :td
|
|
312
|
+
TG = :tg
|
|
313
|
+
TH = :th
|
|
314
|
+
TJ = :tj
|
|
315
|
+
TL = :tl
|
|
316
|
+
TM = :tm
|
|
317
|
+
TN = :tn
|
|
318
|
+
TR = :tr
|
|
319
|
+
TT = :tt
|
|
320
|
+
TW = :tw
|
|
321
|
+
TZ = :tz
|
|
322
|
+
UA = :ua
|
|
323
|
+
UG = :ug
|
|
324
|
+
US = :us
|
|
325
|
+
UY = :uy
|
|
326
|
+
UZ = :uz
|
|
327
|
+
VC = :vc
|
|
328
|
+
VE = :ve
|
|
329
|
+
VG = :vg
|
|
330
|
+
VI = :vi
|
|
331
|
+
VN = :vn
|
|
332
|
+
YE = :ye
|
|
333
|
+
YT = :yt
|
|
334
|
+
ZA = :za
|
|
335
|
+
ZM = :zm
|
|
336
|
+
ZW = :zw
|
|
337
|
+
|
|
338
|
+
# @!method self.values
|
|
339
|
+
# @return [Array<Symbol>]
|
|
340
|
+
end
|
|
341
|
+
|
|
109
342
|
class Pdf < ContextDev::Internal::Type::BaseModel
|
|
110
343
|
# @!attribute end_
|
|
111
344
|
# Last 1-based PDF page to parse. When omitted, parsing ends at the last page.
|
|
@@ -26,7 +26,9 @@ module ContextDev
|
|
|
26
26
|
|
|
27
27
|
# @!attribute type
|
|
28
28
|
# Detected content type of the returned `html` field. Sitemaps and feeds are
|
|
29
|
-
# surfaced as `xml`; ordinary pages are `html`.
|
|
29
|
+
# surfaced as `xml`; ordinary pages are `html`. Excel workbooks are surfaced as
|
|
30
|
+
# `xlsx`/`xls` with the extracted sheets as HTML tables; PowerPoint presentations
|
|
31
|
+
# are surfaced as `pptx`/`ppt` with the extracted slides as HTML.
|
|
30
32
|
#
|
|
31
33
|
# @return [Symbol, ContextDev::Models::WebWebScrapeHTMLResponse::Type]
|
|
32
34
|
required :type, enum: -> { ContextDev::Models::WebWebScrapeHTMLResponse::Type }
|
|
@@ -320,7 +322,9 @@ module ContextDev
|
|
|
320
322
|
end
|
|
321
323
|
|
|
322
324
|
# Detected content type of the returned `html` field. Sitemaps and feeds are
|
|
323
|
-
# surfaced as `xml`; ordinary pages are `html`.
|
|
325
|
+
# surfaced as `xml`; ordinary pages are `html`. Excel workbooks are surfaced as
|
|
326
|
+
# `xlsx`/`xls` with the extracted sheets as HTML tables; PowerPoint presentations
|
|
327
|
+
# are surfaced as `pptx`/`ppt` with the extracted slides as HTML.
|
|
324
328
|
#
|
|
325
329
|
# @see ContextDev::Models::WebWebScrapeHTMLResponse#type
|
|
326
330
|
module Type
|
|
@@ -336,6 +340,10 @@ module ContextDev
|
|
|
336
340
|
PDF = :pdf
|
|
337
341
|
DOCX = :docx
|
|
338
342
|
DOC = :doc
|
|
343
|
+
XLSX = :xlsx
|
|
344
|
+
XLS = :xls
|
|
345
|
+
PPTX = :pptx
|
|
346
|
+
PPT = :ppt
|
|
339
347
|
|
|
340
348
|
# @!method self.values
|
|
341
349
|
# @return [Array<Symbol>]
|
|
@@ -13,6 +13,15 @@ module ContextDev
|
|
|
13
13
|
# @return [String]
|
|
14
14
|
required :url, String
|
|
15
15
|
|
|
16
|
+
# @!attribute dedupe
|
|
17
|
+
# When true, visually duplicate images are removed: every image is loaded and
|
|
18
|
+
# perceptually hashed, and only the highest-resolution copy of each duplicate
|
|
19
|
+
# group is kept. Images that cannot be downloaded or hashed are kept. Default:
|
|
20
|
+
# false.
|
|
21
|
+
#
|
|
22
|
+
# @return [Boolean, nil]
|
|
23
|
+
optional :dedupe, ContextDev::Internal::Type::Boolean
|
|
24
|
+
|
|
16
25
|
# @!attribute enrichment
|
|
17
26
|
# Optional per-image processing, sent as deep-object query params such as
|
|
18
27
|
# enrichment[resolution]=true.
|
|
@@ -50,12 +59,14 @@ module ContextDev
|
|
|
50
59
|
# @return [Integer, nil]
|
|
51
60
|
optional :wait_for_ms, Integer
|
|
52
61
|
|
|
53
|
-
# @!method initialize(url:, enrichment: nil, headers: nil, max_age_ms: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {})
|
|
62
|
+
# @!method initialize(url:, dedupe: nil, enrichment: nil, headers: nil, max_age_ms: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {})
|
|
54
63
|
# Some parameter documentations has been truncated, see
|
|
55
64
|
# {ContextDev::Models::WebWebScrapeImagesParams} for more details.
|
|
56
65
|
#
|
|
57
66
|
# @param url [String] Page URL to inspect. Must include http:// or https://.
|
|
58
67
|
#
|
|
68
|
+
# @param dedupe [Boolean] When true, visually duplicate images are removed: every image is loaded and perc
|
|
69
|
+
#
|
|
59
70
|
# @param enrichment [ContextDev::Models::WebWebScrapeImagesParams::Enrichment] Optional per-image processing, sent as deep-object query params such as enrichme
|
|
60
71
|
#
|
|
61
72
|
# @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob
|