context.dev 2.16.0 → 2.17.1
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 +24 -0
- data/README.md +1 -1
- data/lib/context_dev/models/ai_extract_product_params.rb +53 -8
- data/lib/context_dev/models/ai_extract_product_response.rb +10 -1
- data/lib/context_dev/models/ai_extract_products_params.rb +116 -16
- data/lib/context_dev/models/ai_extract_products_response.rb +11 -1
- data/lib/context_dev/models/brand_retrieve_params.rb +355 -60
- data/lib/context_dev/models/brand_retrieve_response.rb +71 -62
- data/lib/context_dev/models/brand_retrieve_simplified_params.rb +57 -11
- data/lib/context_dev/models/brand_retrieve_simplified_response.rb +72 -63
- data/lib/context_dev/models/industry_retrieve_naics_params.rb +53 -8
- data/lib/context_dev/models/industry_retrieve_naics_response.rb +10 -1
- data/lib/context_dev/models/industry_retrieve_sic_params.rb +53 -8
- data/lib/context_dev/models/industry_retrieve_sic_response.rb +10 -1
- data/lib/context_dev/models/monitor_create_params.rb +27 -3
- data/lib/context_dev/models/monitor_create_response.rb +30 -5
- data/lib/context_dev/models/monitor_list_response.rb +30 -5
- data/lib/context_dev/models/monitor_retrieve_response.rb +30 -5
- data/lib/context_dev/models/monitor_update_params.rb +27 -3
- data/lib/context_dev/models/monitor_update_response.rb +30 -5
- data/lib/context_dev/models/person_enrich_params.rb +53 -8
- data/lib/context_dev/models/person_enrich_response.rb +10 -1
- data/lib/context_dev/models/utility_prefetch_params.rb +48 -8
- data/lib/context_dev/models/web_answers_params.rb +124 -0
- data/lib/context_dev/models/web_answers_response.rb +68 -0
- data/lib/context_dev/models/web_extract_competitors_params.rb +53 -8
- data/lib/context_dev/models/web_extract_competitors_response.rb +10 -1
- data/lib/context_dev/models/web_extract_fonts_params.rb +58 -11
- data/lib/context_dev/models/web_extract_fonts_response.rb +32 -1
- data/lib/context_dev/models/web_extract_params.rb +53 -8
- data/lib/context_dev/models/web_extract_response.rb +10 -1
- data/lib/context_dev/models/web_extract_styleguide_params.rb +58 -11
- data/lib/context_dev/models/web_extract_styleguide_response.rb +32 -1
- data/lib/context_dev/models/web_screenshot_params.rb +58 -10
- data/lib/context_dev/models/web_screenshot_response.rb +32 -1
- data/lib/context_dev/models/web_search_params.rb +112 -16
- data/lib/context_dev/models/web_search_response.rb +49 -4
- data/lib/context_dev/models/web_web_crawl_md_params.rb +53 -8
- data/lib/context_dev/models/web_web_crawl_md_response.rb +11 -1
- data/lib/context_dev/models/web_web_scrape_bytes_params.rb +344 -0
- data/lib/context_dev/models/web_web_scrape_bytes_response.rb +135 -0
- data/lib/context_dev/models/web_web_scrape_html_params.rb +57 -10
- data/lib/context_dev/models/web_web_scrape_html_response.rb +32 -1
- data/lib/context_dev/models/web_web_scrape_images_params.rb +57 -10
- data/lib/context_dev/models/web_web_scrape_images_response.rb +42 -1
- data/lib/context_dev/models/web_web_scrape_md_params.rb +57 -10
- data/lib/context_dev/models/web_web_scrape_md_response.rb +32 -1
- data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +53 -8
- data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +11 -1
- data/lib/context_dev/models.rb +4 -0
- data/lib/context_dev/resources/ai.rb +2 -2
- data/lib/context_dev/resources/brand.rb +3 -3
- data/lib/context_dev/resources/industry.rb +6 -6
- data/lib/context_dev/resources/people.rb +2 -2
- data/lib/context_dev/resources/utility.rb +2 -2
- data/lib/context_dev/resources/web.rb +119 -33
- data/lib/context_dev/version.rb +1 -1
- data/lib/context_dev.rb +4 -0
- data/rbi/context_dev/models/ai_extract_product_params.rbi +125 -13
- data/rbi/context_dev/models/ai_extract_product_response.rbi +13 -0
- data/rbi/context_dev/models/ai_extract_products_params.rbi +264 -26
- data/rbi/context_dev/models/ai_extract_products_response.rbi +15 -0
- data/rbi/context_dev/models/brand_retrieve_params.rbi +816 -102
- data/rbi/context_dev/models/brand_retrieve_response.rbi +136 -131
- data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi +136 -19
- data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +140 -135
- data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +127 -13
- data/rbi/context_dev/models/industry_retrieve_naics_response.rbi +13 -0
- data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +127 -13
- data/rbi/context_dev/models/industry_retrieve_sic_response.rbi +13 -0
- data/rbi/context_dev/models/monitor_create_params.rbi +40 -2
- data/rbi/context_dev/models/monitor_create_response.rbi +44 -4
- data/rbi/context_dev/models/monitor_list_response.rbi +44 -4
- data/rbi/context_dev/models/monitor_retrieve_response.rbi +44 -4
- data/rbi/context_dev/models/monitor_update_params.rbi +40 -2
- data/rbi/context_dev/models/monitor_update_response.rbi +44 -4
- data/rbi/context_dev/models/person_enrich_params.rbi +123 -13
- data/rbi/context_dev/models/person_enrich_response.rbi +16 -3
- data/rbi/context_dev/models/utility_prefetch_params.rbi +112 -13
- data/rbi/context_dev/models/web_answers_params.rbi +234 -0
- data/rbi/context_dev/models/web_answers_response.rbi +122 -0
- data/rbi/context_dev/models/web_extract_competitors_params.rbi +127 -13
- data/rbi/context_dev/models/web_extract_competitors_response.rbi +16 -3
- data/rbi/context_dev/models/web_extract_fonts_params.rbi +132 -19
- data/rbi/context_dev/models/web_extract_fonts_response.rbi +71 -0
- data/rbi/context_dev/models/web_extract_params.rbi +120 -13
- data/rbi/context_dev/models/web_extract_response.rbi +16 -3
- data/rbi/context_dev/models/web_extract_styleguide_params.rbi +136 -19
- data/rbi/context_dev/models/web_extract_styleguide_response.rbi +71 -0
- data/rbi/context_dev/models/web_screenshot_params.rbi +132 -17
- data/rbi/context_dev/models/web_screenshot_response.rbi +71 -0
- data/rbi/context_dev/models/web_search_params.rbi +253 -26
- data/rbi/context_dev/models/web_search_response.rbi +96 -8
- data/rbi/context_dev/models/web_web_crawl_md_params.rbi +123 -13
- data/rbi/context_dev/models/web_web_crawl_md_response.rbi +19 -3
- data/rbi/context_dev/models/web_web_scrape_bytes_params.rbi +699 -0
- data/rbi/context_dev/models/web_web_scrape_bytes_response.rbi +238 -0
- data/rbi/context_dev/models/web_web_scrape_html_params.rbi +132 -17
- data/rbi/context_dev/models/web_web_scrape_html_response.rbi +61 -0
- data/rbi/context_dev/models/web_web_scrape_images_params.rbi +134 -17
- data/rbi/context_dev/models/web_web_scrape_images_response.rbi +89 -3
- data/rbi/context_dev/models/web_web_scrape_md_params.rbi +130 -17
- data/rbi/context_dev/models/web_web_scrape_md_response.rbi +61 -0
- data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +127 -13
- data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +18 -3
- data/rbi/context_dev/models.rbi +4 -0
- data/rbi/context_dev/resources/ai.rbi +5 -5
- data/rbi/context_dev/resources/brand.rbi +9 -8
- data/rbi/context_dev/resources/industry.rbi +12 -10
- data/rbi/context_dev/resources/people.rbi +5 -5
- data/rbi/context_dev/resources/utility.rbi +5 -5
- data/rbi/context_dev/resources/web.rbi +170 -72
- data/sig/context_dev/models/ai_extract_product_params.rbs +44 -5
- data/sig/context_dev/models/ai_extract_product_response.rbs +7 -0
- data/sig/context_dev/models/ai_extract_products_params.rbs +88 -10
- data/sig/context_dev/models/ai_extract_products_response.rbs +7 -0
- data/sig/context_dev/models/brand_retrieve_params.rbs +264 -30
- data/sig/context_dev/models/brand_retrieve_response.rbs +53 -54
- data/sig/context_dev/models/brand_retrieve_simplified_params.rbs +44 -5
- data/sig/context_dev/models/brand_retrieve_simplified_response.rbs +53 -54
- data/sig/context_dev/models/industry_retrieve_naics_params.rbs +44 -5
- data/sig/context_dev/models/industry_retrieve_naics_response.rbs +7 -0
- data/sig/context_dev/models/industry_retrieve_sic_params.rbs +44 -5
- data/sig/context_dev/models/industry_retrieve_sic_response.rbs +7 -0
- data/sig/context_dev/models/monitor_create_params.rbs +14 -0
- data/sig/context_dev/models/monitor_create_response.rbs +14 -0
- data/sig/context_dev/models/monitor_list_response.rbs +14 -0
- data/sig/context_dev/models/monitor_retrieve_response.rbs +14 -0
- data/sig/context_dev/models/monitor_update_params.rbs +14 -0
- data/sig/context_dev/models/monitor_update_response.rbs +14 -0
- data/sig/context_dev/models/person_enrich_params.rbs +44 -5
- data/sig/context_dev/models/person_enrich_response.rbs +10 -3
- data/sig/context_dev/models/utility_prefetch_params.rbs +43 -5
- data/sig/context_dev/models/web_answers_params.rbs +106 -0
- data/sig/context_dev/models/web_answers_response.rbs +60 -0
- data/sig/context_dev/models/web_extract_competitors_params.rbs +44 -5
- data/sig/context_dev/models/web_extract_competitors_response.rbs +10 -3
- data/sig/context_dev/models/web_extract_fonts_params.rbs +44 -5
- data/sig/context_dev/models/web_extract_fonts_response.rbs +20 -0
- data/sig/context_dev/models/web_extract_params.rbs +44 -5
- data/sig/context_dev/models/web_extract_response.rbs +10 -3
- data/sig/context_dev/models/web_extract_styleguide_params.rbs +44 -5
- data/sig/context_dev/models/web_extract_styleguide_response.rbs +20 -0
- data/sig/context_dev/models/web_screenshot_params.rbs +44 -5
- data/sig/context_dev/models/web_screenshot_response.rbs +20 -0
- data/sig/context_dev/models/web_search_params.rbs +88 -10
- data/sig/context_dev/models/web_search_response.rbs +33 -6
- data/sig/context_dev/models/web_web_crawl_md_params.rbs +44 -5
- data/sig/context_dev/models/web_web_crawl_md_response.rbs +10 -3
- data/sig/context_dev/models/web_web_scrape_bytes_params.rbs +531 -0
- data/sig/context_dev/models/web_web_scrape_bytes_response.rbs +108 -0
- data/sig/context_dev/models/web_web_scrape_html_params.rbs +44 -5
- data/sig/context_dev/models/web_web_scrape_html_response.rbs +16 -0
- data/sig/context_dev/models/web_web_scrape_images_params.rbs +44 -5
- data/sig/context_dev/models/web_web_scrape_images_response.rbs +30 -3
- data/sig/context_dev/models/web_web_scrape_md_params.rbs +44 -5
- data/sig/context_dev/models/web_web_scrape_md_response.rbs +16 -0
- data/sig/context_dev/models/web_web_scrape_sitemap_params.rbs +44 -5
- data/sig/context_dev/models/web_web_scrape_sitemap_response.rbs +10 -3
- data/sig/context_dev/models.rbs +4 -0
- data/sig/context_dev/resources/ai.rbs +1 -1
- data/sig/context_dev/resources/brand.rbs +1 -1
- data/sig/context_dev/resources/industry.rbs +2 -2
- data/sig/context_dev/resources/people.rbs +1 -1
- data/sig/context_dev/resources/utility.rbs +1 -1
- data/sig/context_dev/resources/web.rbs +30 -11
- metadata +14 -2
|
@@ -90,13 +90,13 @@ module ContextDev
|
|
|
90
90
|
# @return [Array<String>, nil]
|
|
91
91
|
optional :tags, ContextDev::Internal::Type::ArrayOf[String]
|
|
92
92
|
|
|
93
|
-
# @!attribute
|
|
94
|
-
# Optional
|
|
95
|
-
#
|
|
96
|
-
#
|
|
93
|
+
# @!attribute timeout_opts
|
|
94
|
+
# Optional request deadline and behavior on timeout. For GET requests, use
|
|
95
|
+
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
96
|
+
# timeoutOpts object.
|
|
97
97
|
#
|
|
98
|
-
# @return [
|
|
99
|
-
optional :
|
|
98
|
+
# @return [ContextDev::Models::WebWebScrapeHTMLParams::TimeoutOpts, nil]
|
|
99
|
+
optional :timeout_opts, -> { ContextDev::WebWebScrapeHTMLParams::TimeoutOpts }
|
|
100
100
|
|
|
101
101
|
# @!attribute use_main_content_only
|
|
102
102
|
# When true, return only the page's main content in the HTML response, excluding
|
|
@@ -107,8 +107,8 @@ module ContextDev
|
|
|
107
107
|
|
|
108
108
|
# @!attribute wait_for_ms
|
|
109
109
|
# Optional browser wait time in milliseconds after initial page load. Min: 0. Max:
|
|
110
|
-
# 30000 (30 seconds). When combined with
|
|
111
|
-
# waitForMs + 10000 ms; a shorter deadline is rejected with 400
|
|
110
|
+
# 30000 (30 seconds). When combined with timeoutOpts, timeoutOpts.milliseconds
|
|
111
|
+
# must be at least waitForMs + 10000 ms; a shorter deadline is rejected with 400
|
|
112
112
|
# TIMEOUT_TOO_SHORT_FOR_WAIT.
|
|
113
113
|
#
|
|
114
114
|
# @return [Integer, nil]
|
|
@@ -123,7 +123,7 @@ module ContextDev
|
|
|
123
123
|
# @return [Symbol, ContextDev::Models::WebWebScrapeHTMLParams::Zdr, nil]
|
|
124
124
|
optional :zdr, enum: -> { ContextDev::WebWebScrapeHTMLParams::Zdr }
|
|
125
125
|
|
|
126
|
-
# @!method initialize(url:, actions: nil, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, settle_animations: nil, tags: nil,
|
|
126
|
+
# @!method initialize(url:, actions: nil, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, settle_animations: nil, tags: nil, timeout_opts: nil, use_main_content_only: nil, wait_for_ms: nil, zdr: nil, request_options: {})
|
|
127
127
|
# Some parameter documentations has been truncated, see
|
|
128
128
|
# {ContextDev::Models::WebWebScrapeHTMLParams} for more details.
|
|
129
129
|
#
|
|
@@ -149,7 +149,7 @@ module ContextDev
|
|
|
149
149
|
#
|
|
150
150
|
# @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
|
|
151
151
|
#
|
|
152
|
-
# @param
|
|
152
|
+
# @param timeout_opts [ContextDev::Models::WebWebScrapeHTMLParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
|
|
153
153
|
#
|
|
154
154
|
# @param use_main_content_only [Boolean] When true, return only the page's main content in the HTML response, excluding h
|
|
155
155
|
#
|
|
@@ -568,6 +568,53 @@ module ContextDev
|
|
|
568
568
|
# @param start [Integer] First 1-based PDF page to parse. When omitted, parsing starts at the first page.
|
|
569
569
|
end
|
|
570
570
|
|
|
571
|
+
class TimeoutOpts < ContextDev::Internal::Type::BaseModel
|
|
572
|
+
# @!attribute milliseconds
|
|
573
|
+
# Request deadline in milliseconds. Maximum: 300000 (5 minutes).
|
|
574
|
+
#
|
|
575
|
+
# @return [Integer]
|
|
576
|
+
required :milliseconds, Integer
|
|
577
|
+
|
|
578
|
+
# @!attribute behavior
|
|
579
|
+
# What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
|
|
580
|
+
# credits. "return-partial" returns usable results collected so far; if none are
|
|
581
|
+
# available, the request still fails without charging credits. Partial results are
|
|
582
|
+
# not cached as complete results. "return-partial" requires milliseconds of at
|
|
583
|
+
# least 15000.
|
|
584
|
+
#
|
|
585
|
+
# @return [Symbol, ContextDev::Models::WebWebScrapeHTMLParams::TimeoutOpts::Behavior, nil]
|
|
586
|
+
optional :behavior, enum: -> { ContextDev::WebWebScrapeHTMLParams::TimeoutOpts::Behavior }
|
|
587
|
+
|
|
588
|
+
# @!method initialize(milliseconds:, behavior: nil)
|
|
589
|
+
# Some parameter documentations has been truncated, see
|
|
590
|
+
# {ContextDev::Models::WebWebScrapeHTMLParams::TimeoutOpts} for more details.
|
|
591
|
+
#
|
|
592
|
+
# Optional request deadline and behavior on timeout. For GET requests, use
|
|
593
|
+
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
594
|
+
# timeoutOpts object.
|
|
595
|
+
#
|
|
596
|
+
# @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
|
|
597
|
+
#
|
|
598
|
+
# @param behavior [Symbol, ContextDev::Models::WebWebScrapeHTMLParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
|
|
599
|
+
|
|
600
|
+
# What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
|
|
601
|
+
# credits. "return-partial" returns usable results collected so far; if none are
|
|
602
|
+
# available, the request still fails without charging credits. Partial results are
|
|
603
|
+
# not cached as complete results. "return-partial" requires milliseconds of at
|
|
604
|
+
# least 15000.
|
|
605
|
+
#
|
|
606
|
+
# @see ContextDev::Models::WebWebScrapeHTMLParams::TimeoutOpts#behavior
|
|
607
|
+
module Behavior
|
|
608
|
+
extend ContextDev::Internal::Type::Enum
|
|
609
|
+
|
|
610
|
+
FAIL = :fail
|
|
611
|
+
RETURN_PARTIAL = :"return-partial"
|
|
612
|
+
|
|
613
|
+
# @!method self.values
|
|
614
|
+
# @return [Array<Symbol>]
|
|
615
|
+
end
|
|
616
|
+
end
|
|
617
|
+
|
|
571
618
|
# Set to enabled to bypass shared caches and omit request and response content
|
|
572
619
|
# from retained usage logs. Requires zero data retention to be enabled for your
|
|
573
620
|
# organization (contact support@context.dev), otherwise the request fails with
|
|
@@ -12,6 +12,18 @@ module ContextDev
|
|
|
12
12
|
# @return [ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata]
|
|
13
13
|
required :cache_metadata, -> { ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata }
|
|
14
14
|
|
|
15
|
+
# @!attribute final_dom_state
|
|
16
|
+
# How complete the returned content is. `loaded` means the page finished the waits
|
|
17
|
+
# the request asked for. `still-loading` only occurs with
|
|
18
|
+
# timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
|
|
19
|
+
# reached first, so the content reflects the DOM at that moment and late-rendering
|
|
20
|
+
# parts may be missing. Partial results are billed at the base request cost.
|
|
21
|
+
#
|
|
22
|
+
# @return [Symbol, ContextDev::Models::WebWebScrapeHTMLResponse::FinalDomState]
|
|
23
|
+
required :final_dom_state,
|
|
24
|
+
enum: -> { ContextDev::Models::WebWebScrapeHTMLResponse::FinalDomState },
|
|
25
|
+
api_name: :finalDOMState
|
|
26
|
+
|
|
15
27
|
# @!attribute html
|
|
16
28
|
# The scraped content of the page. For normal pages this is the raw HTML. When the
|
|
17
29
|
# page is a sitemap or feed served behind an XSL stylesheet (which browsers render
|
|
@@ -75,12 +87,14 @@ module ContextDev
|
|
|
75
87
|
# @return [ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata, nil]
|
|
76
88
|
optional :key_metadata, -> { ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata }
|
|
77
89
|
|
|
78
|
-
# @!method initialize(cache_metadata:, html:, metadata:, request_id:, success:, type:, url:, actions_applied: nil, actions_html_stale: nil, key_metadata: nil)
|
|
90
|
+
# @!method initialize(cache_metadata:, final_dom_state:, html:, metadata:, request_id:, success:, type:, url:, actions_applied: nil, actions_html_stale: nil, key_metadata: nil)
|
|
79
91
|
# Some parameter documentations has been truncated, see
|
|
80
92
|
# {ContextDev::Models::WebWebScrapeHTMLResponse} for more details.
|
|
81
93
|
#
|
|
82
94
|
# @param cache_metadata [ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
|
|
83
95
|
#
|
|
96
|
+
# @param final_dom_state [Symbol, ContextDev::Models::WebWebScrapeHTMLResponse::FinalDomState] How complete the returned content is. `loaded` means the page finished the waits
|
|
97
|
+
#
|
|
84
98
|
# @param html [String] The scraped content of the page. For normal pages this is the raw HTML. When the
|
|
85
99
|
#
|
|
86
100
|
# @param metadata [ContextDev::Models::WebWebScrapeHTMLResponse::Metadata] Metadata extracted from the scraped page HTML.
|
|
@@ -142,6 +156,23 @@ module ContextDev
|
|
|
142
156
|
end
|
|
143
157
|
end
|
|
144
158
|
|
|
159
|
+
# How complete the returned content is. `loaded` means the page finished the waits
|
|
160
|
+
# the request asked for. `still-loading` only occurs with
|
|
161
|
+
# timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
|
|
162
|
+
# reached first, so the content reflects the DOM at that moment and late-rendering
|
|
163
|
+
# parts may be missing. Partial results are billed at the base request cost.
|
|
164
|
+
#
|
|
165
|
+
# @see ContextDev::Models::WebWebScrapeHTMLResponse#final_dom_state
|
|
166
|
+
module FinalDomState
|
|
167
|
+
extend ContextDev::Internal::Type::Enum
|
|
168
|
+
|
|
169
|
+
LOADED = :loaded
|
|
170
|
+
STILL_LOADING = :"still-loading"
|
|
171
|
+
|
|
172
|
+
# @!method self.values
|
|
173
|
+
# @return [Array<Symbol>]
|
|
174
|
+
end
|
|
175
|
+
|
|
145
176
|
# @see ContextDev::Models::WebWebScrapeHTMLResponse#metadata
|
|
146
177
|
class Metadata < ContextDev::Internal::Type::BaseModel
|
|
147
178
|
# @!attribute final_url
|
|
@@ -63,24 +63,24 @@ module ContextDev
|
|
|
63
63
|
# @return [Array<String>, nil]
|
|
64
64
|
optional :tags, ContextDev::Internal::Type::ArrayOf[String]
|
|
65
65
|
|
|
66
|
-
# @!attribute
|
|
67
|
-
# Optional
|
|
68
|
-
#
|
|
69
|
-
#
|
|
66
|
+
# @!attribute timeout_opts
|
|
67
|
+
# Optional request deadline and behavior on timeout. For GET requests, use
|
|
68
|
+
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
69
|
+
# timeoutOpts object.
|
|
70
70
|
#
|
|
71
|
-
# @return [
|
|
72
|
-
optional :
|
|
71
|
+
# @return [ContextDev::Models::WebWebScrapeImagesParams::TimeoutOpts, nil]
|
|
72
|
+
optional :timeout_opts, -> { ContextDev::WebWebScrapeImagesParams::TimeoutOpts }
|
|
73
73
|
|
|
74
74
|
# @!attribute wait_for_ms
|
|
75
75
|
# Optional browser wait time in milliseconds after initial page load before
|
|
76
76
|
# collecting images. Min: 0. Max: 30000 (30 seconds). When combined with
|
|
77
|
-
#
|
|
78
|
-
# is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
|
|
77
|
+
# timeoutOpts, timeoutOpts.milliseconds must be at least waitForMs + 10000 ms; a
|
|
78
|
+
# shorter deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
|
|
79
79
|
#
|
|
80
80
|
# @return [Integer, nil]
|
|
81
81
|
optional :wait_for_ms, Integer, nil?: true
|
|
82
82
|
|
|
83
|
-
# @!method initialize(url:, actions: nil, dedupe: nil, enrichment: nil, headers: nil, max_age_ms: nil, tags: nil,
|
|
83
|
+
# @!method initialize(url:, actions: nil, dedupe: nil, enrichment: nil, headers: nil, max_age_ms: nil, tags: nil, timeout_opts: nil, wait_for_ms: nil, request_options: {})
|
|
84
84
|
# Some parameter documentations has been truncated, see
|
|
85
85
|
# {ContextDev::Models::WebWebScrapeImagesParams} for more details.
|
|
86
86
|
#
|
|
@@ -98,7 +98,7 @@ module ContextDev
|
|
|
98
98
|
#
|
|
99
99
|
# @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
|
|
100
100
|
#
|
|
101
|
-
# @param
|
|
101
|
+
# @param timeout_opts [ContextDev::Models::WebWebScrapeImagesParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
|
|
102
102
|
#
|
|
103
103
|
# @param wait_for_ms [Integer, nil] Optional browser wait time in milliseconds after initial page load before collec
|
|
104
104
|
#
|
|
@@ -294,6 +294,53 @@ module ContextDev
|
|
|
294
294
|
#
|
|
295
295
|
# @param resolution [Boolean] Measure image width and height when possible.
|
|
296
296
|
end
|
|
297
|
+
|
|
298
|
+
class TimeoutOpts < ContextDev::Internal::Type::BaseModel
|
|
299
|
+
# @!attribute milliseconds
|
|
300
|
+
# Request deadline in milliseconds. Maximum: 300000 (5 minutes).
|
|
301
|
+
#
|
|
302
|
+
# @return [Integer]
|
|
303
|
+
required :milliseconds, Integer
|
|
304
|
+
|
|
305
|
+
# @!attribute behavior
|
|
306
|
+
# What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
|
|
307
|
+
# credits. "return-partial" returns usable results collected so far; if none are
|
|
308
|
+
# available, the request still fails without charging credits. Partial results are
|
|
309
|
+
# not cached as complete results. "return-partial" requires milliseconds of at
|
|
310
|
+
# least 15000.
|
|
311
|
+
#
|
|
312
|
+
# @return [Symbol, ContextDev::Models::WebWebScrapeImagesParams::TimeoutOpts::Behavior, nil]
|
|
313
|
+
optional :behavior, enum: -> { ContextDev::WebWebScrapeImagesParams::TimeoutOpts::Behavior }
|
|
314
|
+
|
|
315
|
+
# @!method initialize(milliseconds:, behavior: nil)
|
|
316
|
+
# Some parameter documentations has been truncated, see
|
|
317
|
+
# {ContextDev::Models::WebWebScrapeImagesParams::TimeoutOpts} for more details.
|
|
318
|
+
#
|
|
319
|
+
# Optional request deadline and behavior on timeout. For GET requests, use
|
|
320
|
+
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
321
|
+
# timeoutOpts object.
|
|
322
|
+
#
|
|
323
|
+
# @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
|
|
324
|
+
#
|
|
325
|
+
# @param behavior [Symbol, ContextDev::Models::WebWebScrapeImagesParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
|
|
326
|
+
|
|
327
|
+
# What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
|
|
328
|
+
# credits. "return-partial" returns usable results collected so far; if none are
|
|
329
|
+
# available, the request still fails without charging credits. Partial results are
|
|
330
|
+
# not cached as complete results. "return-partial" requires milliseconds of at
|
|
331
|
+
# least 15000.
|
|
332
|
+
#
|
|
333
|
+
# @see ContextDev::Models::WebWebScrapeImagesParams::TimeoutOpts#behavior
|
|
334
|
+
module Behavior
|
|
335
|
+
extend ContextDev::Internal::Type::Enum
|
|
336
|
+
|
|
337
|
+
FAIL = :fail
|
|
338
|
+
RETURN_PARTIAL = :"return-partial"
|
|
339
|
+
|
|
340
|
+
# @!method self.values
|
|
341
|
+
# @return [Array<Symbol>]
|
|
342
|
+
end
|
|
343
|
+
end
|
|
297
344
|
end
|
|
298
345
|
end
|
|
299
346
|
end
|
|
@@ -46,13 +46,33 @@ module ContextDev
|
|
|
46
46
|
-> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebWebScrapeImagesResponse::ActionsApplied] },
|
|
47
47
|
api_name: :actionsApplied
|
|
48
48
|
|
|
49
|
+
# @!attribute final_dom_state
|
|
50
|
+
# How complete the returned content is. `loaded` means the page finished the waits
|
|
51
|
+
# the request asked for. `still-loading` only occurs with
|
|
52
|
+
# timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
|
|
53
|
+
# reached first, so the content reflects the DOM at that moment and late-rendering
|
|
54
|
+
# parts may be missing. Partial results are billed at the base request cost.
|
|
55
|
+
#
|
|
56
|
+
# @return [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::FinalDomState, nil]
|
|
57
|
+
optional :final_dom_state,
|
|
58
|
+
enum: -> { ContextDev::Models::WebWebScrapeImagesResponse::FinalDomState },
|
|
59
|
+
api_name: :finalDOMState
|
|
60
|
+
|
|
49
61
|
# @!attribute key_metadata
|
|
50
62
|
# Credit usage, included whenever a valid API key is provided.
|
|
51
63
|
#
|
|
52
64
|
# @return [ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata, nil]
|
|
53
65
|
optional :key_metadata, -> { ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata }
|
|
54
66
|
|
|
55
|
-
# @!
|
|
67
|
+
# @!attribute partial
|
|
68
|
+
# True when the deadline interrupted rendering or image enrichment. Partial
|
|
69
|
+
# results are billed at the base request cost, without enrichment or actions
|
|
70
|
+
# surcharges.
|
|
71
|
+
#
|
|
72
|
+
# @return [Boolean, nil]
|
|
73
|
+
optional :partial, ContextDev::Internal::Type::Boolean
|
|
74
|
+
|
|
75
|
+
# @!method initialize(cache_metadata:, images:, request_id:, success:, url:, actions_applied: nil, final_dom_state: nil, key_metadata: nil, partial: nil)
|
|
56
76
|
# Some parameter documentations has been truncated, see
|
|
57
77
|
# {ContextDev::Models::WebWebScrapeImagesResponse} for more details.
|
|
58
78
|
#
|
|
@@ -68,7 +88,11 @@ module ContextDev
|
|
|
68
88
|
#
|
|
69
89
|
# @param actions_applied [Array<ContextDev::Models::WebWebScrapeImagesResponse::ActionsApplied>] One verified outcome per requested browser action, in request order.
|
|
70
90
|
#
|
|
91
|
+
# @param final_dom_state [Symbol, ContextDev::Models::WebWebScrapeImagesResponse::FinalDomState] How complete the returned content is. `loaded` means the page finished the waits
|
|
92
|
+
#
|
|
71
93
|
# @param key_metadata [ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
|
|
94
|
+
#
|
|
95
|
+
# @param partial [Boolean] True when the deadline interrupted rendering or image enrichment. Partial result
|
|
72
96
|
|
|
73
97
|
# @see ContextDev::Models::WebWebScrapeImagesResponse#cache_metadata
|
|
74
98
|
class CacheMetadata < ContextDev::Internal::Type::BaseModel
|
|
@@ -342,6 +366,23 @@ module ContextDev
|
|
|
342
366
|
end
|
|
343
367
|
end
|
|
344
368
|
|
|
369
|
+
# How complete the returned content is. `loaded` means the page finished the waits
|
|
370
|
+
# the request asked for. `still-loading` only occurs with
|
|
371
|
+
# timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
|
|
372
|
+
# reached first, so the content reflects the DOM at that moment and late-rendering
|
|
373
|
+
# parts may be missing. Partial results are billed at the base request cost.
|
|
374
|
+
#
|
|
375
|
+
# @see ContextDev::Models::WebWebScrapeImagesResponse#final_dom_state
|
|
376
|
+
module FinalDomState
|
|
377
|
+
extend ContextDev::Internal::Type::Enum
|
|
378
|
+
|
|
379
|
+
LOADED = :loaded
|
|
380
|
+
STILL_LOADING = :"still-loading"
|
|
381
|
+
|
|
382
|
+
# @!method self.values
|
|
383
|
+
# @return [Array<Symbol>]
|
|
384
|
+
end
|
|
385
|
+
|
|
345
386
|
# @see ContextDev::Models::WebWebScrapeImagesResponse#key_metadata
|
|
346
387
|
class KeyMetadata < ContextDev::Internal::Type::BaseModel
|
|
347
388
|
# @!attribute credits_consumed
|
|
@@ -117,13 +117,13 @@ module ContextDev
|
|
|
117
117
|
# @return [Array<String>, nil]
|
|
118
118
|
optional :tags, ContextDev::Internal::Type::ArrayOf[String]
|
|
119
119
|
|
|
120
|
-
# @!attribute
|
|
121
|
-
# Optional
|
|
122
|
-
#
|
|
123
|
-
#
|
|
120
|
+
# @!attribute timeout_opts
|
|
121
|
+
# Optional request deadline and behavior on timeout. For GET requests, use
|
|
122
|
+
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
123
|
+
# timeoutOpts object.
|
|
124
124
|
#
|
|
125
|
-
# @return [
|
|
126
|
-
optional :
|
|
125
|
+
# @return [ContextDev::Models::WebWebScrapeMdParams::TimeoutOpts, nil]
|
|
126
|
+
optional :timeout_opts, -> { ContextDev::WebWebScrapeMdParams::TimeoutOpts }
|
|
127
127
|
|
|
128
128
|
# @!attribute use_main_content_only
|
|
129
129
|
# Extract only the main content of the page, excluding headers, footers, sidebars,
|
|
@@ -135,8 +135,8 @@ module ContextDev
|
|
|
135
135
|
# @!attribute wait_for_ms
|
|
136
136
|
# Optional browser wait time in milliseconds after initial page load before
|
|
137
137
|
# converting the page to Markdown. Min: 0. Max: 30000 (30 seconds). When combined
|
|
138
|
-
# with
|
|
139
|
-
# deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
|
|
138
|
+
# with timeoutOpts, timeoutOpts.milliseconds must be at least waitForMs + 10000
|
|
139
|
+
# ms; a shorter deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
|
|
140
140
|
#
|
|
141
141
|
# @return [Integer, nil]
|
|
142
142
|
optional :wait_for_ms, Integer, nil?: true
|
|
@@ -150,7 +150,7 @@ module ContextDev
|
|
|
150
150
|
# @return [Symbol, ContextDev::Models::WebWebScrapeMdParams::Zdr, nil]
|
|
151
151
|
optional :zdr, enum: -> { ContextDev::WebWebScrapeMdParams::Zdr }
|
|
152
152
|
|
|
153
|
-
# @!method initialize(url:, actions: nil, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_html: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, settle_animations: nil, shorten_base64_images: nil, tags: nil,
|
|
153
|
+
# @!method initialize(url:, actions: nil, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_html: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, settle_animations: nil, shorten_base64_images: nil, tags: nil, timeout_opts: nil, use_main_content_only: nil, wait_for_ms: nil, zdr: nil, request_options: {})
|
|
154
154
|
# Some parameter documentations has been truncated, see
|
|
155
155
|
# {ContextDev::Models::WebWebScrapeMdParams} for more details.
|
|
156
156
|
#
|
|
@@ -184,7 +184,7 @@ module ContextDev
|
|
|
184
184
|
#
|
|
185
185
|
# @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
|
|
186
186
|
#
|
|
187
|
-
# @param
|
|
187
|
+
# @param timeout_opts [ContextDev::Models::WebWebScrapeMdParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
|
|
188
188
|
#
|
|
189
189
|
# @param use_main_content_only [Boolean] Extract only the main content of the page, excluding headers, footers, sidebars,
|
|
190
190
|
#
|
|
@@ -603,6 +603,53 @@ module ContextDev
|
|
|
603
603
|
# @param start [Integer] First 1-based PDF page to parse. When omitted, parsing starts at the first page.
|
|
604
604
|
end
|
|
605
605
|
|
|
606
|
+
class TimeoutOpts < ContextDev::Internal::Type::BaseModel
|
|
607
|
+
# @!attribute milliseconds
|
|
608
|
+
# Request deadline in milliseconds. Maximum: 300000 (5 minutes).
|
|
609
|
+
#
|
|
610
|
+
# @return [Integer]
|
|
611
|
+
required :milliseconds, Integer
|
|
612
|
+
|
|
613
|
+
# @!attribute behavior
|
|
614
|
+
# What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
|
|
615
|
+
# credits. "return-partial" returns usable results collected so far; if none are
|
|
616
|
+
# available, the request still fails without charging credits. Partial results are
|
|
617
|
+
# not cached as complete results. "return-partial" requires milliseconds of at
|
|
618
|
+
# least 15000.
|
|
619
|
+
#
|
|
620
|
+
# @return [Symbol, ContextDev::Models::WebWebScrapeMdParams::TimeoutOpts::Behavior, nil]
|
|
621
|
+
optional :behavior, enum: -> { ContextDev::WebWebScrapeMdParams::TimeoutOpts::Behavior }
|
|
622
|
+
|
|
623
|
+
# @!method initialize(milliseconds:, behavior: nil)
|
|
624
|
+
# Some parameter documentations has been truncated, see
|
|
625
|
+
# {ContextDev::Models::WebWebScrapeMdParams::TimeoutOpts} for more details.
|
|
626
|
+
#
|
|
627
|
+
# Optional request deadline and behavior on timeout. For GET requests, use
|
|
628
|
+
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
629
|
+
# timeoutOpts object.
|
|
630
|
+
#
|
|
631
|
+
# @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
|
|
632
|
+
#
|
|
633
|
+
# @param behavior [Symbol, ContextDev::Models::WebWebScrapeMdParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
|
|
634
|
+
|
|
635
|
+
# What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
|
|
636
|
+
# credits. "return-partial" returns usable results collected so far; if none are
|
|
637
|
+
# available, the request still fails without charging credits. Partial results are
|
|
638
|
+
# not cached as complete results. "return-partial" requires milliseconds of at
|
|
639
|
+
# least 15000.
|
|
640
|
+
#
|
|
641
|
+
# @see ContextDev::Models::WebWebScrapeMdParams::TimeoutOpts#behavior
|
|
642
|
+
module Behavior
|
|
643
|
+
extend ContextDev::Internal::Type::Enum
|
|
644
|
+
|
|
645
|
+
FAIL = :fail
|
|
646
|
+
RETURN_PARTIAL = :"return-partial"
|
|
647
|
+
|
|
648
|
+
# @!method self.values
|
|
649
|
+
# @return [Array<Symbol>]
|
|
650
|
+
end
|
|
651
|
+
end
|
|
652
|
+
|
|
606
653
|
# Set to enabled to bypass shared caches and omit request and response content
|
|
607
654
|
# from retained usage logs. Requires zero data retention to be enabled for your
|
|
608
655
|
# organization (contact support@context.dev), otherwise the request fails with
|
|
@@ -20,6 +20,18 @@ module ContextDev
|
|
|
20
20
|
# @return [Integer]
|
|
21
21
|
required :content_length, Integer, api_name: :contentLength
|
|
22
22
|
|
|
23
|
+
# @!attribute final_dom_state
|
|
24
|
+
# How complete the returned content is. `loaded` means the page finished the waits
|
|
25
|
+
# the request asked for. `still-loading` only occurs with
|
|
26
|
+
# timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
|
|
27
|
+
# reached first, so the content reflects the DOM at that moment and late-rendering
|
|
28
|
+
# parts may be missing. Partial results are billed at the base request cost.
|
|
29
|
+
#
|
|
30
|
+
# @return [Symbol, ContextDev::Models::WebWebScrapeMdResponse::FinalDomState]
|
|
31
|
+
required :final_dom_state,
|
|
32
|
+
enum: -> { ContextDev::Models::WebWebScrapeMdResponse::FinalDomState },
|
|
33
|
+
api_name: :finalDOMState
|
|
34
|
+
|
|
23
35
|
# @!attribute markdown
|
|
24
36
|
# Page content converted to GitHub Flavored Markdown
|
|
25
37
|
#
|
|
@@ -80,7 +92,7 @@ module ContextDev
|
|
|
80
92
|
# @return [ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata, nil]
|
|
81
93
|
optional :key_metadata, -> { ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata }
|
|
82
94
|
|
|
83
|
-
# @!method initialize(cache_metadata:, content_length:, markdown:, metadata:, request_id:, success:, url:, actions_applied: nil, actions_html_stale: nil, html: nil, key_metadata: nil)
|
|
95
|
+
# @!method initialize(cache_metadata:, content_length:, final_dom_state:, markdown:, metadata:, request_id:, success:, url:, actions_applied: nil, actions_html_stale: nil, html: nil, key_metadata: nil)
|
|
84
96
|
# Some parameter documentations has been truncated, see
|
|
85
97
|
# {ContextDev::Models::WebWebScrapeMdResponse} for more details.
|
|
86
98
|
#
|
|
@@ -88,6 +100,8 @@ module ContextDev
|
|
|
88
100
|
#
|
|
89
101
|
# @param content_length [Integer] UTF-8 byte length of the returned Markdown. Use 0 to identify an empty result an
|
|
90
102
|
#
|
|
103
|
+
# @param final_dom_state [Symbol, ContextDev::Models::WebWebScrapeMdResponse::FinalDomState] How complete the returned content is. `loaded` means the page finished the waits
|
|
104
|
+
#
|
|
91
105
|
# @param markdown [String] Page content converted to GitHub Flavored Markdown
|
|
92
106
|
#
|
|
93
107
|
# @param metadata [ContextDev::Models::WebWebScrapeMdResponse::Metadata] Metadata extracted from the scraped page HTML.
|
|
@@ -149,6 +163,23 @@ module ContextDev
|
|
|
149
163
|
end
|
|
150
164
|
end
|
|
151
165
|
|
|
166
|
+
# How complete the returned content is. `loaded` means the page finished the waits
|
|
167
|
+
# the request asked for. `still-loading` only occurs with
|
|
168
|
+
# timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
|
|
169
|
+
# reached first, so the content reflects the DOM at that moment and late-rendering
|
|
170
|
+
# parts may be missing. Partial results are billed at the base request cost.
|
|
171
|
+
#
|
|
172
|
+
# @see ContextDev::Models::WebWebScrapeMdResponse#final_dom_state
|
|
173
|
+
module FinalDomState
|
|
174
|
+
extend ContextDev::Internal::Type::Enum
|
|
175
|
+
|
|
176
|
+
LOADED = :loaded
|
|
177
|
+
STILL_LOADING = :"still-loading"
|
|
178
|
+
|
|
179
|
+
# @!method self.values
|
|
180
|
+
# @return [Array<Symbol>]
|
|
181
|
+
end
|
|
182
|
+
|
|
152
183
|
# @see ContextDev::Models::WebWebScrapeMdResponse#metadata
|
|
153
184
|
class Metadata < ContextDev::Internal::Type::BaseModel
|
|
154
185
|
# @!attribute final_url
|
|
@@ -57,13 +57,13 @@ module ContextDev
|
|
|
57
57
|
# @return [Array<String>, nil]
|
|
58
58
|
optional :tags, ContextDev::Internal::Type::ArrayOf[String]
|
|
59
59
|
|
|
60
|
-
# @!attribute
|
|
61
|
-
# Optional
|
|
62
|
-
#
|
|
63
|
-
#
|
|
60
|
+
# @!attribute timeout_opts
|
|
61
|
+
# Optional request deadline and behavior on timeout. For GET requests, use
|
|
62
|
+
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
63
|
+
# timeoutOpts object.
|
|
64
64
|
#
|
|
65
|
-
# @return [
|
|
66
|
-
optional :
|
|
65
|
+
# @return [ContextDev::Models::WebWebScrapeSitemapParams::TimeoutOpts, nil]
|
|
66
|
+
optional :timeout_opts, -> { ContextDev::WebWebScrapeSitemapParams::TimeoutOpts }
|
|
67
67
|
|
|
68
68
|
# @!attribute url_regex
|
|
69
69
|
# Optional RE2-compatible regex pattern. Only URLs matching this pattern are
|
|
@@ -81,7 +81,7 @@ module ContextDev
|
|
|
81
81
|
# @return [Symbol, ContextDev::Models::WebWebScrapeSitemapParams::Zdr, nil]
|
|
82
82
|
optional :zdr, enum: -> { ContextDev::WebWebScrapeSitemapParams::Zdr }
|
|
83
83
|
|
|
84
|
-
# @!method initialize(domain:, headers: nil, include_subdomains: nil, max_links: nil, search: nil, sitemap_url: nil, tags: nil,
|
|
84
|
+
# @!method initialize(domain:, headers: nil, include_subdomains: nil, max_links: nil, search: nil, sitemap_url: nil, tags: nil, timeout_opts: nil, url_regex: nil, zdr: nil, request_options: {})
|
|
85
85
|
# Some parameter documentations has been truncated, see
|
|
86
86
|
# {ContextDev::Models::WebWebScrapeSitemapParams} for more details.
|
|
87
87
|
#
|
|
@@ -99,7 +99,7 @@ module ContextDev
|
|
|
99
99
|
#
|
|
100
100
|
# @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
|
|
101
101
|
#
|
|
102
|
-
# @param
|
|
102
|
+
# @param timeout_opts [ContextDev::Models::WebWebScrapeSitemapParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
|
|
103
103
|
#
|
|
104
104
|
# @param url_regex [String] Optional RE2-compatible regex pattern. Only URLs matching this pattern are retur
|
|
105
105
|
#
|
|
@@ -107,6 +107,51 @@ module ContextDev
|
|
|
107
107
|
#
|
|
108
108
|
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
|
|
109
109
|
|
|
110
|
+
class TimeoutOpts < ContextDev::Internal::Type::BaseModel
|
|
111
|
+
# @!attribute milliseconds
|
|
112
|
+
# Request deadline in milliseconds. Maximum: 300000 (5 minutes).
|
|
113
|
+
#
|
|
114
|
+
# @return [Integer]
|
|
115
|
+
required :milliseconds, Integer
|
|
116
|
+
|
|
117
|
+
# @!attribute behavior
|
|
118
|
+
# What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
|
|
119
|
+
# credits. "return-partial" returns usable results collected so far; if none are
|
|
120
|
+
# available, the request still fails without charging credits. Partial results are
|
|
121
|
+
# not cached as complete results.
|
|
122
|
+
#
|
|
123
|
+
# @return [Symbol, ContextDev::Models::WebWebScrapeSitemapParams::TimeoutOpts::Behavior, nil]
|
|
124
|
+
optional :behavior, enum: -> { ContextDev::WebWebScrapeSitemapParams::TimeoutOpts::Behavior }
|
|
125
|
+
|
|
126
|
+
# @!method initialize(milliseconds:, behavior: nil)
|
|
127
|
+
# Some parameter documentations has been truncated, see
|
|
128
|
+
# {ContextDev::Models::WebWebScrapeSitemapParams::TimeoutOpts} for more details.
|
|
129
|
+
#
|
|
130
|
+
# Optional request deadline and behavior on timeout. For GET requests, use
|
|
131
|
+
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
132
|
+
# timeoutOpts object.
|
|
133
|
+
#
|
|
134
|
+
# @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
|
|
135
|
+
#
|
|
136
|
+
# @param behavior [Symbol, ContextDev::Models::WebWebScrapeSitemapParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
|
|
137
|
+
|
|
138
|
+
# What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
|
|
139
|
+
# credits. "return-partial" returns usable results collected so far; if none are
|
|
140
|
+
# available, the request still fails without charging credits. Partial results are
|
|
141
|
+
# not cached as complete results.
|
|
142
|
+
#
|
|
143
|
+
# @see ContextDev::Models::WebWebScrapeSitemapParams::TimeoutOpts#behavior
|
|
144
|
+
module Behavior
|
|
145
|
+
extend ContextDev::Internal::Type::Enum
|
|
146
|
+
|
|
147
|
+
FAIL = :fail
|
|
148
|
+
RETURN_PARTIAL = :"return-partial"
|
|
149
|
+
|
|
150
|
+
# @!method self.values
|
|
151
|
+
# @return [Array<Symbol>]
|
|
152
|
+
end
|
|
153
|
+
end
|
|
154
|
+
|
|
110
155
|
# Set to enabled to bypass shared caches and omit request and response content
|
|
111
156
|
# from retained usage logs. Requires zero data retention to be enabled for your
|
|
112
157
|
# organization (contact support@context.dev), otherwise the request fails with
|
|
@@ -42,7 +42,15 @@ module ContextDev
|
|
|
42
42
|
# @return [ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata, nil]
|
|
43
43
|
optional :key_metadata, -> { ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata }
|
|
44
44
|
|
|
45
|
-
# @!
|
|
45
|
+
# @!attribute partial
|
|
46
|
+
# True when timeoutOpts.behavior=return-partial returned the usable results
|
|
47
|
+
# collected before the deadline. Partial collections are not cached as complete
|
|
48
|
+
# results.
|
|
49
|
+
#
|
|
50
|
+
# @return [Boolean, nil]
|
|
51
|
+
optional :partial, ContextDev::Internal::Type::Boolean
|
|
52
|
+
|
|
53
|
+
# @!method initialize(domain:, meta:, request_id:, success:, urls:, key_metadata: nil, partial: nil)
|
|
46
54
|
# Some parameter documentations has been truncated, see
|
|
47
55
|
# {ContextDev::Models::WebWebScrapeSitemapResponse} for more details.
|
|
48
56
|
#
|
|
@@ -57,6 +65,8 @@ module ContextDev
|
|
|
57
65
|
# @param urls [Array<String>] Discovered page URLs from the sitemap, up to `maxLinks`. When `search` is set th
|
|
58
66
|
#
|
|
59
67
|
# @param key_metadata [ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
|
|
68
|
+
#
|
|
69
|
+
# @param partial [Boolean] True when timeoutOpts.behavior=return-partial returned the usable results collec
|
|
60
70
|
|
|
61
71
|
# @see ContextDev::Models::WebWebScrapeSitemapResponse#meta
|
|
62
72
|
class Meta < ContextDev::Internal::Type::BaseModel
|
data/lib/context_dev/models.rb
CHANGED
|
@@ -113,6 +113,8 @@ module ContextDev
|
|
|
113
113
|
|
|
114
114
|
UtilityPrefetchParams = ContextDev::Models::UtilityPrefetchParams
|
|
115
115
|
|
|
116
|
+
WebAnswersParams = ContextDev::Models::WebAnswersParams
|
|
117
|
+
|
|
116
118
|
WebExtractCompetitorsParams = ContextDev::Models::WebExtractCompetitorsParams
|
|
117
119
|
|
|
118
120
|
WebExtractFontsParams = ContextDev::Models::WebExtractFontsParams
|
|
@@ -131,6 +133,8 @@ module ContextDev
|
|
|
131
133
|
|
|
132
134
|
WebWebCrawlMdParams = ContextDev::Models::WebWebCrawlMdParams
|
|
133
135
|
|
|
136
|
+
WebWebScrapeBytesParams = ContextDev::Models::WebWebScrapeBytesParams
|
|
137
|
+
|
|
134
138
|
WebWebScrapeHTMLParams = ContextDev::Models::WebWebScrapeHTMLParams
|
|
135
139
|
|
|
136
140
|
WebWebScrapeImagesParams = ContextDev::Models::WebWebScrapeImagesParams
|
|
@@ -9,7 +9,7 @@ module ContextDev
|
|
|
9
9
|
# Given a single URL, determines if it is a product page and extracts the product
|
|
10
10
|
# information.
|
|
11
11
|
#
|
|
12
|
-
# @overload extract_product(url:, max_age_ms: nil, tags: nil,
|
|
12
|
+
# @overload extract_product(url:, max_age_ms: nil, tags: nil, timeout_opts: nil, request_options: {})
|
|
13
13
|
#
|
|
14
14
|
# @param url [String] The product page URL to extract product data from.
|
|
15
15
|
#
|
|
@@ -17,7 +17,7 @@ module ContextDev
|
|
|
17
17
|
#
|
|
18
18
|
# @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
|
|
19
19
|
#
|
|
20
|
-
# @param
|
|
20
|
+
# @param timeout_opts [ContextDev::Models::AIExtractProductParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
|
|
21
21
|
#
|
|
22
22
|
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
23
23
|
#
|