context.dev 2.21.0 → 2.22.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +24 -0
- data/README.md +1 -1
- data/lib/context_dev/client.rb +4 -9
- data/lib/context_dev/models/batch_cancel_params.rb +2 -2
- data/lib/context_dev/models/batch_cancel_response.rb +16 -21
- data/lib/context_dev/models/batch_delete_params.rb +2 -2
- data/lib/context_dev/models/batch_delete_response.rb +8 -8
- data/lib/context_dev/models/batch_get_results_params.rb +2 -2
- data/lib/context_dev/models/batch_get_results_response.rb +17 -22
- data/lib/context_dev/models/batch_list_response.rb +38 -47
- data/lib/context_dev/models/batch_retrieve_params.rb +2 -2
- data/lib/context_dev/models/batch_retrieve_response.rb +37 -46
- data/lib/context_dev/models/batch_submit_params.rb +80 -109
- data/lib/context_dev/models/batch_submit_response.rb +18 -28
- data/lib/context_dev/models/brand_retrieve_params.rb +90 -149
- data/lib/context_dev/models/brand_retrieve_response.rb +18 -22
- data/lib/context_dev/models/brand_search_params.rb +2 -3
- data/lib/context_dev/models/brand_search_response.rb +8 -8
- data/lib/context_dev/models/crawl_controls.rb +1 -2
- data/lib/context_dev/models/feedback_submit_params.rb +2 -2
- data/lib/context_dev/models/feedback_submit_response.rb +8 -8
- data/lib/context_dev/models/industry_retrieve_naics_params.rb +17 -32
- data/lib/context_dev/models/industry_retrieve_naics_response.rb +10 -10
- data/lib/context_dev/models/industry_retrieve_sic_params.rb +20 -39
- data/lib/context_dev/models/industry_retrieve_sic_response.rb +10 -10
- data/lib/context_dev/models/intake.rb +7 -13
- data/lib/context_dev/models/log_list_response.rb +14 -10
- data/lib/context_dev/models/log_retrieve_response.rb +15 -41
- data/lib/context_dev/models/monitor_create_params.rb +238 -72
- data/lib/context_dev/models/monitor_create_response.rb +364 -175
- data/lib/context_dev/models/monitor_delete_params.rb +3 -1
- data/lib/context_dev/models/monitor_delete_response.rb +44 -1
- data/lib/context_dev/models/monitor_get_credit_usage_response.rb +43 -1
- data/lib/context_dev/models/monitor_get_limits_response.rb +47 -7
- data/lib/context_dev/models/monitor_list_account_changes_response.rb +143 -20
- data/lib/context_dev/models/monitor_list_account_runs_response.rb +50 -8
- data/lib/context_dev/models/monitor_list_changes_params.rb +2 -1
- data/lib/context_dev/models/monitor_list_changes_response.rb +143 -20
- data/lib/context_dev/models/monitor_list_params.rb +3 -3
- data/lib/context_dev/models/monitor_list_response.rb +304 -106
- data/lib/context_dev/models/monitor_list_runs_params.rb +2 -1
- data/lib/context_dev/models/monitor_list_runs_response.rb +50 -8
- data/lib/context_dev/models/monitor_retrieve_change_params.rb +3 -1
- data/lib/context_dev/models/monitor_retrieve_change_response.rb +45 -15
- data/lib/context_dev/models/monitor_retrieve_params.rb +3 -1
- data/lib/context_dev/models/monitor_retrieve_response.rb +361 -171
- data/lib/context_dev/models/monitor_retrieve_run_params.rb +6 -2
- data/lib/context_dev/models/monitor_retrieve_run_response.rb +45 -8
- data/lib/context_dev/models/monitor_rotate_webhook_secret_params.rb +3 -1
- data/lib/context_dev/models/monitor_rotate_webhook_secret_response.rb +364 -172
- data/lib/context_dev/models/monitor_run_params.rb +3 -1
- data/lib/context_dev/models/monitor_run_response.rb +42 -4
- data/lib/context_dev/models/monitor_update_params.rb +239 -71
- data/lib/context_dev/models/monitor_update_response.rb +361 -171
- data/lib/context_dev/models/news_search_params.rb +10 -6
- data/lib/context_dev/models/news_search_response.rb +8 -8
- data/lib/context_dev/models/parse_handle_params.rb +9 -20
- data/lib/context_dev/models/parse_handle_response.rb +8 -8
- data/lib/context_dev/models/person_enrich_params.rb +76 -50
- data/lib/context_dev/models/person_enrich_response.rb +8 -8
- data/lib/context_dev/models/utility_prefetch_params.rb +15 -29
- data/lib/context_dev/models/utility_prefetch_response.rb +10 -10
- data/lib/context_dev/models/web_answers_params.rb +28 -47
- data/lib/context_dev/models/web_answers_response.rb +9 -8
- data/lib/context_dev/models/web_extract_competitors_params.rb +17 -32
- data/lib/context_dev/models/web_extract_competitors_response.rb +8 -8
- data/lib/context_dev/models/web_extract_styleguide_params.rb +22 -44
- data/lib/context_dev/models/web_extract_styleguide_response.rb +34 -44
- data/lib/context_dev/models/web_map_urls_params.rb +30 -51
- data/lib/context_dev/models/web_map_urls_response.rb +8 -8
- data/lib/context_dev/models/web_scrape_params.rb +193 -191
- data/lib/context_dev/models/web_scrape_response.rb +219 -95
- data/lib/context_dev/models/web_screenshot_params.rb +20 -39
- data/lib/context_dev/models/web_screenshot_response.rb +18 -28
- data/lib/context_dev/models/web_search_params.rb +76 -65
- data/lib/context_dev/models/web_search_response.rb +68 -27
- data/lib/context_dev/models/web_web_crawl_md_params.rb +41 -70
- data/lib/context_dev/models/web_web_crawl_md_response.rb +11 -15
- data/lib/context_dev/models/webhook_delivery.rb +3 -7
- data/lib/context_dev/models/webhooks/attempt.rb +3 -3
- data/lib/context_dev/models/webhooks/delivery.rb +16 -11
- data/lib/context_dev/models/webhooks/delivery_list_attempts_params.rb +2 -6
- data/lib/context_dev/models/webhooks/delivery_list_attempts_response.rb +8 -8
- data/lib/context_dev/models/webhooks/delivery_list_params.rb +4 -4
- data/lib/context_dev/models/webhooks/delivery_list_response.rb +8 -8
- data/lib/context_dev/models/webhooks/delivery_retrieve_params.rb +2 -6
- data/lib/context_dev/models/webhooks/delivery_retrieve_response.rb +8 -8
- data/lib/context_dev/models/webhooks/delivery_retry_params.rb +4 -4
- data/lib/context_dev/models/webhooks/delivery_retry_response.rb +8 -8
- data/lib/context_dev/models/webhooks/delivery_summary.rb +16 -11
- data/lib/context_dev/resources/batch.rb +17 -16
- data/lib/context_dev/resources/brand.rb +6 -8
- data/lib/context_dev/resources/feedback.rb +4 -5
- data/lib/context_dev/resources/industry.rb +9 -11
- data/lib/context_dev/resources/logs.rb +4 -5
- data/lib/context_dev/resources/monitors.rb +50 -53
- data/lib/context_dev/resources/news.rb +4 -8
- data/lib/context_dev/resources/parse.rb +4 -5
- data/lib/context_dev/resources/people.rb +11 -13
- data/lib/context_dev/resources/utility.rb +4 -11
- data/lib/context_dev/resources/web.rb +69 -94
- data/lib/context_dev/resources/webhooks/deliveries.rb +10 -18
- data/lib/context_dev/resources/webhooks.rb +1 -1
- data/lib/context_dev/version.rb +1 -1
- data/rbi/context_dev/client.rbi +4 -9
- data/rbi/context_dev/models/batch_cancel_params.rbi +2 -2
- data/rbi/context_dev/models/batch_cancel_response.rbi +17 -21
- data/rbi/context_dev/models/batch_delete_params.rbi +2 -2
- data/rbi/context_dev/models/batch_delete_response.rbi +9 -9
- data/rbi/context_dev/models/batch_get_results_params.rbi +2 -2
- data/rbi/context_dev/models/batch_get_results_response.rbi +18 -26
- data/rbi/context_dev/models/batch_list_response.rbi +41 -53
- data/rbi/context_dev/models/batch_retrieve_params.rbi +2 -2
- data/rbi/context_dev/models/batch_retrieve_response.rbi +40 -52
- data/rbi/context_dev/models/batch_submit_params.rbi +87 -147
- data/rbi/context_dev/models/batch_submit_response.rbi +19 -31
- data/rbi/context_dev/models/brand_retrieve_params.rbi +99 -190
- data/rbi/context_dev/models/brand_retrieve_response.rbi +19 -25
- data/rbi/context_dev/models/brand_search_params.rbi +2 -4
- data/rbi/context_dev/models/brand_search_response.rbi +9 -9
- data/rbi/context_dev/models/crawl_controls.rbi +1 -2
- data/rbi/context_dev/models/feedback_submit_params.rbi +2 -2
- data/rbi/context_dev/models/feedback_submit_response.rbi +9 -9
- data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +19 -42
- data/rbi/context_dev/models/industry_retrieve_naics_response.rbi +11 -11
- data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +22 -51
- data/rbi/context_dev/models/industry_retrieve_sic_response.rbi +11 -11
- data/rbi/context_dev/models/intake.rbi +7 -19
- data/rbi/context_dev/models/log_list_response.rbi +13 -11
- data/rbi/context_dev/models/log_retrieve_response.rbi +13 -76
- data/rbi/context_dev/models/monitor_create_params.rbi +418 -78
- data/rbi/context_dev/models/monitor_create_response.rbi +654 -287
- data/rbi/context_dev/models/monitor_delete_params.rbi +6 -1
- data/rbi/context_dev/models/monitor_delete_response.rbi +89 -3
- data/rbi/context_dev/models/monitor_get_credit_usage_response.rbi +77 -3
- data/rbi/context_dev/models/monitor_get_limits_response.rbi +83 -10
- data/rbi/context_dev/models/monitor_list_account_changes_response.rbi +236 -24
- data/rbi/context_dev/models/monitor_list_account_runs_response.rbi +86 -12
- data/rbi/context_dev/models/monitor_list_changes_params.rbi +2 -0
- data/rbi/context_dev/models/monitor_list_changes_response.rbi +234 -24
- data/rbi/context_dev/models/monitor_list_params.rbi +4 -4
- data/rbi/context_dev/models/monitor_list_response.rbi +502 -130
- data/rbi/context_dev/models/monitor_list_runs_params.rbi +2 -0
- data/rbi/context_dev/models/monitor_list_runs_response.rbi +84 -12
- data/rbi/context_dev/models/monitor_retrieve_change_params.rbi +6 -1
- data/rbi/context_dev/models/monitor_retrieve_change_response.rbi +79 -15
- data/rbi/context_dev/models/monitor_retrieve_params.rbi +6 -1
- data/rbi/context_dev/models/monitor_retrieve_response.rbi +654 -283
- data/rbi/context_dev/models/monitor_retrieve_run_params.rbi +9 -1
- data/rbi/context_dev/models/monitor_retrieve_run_response.rbi +77 -9
- data/rbi/context_dev/models/monitor_rotate_webhook_secret_params.rbi +6 -1
- data/rbi/context_dev/models/monitor_rotate_webhook_secret_response.rbi +659 -288
- data/rbi/context_dev/models/monitor_run_params.rbi +6 -1
- data/rbi/context_dev/models/monitor_run_response.rbi +82 -9
- data/rbi/context_dev/models/monitor_update_params.rbi +420 -75
- data/rbi/context_dev/models/monitor_update_response.rbi +650 -281
- data/rbi/context_dev/models/news_search_params.rbi +10 -2
- data/rbi/context_dev/models/news_search_response.rbi +9 -9
- data/rbi/context_dev/models/parse_handle_params.rbi +10 -29
- data/rbi/context_dev/models/parse_handle_response.rbi +9 -9
- data/rbi/context_dev/models/person_enrich_params.rbi +86 -44
- data/rbi/context_dev/models/person_enrich_response.rbi +9 -9
- data/rbi/context_dev/models/utility_prefetch_params.rbi +15 -27
- data/rbi/context_dev/models/utility_prefetch_response.rbi +11 -11
- data/rbi/context_dev/models/web_answers_params.rbi +33 -63
- data/rbi/context_dev/models/web_answers_response.rbi +11 -9
- data/rbi/context_dev/models/web_extract_competitors_params.rbi +19 -42
- data/rbi/context_dev/models/web_extract_competitors_response.rbi +9 -9
- data/rbi/context_dev/models/web_extract_styleguide_params.rbi +25 -61
- data/rbi/context_dev/models/web_extract_styleguide_response.rbi +36 -51
- data/rbi/context_dev/models/web_map_urls_params.rbi +33 -68
- data/rbi/context_dev/models/web_map_urls_response.rbi +9 -9
- data/rbi/context_dev/models/web_scrape_params.rbi +212 -206
- data/rbi/context_dev/models/web_scrape_response.rbi +296 -120
- data/rbi/context_dev/models/web_screenshot_params.rbi +22 -51
- data/rbi/context_dev/models/web_screenshot_response.rbi +20 -35
- data/rbi/context_dev/models/web_search_params.rbi +114 -82
- data/rbi/context_dev/models/web_search_response.rbi +145 -33
- data/rbi/context_dev/models/web_web_crawl_md_params.rbi +45 -95
- data/rbi/context_dev/models/web_web_crawl_md_response.rbi +12 -18
- data/rbi/context_dev/models/webhook_delivery.rbi +3 -9
- data/rbi/context_dev/models/webhooks/attempt.rbi +3 -3
- data/rbi/context_dev/models/webhooks/delivery.rbi +14 -11
- data/rbi/context_dev/models/webhooks/delivery_list_attempts_params.rbi +2 -4
- data/rbi/context_dev/models/webhooks/delivery_list_attempts_response.rbi +9 -9
- data/rbi/context_dev/models/webhooks/delivery_list_params.rbi +4 -4
- data/rbi/context_dev/models/webhooks/delivery_list_response.rbi +9 -9
- data/rbi/context_dev/models/webhooks/delivery_retrieve_params.rbi +2 -4
- data/rbi/context_dev/models/webhooks/delivery_retrieve_response.rbi +9 -9
- data/rbi/context_dev/models/webhooks/delivery_retry_params.rbi +4 -4
- data/rbi/context_dev/models/webhooks/delivery_retry_response.rbi +9 -9
- data/rbi/context_dev/models/webhooks/delivery_summary.rbi +14 -11
- data/rbi/context_dev/resources/batch.rbi +19 -18
- data/rbi/context_dev/resources/brand.rbi +6 -9
- data/rbi/context_dev/resources/feedback.rbi +4 -5
- data/rbi/context_dev/resources/industry.rbi +11 -27
- data/rbi/context_dev/resources/logs.rbi +4 -5
- data/rbi/context_dev/resources/monitors.rbi +71 -49
- data/rbi/context_dev/resources/news.rbi +4 -8
- data/rbi/context_dev/resources/parse.rbi +7 -14
- data/rbi/context_dev/resources/people.rbi +15 -13
- data/rbi/context_dev/resources/utility.rbi +4 -11
- data/rbi/context_dev/resources/web.rbi +89 -190
- data/rbi/context_dev/resources/webhooks/deliveries.rbi +10 -12
- data/rbi/context_dev/resources/webhooks.rbi +1 -1
- data/sig/context_dev/models/log_retrieve_response.rbs +0 -28
- data/sig/context_dev/models/monitor_create_params.rbs +113 -0
- data/sig/context_dev/models/monitor_create_response.rbs +203 -53
- data/sig/context_dev/models/monitor_delete_response.rbs +46 -3
- data/sig/context_dev/models/monitor_get_credit_usage_response.rbs +36 -3
- data/sig/context_dev/models/monitor_get_limits_response.rbs +36 -3
- data/sig/context_dev/models/monitor_list_account_changes_response.rbs +111 -8
- data/sig/context_dev/models/monitor_list_account_runs_response.rbs +36 -3
- data/sig/context_dev/models/monitor_list_changes_response.rbs +111 -8
- data/sig/context_dev/models/monitor_list_response.rbs +149 -3
- data/sig/context_dev/models/monitor_list_runs_response.rbs +36 -3
- data/sig/context_dev/models/monitor_retrieve_change_response.rbs +33 -0
- data/sig/context_dev/models/monitor_retrieve_response.rbs +203 -53
- data/sig/context_dev/models/monitor_retrieve_run_response.rbs +33 -0
- data/sig/context_dev/models/monitor_rotate_webhook_secret_response.rbs +203 -53
- data/sig/context_dev/models/monitor_run_response.rbs +48 -3
- data/sig/context_dev/models/monitor_update_params.rbs +113 -0
- data/sig/context_dev/models/monitor_update_response.rbs +203 -53
- data/sig/context_dev/models/web_scrape_response.rbs +204 -27
- data/sig/context_dev/models/web_search_params.rbs +25 -0
- data/sig/context_dev/models/web_search_response.rbs +48 -0
- data/sig/context_dev/resources/web.rbs +1 -0
- metadata +2 -2
|
@@ -25,8 +25,7 @@ module ContextDev
|
|
|
25
25
|
optional :color_scheme, enum: -> { ContextDev::WebScreenshotParams::ColorScheme }
|
|
26
26
|
|
|
27
27
|
# @!attribute country
|
|
28
|
-
# Fetch
|
|
29
|
-
# alpha-2).
|
|
28
|
+
# Fetch from this country (ISO 3166-1 alpha-2).
|
|
30
29
|
#
|
|
31
30
|
# @return [Symbol, ContextDev::Models::WebScreenshotParams::Country, nil]
|
|
32
31
|
optional :country, enum: -> { ContextDev::WebScreenshotParams::Country }
|
|
@@ -105,16 +104,13 @@ module ContextDev
|
|
|
105
104
|
optional :scroll_offset, Integer, nil?: true
|
|
106
105
|
|
|
107
106
|
# @!attribute tags
|
|
108
|
-
# Comma-separated
|
|
109
|
-
# characters.
|
|
107
|
+
# Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
|
|
110
108
|
#
|
|
111
109
|
# @return [Array<String>, nil]
|
|
112
110
|
optional :tags, ContextDev::Internal::Type::ArrayOf[String]
|
|
113
111
|
|
|
114
112
|
# @!attribute timeout_opts
|
|
115
|
-
#
|
|
116
|
-
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
117
|
-
# timeoutOpts object.
|
|
113
|
+
# Request deadline and what to return when it passes.
|
|
118
114
|
#
|
|
119
115
|
# @return [ContextDev::Models::WebScreenshotParams::TimeoutOpts, nil]
|
|
120
116
|
optional :timeout_opts, -> { ContextDev::WebScreenshotParams::TimeoutOpts }
|
|
@@ -136,11 +132,8 @@ module ContextDev
|
|
|
136
132
|
optional :wait_for_ms, Integer, nil?: true
|
|
137
133
|
|
|
138
134
|
# @!attribute zdr
|
|
139
|
-
#
|
|
140
|
-
#
|
|
141
|
-
# omitted. Requires zero data retention to be enabled for your organization
|
|
142
|
-
# (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
|
|
143
|
-
# Successful ZDR responses include X-Context-ZDR: true.
|
|
135
|
+
# `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
|
|
136
|
+
# your organization has ZDR.
|
|
144
137
|
#
|
|
145
138
|
# @return [Symbol, ContextDev::Models::WebScreenshotParams::Zdr, nil]
|
|
146
139
|
optional :zdr, enum: -> { ContextDev::WebScreenshotParams::Zdr }
|
|
@@ -153,7 +146,7 @@ module ContextDev
|
|
|
153
146
|
#
|
|
154
147
|
# @param color_scheme [Symbol, ContextDev::Models::WebScreenshotParams::ColorScheme] Optional parameter to choose the site's visual theme in the screenshot. Use 'lig
|
|
155
148
|
#
|
|
156
|
-
# @param country [Symbol, ContextDev::Models::WebScreenshotParams::Country] Fetch
|
|
149
|
+
# @param country [Symbol, ContextDev::Models::WebScreenshotParams::Country] Fetch from this country (ISO 3166-1 alpha-2).
|
|
157
150
|
#
|
|
158
151
|
# @param direct_url [String] A specific URL to screenshot directly, bypassing domain resolution (e.g., 'https
|
|
159
152
|
#
|
|
@@ -171,15 +164,15 @@ module ContextDev
|
|
|
171
164
|
#
|
|
172
165
|
# @param scroll_offset [Integer, nil] Optional vertical scroll offset in pixels for capturing a long page in viewport-
|
|
173
166
|
#
|
|
174
|
-
# @param tags [Array<String>] Comma-separated
|
|
167
|
+
# @param tags [Array<String>] Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
|
|
175
168
|
#
|
|
176
|
-
# @param timeout_opts [ContextDev::Models::WebScreenshotParams::TimeoutOpts]
|
|
169
|
+
# @param timeout_opts [ContextDev::Models::WebScreenshotParams::TimeoutOpts] Request deadline and what to return when it passes.
|
|
177
170
|
#
|
|
178
171
|
# @param viewport [ContextDev::Models::WebScreenshotParams::Viewport] Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080.
|
|
179
172
|
#
|
|
180
173
|
# @param wait_for_ms [Integer, nil] Optional browser wait time in milliseconds after initial page load before taking
|
|
181
174
|
#
|
|
182
|
-
# @param zdr [Symbol, ContextDev::Models::WebScreenshotParams::Zdr]
|
|
175
|
+
# @param zdr [Symbol, ContextDev::Models::WebScreenshotParams::Zdr] `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless you
|
|
183
176
|
#
|
|
184
177
|
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
|
|
185
178
|
|
|
@@ -195,8 +188,7 @@ module ContextDev
|
|
|
195
188
|
# @return [Array<Symbol>]
|
|
196
189
|
end
|
|
197
190
|
|
|
198
|
-
# Fetch
|
|
199
|
-
# alpha-2).
|
|
191
|
+
# Fetch from this country (ISO 3166-1 alpha-2).
|
|
200
192
|
module Country
|
|
201
193
|
extend ContextDev::Internal::Type::Enum
|
|
202
194
|
|
|
@@ -445,17 +437,14 @@ module ContextDev
|
|
|
445
437
|
|
|
446
438
|
class TimeoutOpts < ContextDev::Internal::Type::BaseModel
|
|
447
439
|
# @!attribute milliseconds
|
|
448
|
-
#
|
|
440
|
+
# Deadline in milliseconds.
|
|
449
441
|
#
|
|
450
442
|
# @return [Integer]
|
|
451
443
|
required :milliseconds, Integer
|
|
452
444
|
|
|
453
445
|
# @!attribute behavior
|
|
454
|
-
#
|
|
455
|
-
#
|
|
456
|
-
# available, the request still fails without charging credits. Partial results are
|
|
457
|
-
# not cached as complete results. "return-partial" requires milliseconds of at
|
|
458
|
-
# least 5000.
|
|
446
|
+
# "fail" returns 408 at the deadline. "return-partial" returns available results;
|
|
447
|
+
# inspect the response’s partial flag. "return-partial" requires at least 5000 ms.
|
|
459
448
|
#
|
|
460
449
|
# @return [Symbol, ContextDev::Models::WebScreenshotParams::TimeoutOpts::Behavior, nil]
|
|
461
450
|
optional :behavior, enum: -> { ContextDev::WebScreenshotParams::TimeoutOpts::Behavior }
|
|
@@ -464,19 +453,14 @@ module ContextDev
|
|
|
464
453
|
# Some parameter documentations has been truncated, see
|
|
465
454
|
# {ContextDev::Models::WebScreenshotParams::TimeoutOpts} for more details.
|
|
466
455
|
#
|
|
467
|
-
#
|
|
468
|
-
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
469
|
-
# timeoutOpts object.
|
|
456
|
+
# Request deadline and what to return when it passes.
|
|
470
457
|
#
|
|
471
|
-
# @param milliseconds [Integer]
|
|
458
|
+
# @param milliseconds [Integer] Deadline in milliseconds.
|
|
472
459
|
#
|
|
473
|
-
# @param behavior [Symbol, ContextDev::Models::WebScreenshotParams::TimeoutOpts::Behavior]
|
|
460
|
+
# @param behavior [Symbol, ContextDev::Models::WebScreenshotParams::TimeoutOpts::Behavior] "fail" returns 408 at the deadline. "return-partial" returns available results;
|
|
474
461
|
|
|
475
|
-
#
|
|
476
|
-
#
|
|
477
|
-
# available, the request still fails without charging credits. Partial results are
|
|
478
|
-
# not cached as complete results. "return-partial" requires milliseconds of at
|
|
479
|
-
# least 5000.
|
|
462
|
+
# "fail" returns 408 at the deadline. "return-partial" returns available results;
|
|
463
|
+
# inspect the response’s partial flag. "return-partial" requires at least 5000 ms.
|
|
480
464
|
#
|
|
481
465
|
# @see ContextDev::Models::WebScreenshotParams::TimeoutOpts#behavior
|
|
482
466
|
module Behavior
|
|
@@ -511,11 +495,8 @@ module ContextDev
|
|
|
511
495
|
# @param width [Integer] Viewport width in pixels.
|
|
512
496
|
end
|
|
513
497
|
|
|
514
|
-
#
|
|
515
|
-
#
|
|
516
|
-
# omitted. Requires zero data retention to be enabled for your organization
|
|
517
|
-
# (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
|
|
518
|
-
# Successful ZDR responses include X-Context-ZDR: true.
|
|
498
|
+
# `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
|
|
499
|
+
# your organization has ZDR.
|
|
519
500
|
module Zdr
|
|
520
501
|
extend ContextDev::Internal::Type::Enum
|
|
521
502
|
|
|
@@ -5,16 +5,14 @@ module ContextDev
|
|
|
5
5
|
# @see ContextDev::Resources::Web#screenshot
|
|
6
6
|
class WebScreenshotResponse < ContextDev::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute cache_metadata
|
|
8
|
-
#
|
|
9
|
-
# cache-controlled fetch contributing to the output was a hit; age_ms is the
|
|
10
|
-
# oldest contributing hit.
|
|
8
|
+
# Whether this response came from cache.
|
|
11
9
|
#
|
|
12
10
|
# @return [ContextDev::Models::WebScreenshotResponse::CacheMetadata]
|
|
13
11
|
required :cache_metadata, -> { ContextDev::Models::WebScreenshotResponse::CacheMetadata }
|
|
14
12
|
|
|
15
13
|
# @!attribute request_id
|
|
16
|
-
# Unique
|
|
17
|
-
#
|
|
14
|
+
# Unique ID of this request, also in `X-Request-Id`. Include it when contacting
|
|
15
|
+
# support.
|
|
18
16
|
#
|
|
19
17
|
# @return [String]
|
|
20
18
|
required :request_id, String
|
|
@@ -32,11 +30,8 @@ module ContextDev
|
|
|
32
30
|
optional :domain, String
|
|
33
31
|
|
|
34
32
|
# @!attribute final_dom_state
|
|
35
|
-
#
|
|
36
|
-
#
|
|
37
|
-
# timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
|
|
38
|
-
# reached first, so the content reflects the DOM at that moment and late-rendering
|
|
39
|
-
# parts may be missing. Partial results are billed at the base request cost.
|
|
33
|
+
# `loaded`, or `still-loading` when capture ended before the page finished
|
|
34
|
+
# loading.
|
|
40
35
|
#
|
|
41
36
|
# @return [Symbol, ContextDev::Models::WebScreenshotResponse::FinalDomState, nil]
|
|
42
37
|
optional :final_dom_state,
|
|
@@ -50,7 +45,7 @@ module ContextDev
|
|
|
50
45
|
optional :height, Integer
|
|
51
46
|
|
|
52
47
|
# @!attribute key_metadata
|
|
53
|
-
#
|
|
48
|
+
# Credits this request used and your remaining balance.
|
|
54
49
|
#
|
|
55
50
|
# @return [ContextDev::Models::WebScreenshotResponse::KeyMetadata, nil]
|
|
56
51
|
optional :key_metadata, -> { ContextDev::Models::WebScreenshotResponse::KeyMetadata }
|
|
@@ -71,7 +66,7 @@ module ContextDev
|
|
|
71
66
|
api_name: :screenshotType
|
|
72
67
|
|
|
73
68
|
# @!attribute status
|
|
74
|
-
#
|
|
69
|
+
# Always `ok` on success.
|
|
75
70
|
#
|
|
76
71
|
# @return [String, nil]
|
|
77
72
|
optional :status, String
|
|
@@ -86,25 +81,25 @@ module ContextDev
|
|
|
86
81
|
# Some parameter documentations has been truncated, see
|
|
87
82
|
# {ContextDev::Models::WebScreenshotResponse} for more details.
|
|
88
83
|
#
|
|
89
|
-
# @param cache_metadata [ContextDev::Models::WebScreenshotResponse::CacheMetadata]
|
|
84
|
+
# @param cache_metadata [ContextDev::Models::WebScreenshotResponse::CacheMetadata] Whether this response came from cache.
|
|
90
85
|
#
|
|
91
|
-
# @param request_id [String] Unique
|
|
86
|
+
# @param request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
|
|
92
87
|
#
|
|
93
88
|
# @param code [Integer] HTTP status code
|
|
94
89
|
#
|
|
95
90
|
# @param domain [String] The normalized domain that was processed
|
|
96
91
|
#
|
|
97
|
-
# @param final_dom_state [Symbol, ContextDev::Models::WebScreenshotResponse::FinalDomState]
|
|
92
|
+
# @param final_dom_state [Symbol, ContextDev::Models::WebScreenshotResponse::FinalDomState] `loaded`, or `still-loading` when capture ended before the page finished loading
|
|
98
93
|
#
|
|
99
94
|
# @param height [Integer] Height in pixels of the returned screenshot image
|
|
100
95
|
#
|
|
101
|
-
# @param key_metadata [ContextDev::Models::WebScreenshotResponse::KeyMetadata]
|
|
96
|
+
# @param key_metadata [ContextDev::Models::WebScreenshotResponse::KeyMetadata] Credits this request used and your remaining balance.
|
|
102
97
|
#
|
|
103
98
|
# @param screenshot [String] Public image URL for standard requests, or an in-memory data URL when ZDR or non
|
|
104
99
|
#
|
|
105
100
|
# @param screenshot_type [Symbol, ContextDev::Models::WebScreenshotResponse::ScreenshotType] Type of screenshot that was captured
|
|
106
101
|
#
|
|
107
|
-
# @param status [String]
|
|
102
|
+
# @param status [String] Always `ok` on success.
|
|
108
103
|
#
|
|
109
104
|
# @param width [Integer] Width in pixels of the returned screenshot image
|
|
110
105
|
|
|
@@ -127,9 +122,7 @@ module ContextDev
|
|
|
127
122
|
# Some parameter documentations has been truncated, see
|
|
128
123
|
# {ContextDev::Models::WebScreenshotResponse::CacheMetadata} for more details.
|
|
129
124
|
#
|
|
130
|
-
#
|
|
131
|
-
# cache-controlled fetch contributing to the output was a hit; age_ms is the
|
|
132
|
-
# oldest contributing hit.
|
|
125
|
+
# Whether this response came from cache.
|
|
133
126
|
#
|
|
134
127
|
# @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
|
|
135
128
|
#
|
|
@@ -151,11 +144,8 @@ module ContextDev
|
|
|
151
144
|
end
|
|
152
145
|
end
|
|
153
146
|
|
|
154
|
-
#
|
|
155
|
-
#
|
|
156
|
-
# timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
|
|
157
|
-
# reached first, so the content reflects the DOM at that moment and late-rendering
|
|
158
|
-
# parts may be missing. Partial results are billed at the base request cost.
|
|
147
|
+
# `loaded`, or `still-loading` when capture ended before the page finished
|
|
148
|
+
# loading.
|
|
159
149
|
#
|
|
160
150
|
# @see ContextDev::Models::WebScreenshotResponse#final_dom_state
|
|
161
151
|
module FinalDomState
|
|
@@ -171,7 +161,7 @@ module ContextDev
|
|
|
171
161
|
# @see ContextDev::Models::WebScreenshotResponse#key_metadata
|
|
172
162
|
class KeyMetadata < ContextDev::Internal::Type::BaseModel
|
|
173
163
|
# @!attribute credits_consumed
|
|
174
|
-
# Credits
|
|
164
|
+
# Credits charged for this request.
|
|
175
165
|
#
|
|
176
166
|
# @return [Integer]
|
|
177
167
|
required :credits_consumed, Integer
|
|
@@ -183,9 +173,9 @@ module ContextDev
|
|
|
183
173
|
required :credits_remaining, Integer
|
|
184
174
|
|
|
185
175
|
# @!method initialize(credits_consumed:, credits_remaining:)
|
|
186
|
-
#
|
|
176
|
+
# Credits this request used and your remaining balance.
|
|
187
177
|
#
|
|
188
|
-
# @param credits_consumed [Integer] Credits
|
|
178
|
+
# @param credits_consumed [Integer] Credits charged for this request.
|
|
189
179
|
#
|
|
190
180
|
# @param credits_remaining [Integer] Credits remaining for your organization.
|
|
191
181
|
end
|
|
@@ -22,8 +22,8 @@ module ContextDev
|
|
|
22
22
|
optional :country, enum: -> { ContextDev::WebSearchParams::Country }
|
|
23
23
|
|
|
24
24
|
# @!attribute exclude_domains
|
|
25
|
-
# Blocklist — drop results from these domains. Example:
|
|
26
|
-
# "reddit.com"].
|
|
25
|
+
# Blocklist — drop results from these domains. Up to 100 domains. Example:
|
|
26
|
+
# ["pinterest.com", "reddit.com"].
|
|
27
27
|
#
|
|
28
28
|
# @return [Array<String>, nil]
|
|
29
29
|
optional :exclude_domains, ContextDev::Internal::Type::ArrayOf[String], api_name: :excludeDomains
|
|
@@ -34,9 +34,18 @@ module ContextDev
|
|
|
34
34
|
# @return [Symbol, ContextDev::Models::WebSearchParams::Freshness, nil]
|
|
35
35
|
optional :freshness, enum: -> { ContextDev::WebSearchParams::Freshness }
|
|
36
36
|
|
|
37
|
+
# @!attribute highlights_options
|
|
38
|
+
# Passages from each result page that are relevant to the query. Pages are read
|
|
39
|
+
# with the `markdownOptions` settings.
|
|
40
|
+
#
|
|
41
|
+
# @return [ContextDev::Models::WebSearchParams::HighlightsOptions, nil]
|
|
42
|
+
optional :highlights_options,
|
|
43
|
+
-> { ContextDev::WebSearchParams::HighlightsOptions },
|
|
44
|
+
api_name: :highlightsOptions
|
|
45
|
+
|
|
37
46
|
# @!attribute include_domains
|
|
38
|
-
# Allowlist — only return results from these domains. Example:
|
|
39
|
-
# "github.com"].
|
|
47
|
+
# Allowlist — only return results from these domains. Up to 100 domains. Example:
|
|
48
|
+
# ["arxiv.org", "github.com"].
|
|
40
49
|
#
|
|
41
50
|
# @return [Array<String>, nil]
|
|
42
51
|
optional :include_domains, ContextDev::Internal::Type::ArrayOf[String], api_name: :includeDomains
|
|
@@ -56,36 +65,31 @@ module ContextDev
|
|
|
56
65
|
optional :num_results, Integer, api_name: :numResults
|
|
57
66
|
|
|
58
67
|
# @!attribute query_fanout
|
|
59
|
-
#
|
|
68
|
+
# Currently has no effect.
|
|
60
69
|
#
|
|
61
70
|
# @return [Boolean, nil]
|
|
62
71
|
optional :query_fanout, ContextDev::Internal::Type::Boolean, api_name: :queryFanout
|
|
63
72
|
|
|
64
73
|
# @!attribute tags
|
|
65
|
-
#
|
|
74
|
+
# Labels for filtering usage in the dashboard.
|
|
66
75
|
#
|
|
67
76
|
# @return [Array<String>, nil]
|
|
68
77
|
optional :tags, ContextDev::Internal::Type::ArrayOf[String]
|
|
69
78
|
|
|
70
79
|
# @!attribute timeout_opts
|
|
71
|
-
#
|
|
72
|
-
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
73
|
-
# timeoutOpts object.
|
|
80
|
+
# Request deadline and what to return when it passes.
|
|
74
81
|
#
|
|
75
82
|
# @return [ContextDev::Models::WebSearchParams::TimeoutOpts, nil]
|
|
76
83
|
optional :timeout_opts, -> { ContextDev::WebSearchParams::TimeoutOpts }, api_name: :timeoutOpts
|
|
77
84
|
|
|
78
85
|
# @!attribute zdr
|
|
79
|
-
#
|
|
80
|
-
#
|
|
81
|
-
# omitted. Requires zero data retention to be enabled for your organization
|
|
82
|
-
# (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
|
|
83
|
-
# Successful ZDR responses include X-Context-ZDR: true.
|
|
86
|
+
# `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
|
|
87
|
+
# your organization has ZDR.
|
|
84
88
|
#
|
|
85
89
|
# @return [Symbol, ContextDev::Models::WebSearchParams::Zdr, nil]
|
|
86
90
|
optional :zdr, enum: -> { ContextDev::WebSearchParams::Zdr }
|
|
87
91
|
|
|
88
|
-
# @!method initialize(query:, country: nil, exclude_domains: nil, freshness: nil, include_domains: nil, markdown_options: nil, num_results: nil, query_fanout: nil, tags: nil, timeout_opts: nil, zdr: nil, request_options: {})
|
|
92
|
+
# @!method initialize(query:, country: nil, exclude_domains: nil, freshness: nil, highlights_options: nil, include_domains: nil, markdown_options: nil, num_results: nil, query_fanout: nil, tags: nil, timeout_opts: nil, zdr: nil, request_options: {})
|
|
89
93
|
# Some parameter documentations has been truncated, see
|
|
90
94
|
# {ContextDev::Models::WebSearchParams} for more details.
|
|
91
95
|
#
|
|
@@ -93,23 +97,25 @@ module ContextDev
|
|
|
93
97
|
#
|
|
94
98
|
# @param country [Symbol, ContextDev::Models::WebSearchParams::Country] Two-letter ISO 3166-1 alpha-2 country code to localize results to a specific cou
|
|
95
99
|
#
|
|
96
|
-
# @param exclude_domains [Array<String>] Blocklist — drop results from these domains. Example: ["
|
|
100
|
+
# @param exclude_domains [Array<String>] Blocklist — drop results from these domains. Up to 100 domains. Example: ["pinte
|
|
97
101
|
#
|
|
98
102
|
# @param freshness [Symbol, ContextDev::Models::WebSearchParams::Freshness] Restrict results to content published within this window.
|
|
99
103
|
#
|
|
100
|
-
# @param
|
|
104
|
+
# @param highlights_options [ContextDev::Models::WebSearchParams::HighlightsOptions] Passages from each result page that are relevant to the query. Pages are read wi
|
|
105
|
+
#
|
|
106
|
+
# @param include_domains [Array<String>] Allowlist — only return results from these domains. Up to 100 domains. Example:
|
|
101
107
|
#
|
|
102
108
|
# @param markdown_options [ContextDev::Models::WebSearchParams::MarkdownOptions] Inline Markdown scraping for each result. Set `enabled: true` to activate.
|
|
103
109
|
#
|
|
104
110
|
# @param num_results [Integer] Number of results to request and return (10–100). Defaults to 10.
|
|
105
111
|
#
|
|
106
|
-
# @param query_fanout [Boolean]
|
|
112
|
+
# @param query_fanout [Boolean] Currently has no effect.
|
|
107
113
|
#
|
|
108
|
-
# @param tags [Array<String>]
|
|
114
|
+
# @param tags [Array<String>] Labels for filtering usage in the dashboard.
|
|
109
115
|
#
|
|
110
|
-
# @param timeout_opts [ContextDev::Models::WebSearchParams::TimeoutOpts]
|
|
116
|
+
# @param timeout_opts [ContextDev::Models::WebSearchParams::TimeoutOpts] Request deadline and what to return when it passes.
|
|
111
117
|
#
|
|
112
|
-
# @param zdr [Symbol, ContextDev::Models::WebSearchParams::Zdr]
|
|
118
|
+
# @param zdr [Symbol, ContextDev::Models::WebSearchParams::Zdr] `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless you
|
|
113
119
|
#
|
|
114
120
|
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
|
|
115
121
|
|
|
@@ -375,9 +381,31 @@ module ContextDev
|
|
|
375
381
|
# @return [Array<Symbol>]
|
|
376
382
|
end
|
|
377
383
|
|
|
384
|
+
class HighlightsOptions < ContextDev::Internal::Type::BaseModel
|
|
385
|
+
# @!attribute enabled
|
|
386
|
+
# Return relevant passages for each result. Adds 1 credit per 10 results.
|
|
387
|
+
#
|
|
388
|
+
# @return [Boolean, nil]
|
|
389
|
+
optional :enabled, ContextDev::Internal::Type::Boolean
|
|
390
|
+
|
|
391
|
+
# @!attribute max_characters
|
|
392
|
+
# Maximum combined length of passages per result.
|
|
393
|
+
#
|
|
394
|
+
# @return [Integer, nil]
|
|
395
|
+
optional :max_characters, Integer, api_name: :maxCharacters
|
|
396
|
+
|
|
397
|
+
# @!method initialize(enabled: nil, max_characters: nil)
|
|
398
|
+
# Passages from each result page that are relevant to the query. Pages are read
|
|
399
|
+
# with the `markdownOptions` settings.
|
|
400
|
+
#
|
|
401
|
+
# @param enabled [Boolean] Return relevant passages for each result. Adds 1 credit per 10 results.
|
|
402
|
+
#
|
|
403
|
+
# @param max_characters [Integer] Maximum combined length of passages per result.
|
|
404
|
+
end
|
|
405
|
+
|
|
378
406
|
class MarkdownOptions < ContextDev::Internal::Type::BaseModel
|
|
379
407
|
# @!attribute enabled
|
|
380
|
-
# Scrape each result to Markdown.
|
|
408
|
+
# Scrape each result to Markdown. Adds 1 credit per 10 results.
|
|
381
409
|
#
|
|
382
410
|
# @return [Boolean, nil]
|
|
383
411
|
optional :enabled, ContextDev::Internal::Type::Boolean
|
|
@@ -401,8 +429,10 @@ module ContextDev
|
|
|
401
429
|
optional :include_links, ContextDev::Internal::Type::Boolean, api_name: :includeLinks
|
|
402
430
|
|
|
403
431
|
# @!attribute max_age_ms
|
|
404
|
-
#
|
|
405
|
-
#
|
|
432
|
+
# Maximum cache age in milliseconds for result page content. Defaults to 180 days
|
|
433
|
+
# (15552000000 ms) when Markdown is requested, or 365 days (31536000000 ms) when
|
|
434
|
+
# only highlights are requested. Explicit values override either default. Maximum:
|
|
435
|
+
# 365 days. Set to 0 to force a fresh scrape.
|
|
406
436
|
#
|
|
407
437
|
# @return [Integer, nil]
|
|
408
438
|
optional :max_age_ms, Integer, api_name: :maxAgeMs
|
|
@@ -420,9 +450,7 @@ module ContextDev
|
|
|
420
450
|
optional :shorten_base64_images, ContextDev::Internal::Type::Boolean, api_name: :shortenBase64Images
|
|
421
451
|
|
|
422
452
|
# @!attribute timeout_opts
|
|
423
|
-
#
|
|
424
|
-
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
425
|
-
# timeoutOpts object.
|
|
453
|
+
# Request deadline and what to return when it passes.
|
|
426
454
|
#
|
|
427
455
|
# @return [ContextDev::Models::WebSearchParams::MarkdownOptions::TimeoutOpts, nil]
|
|
428
456
|
optional :timeout_opts,
|
|
@@ -448,7 +476,7 @@ module ContextDev
|
|
|
448
476
|
#
|
|
449
477
|
# Inline Markdown scraping for each result. Set `enabled: true` to activate.
|
|
450
478
|
#
|
|
451
|
-
# @param enabled [Boolean] Scrape each result to Markdown.
|
|
479
|
+
# @param enabled [Boolean] Scrape each result to Markdown. Adds 1 credit per 10 results.
|
|
452
480
|
#
|
|
453
481
|
# @param include_frames [Boolean] Render iframe contents into the Markdown.
|
|
454
482
|
#
|
|
@@ -456,13 +484,13 @@ module ContextDev
|
|
|
456
484
|
#
|
|
457
485
|
# @param include_links [Boolean] Keep hyperlinks in the Markdown.
|
|
458
486
|
#
|
|
459
|
-
# @param max_age_ms [Integer]
|
|
487
|
+
# @param max_age_ms [Integer] Maximum cache age in milliseconds for result page content. Defaults to 180 days
|
|
460
488
|
#
|
|
461
489
|
# @param pdf [ContextDev::Models::WebSearchParams::MarkdownOptions::Pdf] PDF handling. Use start/end to bound text extraction and OCR to a page range.
|
|
462
490
|
#
|
|
463
491
|
# @param shorten_base64_images [Boolean] Truncate inline base64 image payloads to keep responses small.
|
|
464
492
|
#
|
|
465
|
-
# @param timeout_opts [ContextDev::Models::WebSearchParams::MarkdownOptions::TimeoutOpts]
|
|
493
|
+
# @param timeout_opts [ContextDev::Models::WebSearchParams::MarkdownOptions::TimeoutOpts] Request deadline and what to return when it passes.
|
|
466
494
|
#
|
|
467
495
|
# @param use_main_content_only [Boolean] Strip nav, header, footer, and sidebar — keep only the primary article content.
|
|
468
496
|
#
|
|
@@ -505,17 +533,14 @@ module ContextDev
|
|
|
505
533
|
# @see ContextDev::Models::WebSearchParams::MarkdownOptions#timeout_opts
|
|
506
534
|
class TimeoutOpts < ContextDev::Internal::Type::BaseModel
|
|
507
535
|
# @!attribute milliseconds
|
|
508
|
-
#
|
|
536
|
+
# Deadline in milliseconds.
|
|
509
537
|
#
|
|
510
538
|
# @return [Integer]
|
|
511
539
|
required :milliseconds, Integer
|
|
512
540
|
|
|
513
541
|
# @!attribute behavior
|
|
514
|
-
#
|
|
515
|
-
#
|
|
516
|
-
# available, the request still fails without charging credits. Partial results are
|
|
517
|
-
# not cached as complete results. "return-partial" requires milliseconds of at
|
|
518
|
-
# least 5000.
|
|
542
|
+
# "fail" returns 408 at the deadline. "return-partial" returns available results;
|
|
543
|
+
# inspect the response’s partial flag. "return-partial" requires at least 5000 ms.
|
|
519
544
|
#
|
|
520
545
|
# @return [Symbol, ContextDev::Models::WebSearchParams::MarkdownOptions::TimeoutOpts::Behavior, nil]
|
|
521
546
|
optional :behavior, enum: -> { ContextDev::WebSearchParams::MarkdownOptions::TimeoutOpts::Behavior }
|
|
@@ -525,19 +550,14 @@ module ContextDev
|
|
|
525
550
|
# {ContextDev::Models::WebSearchParams::MarkdownOptions::TimeoutOpts} for more
|
|
526
551
|
# details.
|
|
527
552
|
#
|
|
528
|
-
#
|
|
529
|
-
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
530
|
-
# timeoutOpts object.
|
|
553
|
+
# Request deadline and what to return when it passes.
|
|
531
554
|
#
|
|
532
|
-
# @param milliseconds [Integer]
|
|
555
|
+
# @param milliseconds [Integer] Deadline in milliseconds.
|
|
533
556
|
#
|
|
534
|
-
# @param behavior [Symbol, ContextDev::Models::WebSearchParams::MarkdownOptions::TimeoutOpts::Behavior]
|
|
557
|
+
# @param behavior [Symbol, ContextDev::Models::WebSearchParams::MarkdownOptions::TimeoutOpts::Behavior] "fail" returns 408 at the deadline. "return-partial" returns available results;
|
|
535
558
|
|
|
536
|
-
#
|
|
537
|
-
#
|
|
538
|
-
# available, the request still fails without charging credits. Partial results are
|
|
539
|
-
# not cached as complete results. "return-partial" requires milliseconds of at
|
|
540
|
-
# least 5000.
|
|
559
|
+
# "fail" returns 408 at the deadline. "return-partial" returns available results;
|
|
560
|
+
# inspect the response’s partial flag. "return-partial" requires at least 5000 ms.
|
|
541
561
|
#
|
|
542
562
|
# @see ContextDev::Models::WebSearchParams::MarkdownOptions::TimeoutOpts#behavior
|
|
543
563
|
module Behavior
|
|
@@ -554,16 +574,14 @@ module ContextDev
|
|
|
554
574
|
|
|
555
575
|
class TimeoutOpts < ContextDev::Internal::Type::BaseModel
|
|
556
576
|
# @!attribute milliseconds
|
|
557
|
-
#
|
|
577
|
+
# Deadline in milliseconds.
|
|
558
578
|
#
|
|
559
579
|
# @return [Integer]
|
|
560
580
|
required :milliseconds, Integer
|
|
561
581
|
|
|
562
582
|
# @!attribute behavior
|
|
563
|
-
#
|
|
564
|
-
#
|
|
565
|
-
# available, the request still fails without charging credits. Partial results are
|
|
566
|
-
# not cached as complete results.
|
|
583
|
+
# "fail" returns 408 at the deadline. "return-partial" returns available results;
|
|
584
|
+
# inspect the response’s partial flag.
|
|
567
585
|
#
|
|
568
586
|
# @return [Symbol, ContextDev::Models::WebSearchParams::TimeoutOpts::Behavior, nil]
|
|
569
587
|
optional :behavior, enum: -> { ContextDev::WebSearchParams::TimeoutOpts::Behavior }
|
|
@@ -572,18 +590,14 @@ module ContextDev
|
|
|
572
590
|
# Some parameter documentations has been truncated, see
|
|
573
591
|
# {ContextDev::Models::WebSearchParams::TimeoutOpts} for more details.
|
|
574
592
|
#
|
|
575
|
-
#
|
|
576
|
-
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
577
|
-
# timeoutOpts object.
|
|
593
|
+
# Request deadline and what to return when it passes.
|
|
578
594
|
#
|
|
579
|
-
# @param milliseconds [Integer]
|
|
595
|
+
# @param milliseconds [Integer] Deadline in milliseconds.
|
|
580
596
|
#
|
|
581
|
-
# @param behavior [Symbol, ContextDev::Models::WebSearchParams::TimeoutOpts::Behavior]
|
|
597
|
+
# @param behavior [Symbol, ContextDev::Models::WebSearchParams::TimeoutOpts::Behavior] "fail" returns 408 at the deadline. "return-partial" returns available results;
|
|
582
598
|
|
|
583
|
-
#
|
|
584
|
-
#
|
|
585
|
-
# available, the request still fails without charging credits. Partial results are
|
|
586
|
-
# not cached as complete results.
|
|
599
|
+
# "fail" returns 408 at the deadline. "return-partial" returns available results;
|
|
600
|
+
# inspect the response’s partial flag.
|
|
587
601
|
#
|
|
588
602
|
# @see ContextDev::Models::WebSearchParams::TimeoutOpts#behavior
|
|
589
603
|
module Behavior
|
|
@@ -597,11 +611,8 @@ module ContextDev
|
|
|
597
611
|
end
|
|
598
612
|
end
|
|
599
613
|
|
|
600
|
-
#
|
|
601
|
-
#
|
|
602
|
-
# omitted. Requires zero data retention to be enabled for your organization
|
|
603
|
-
# (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
|
|
604
|
-
# Successful ZDR responses include X-Context-ZDR: true.
|
|
614
|
+
# `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
|
|
615
|
+
# your organization has ZDR.
|
|
605
616
|
module Zdr
|
|
606
617
|
extend ContextDev::Internal::Type::Enum
|
|
607
618
|
|