context.dev 2.17.0 → 2.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (90) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +22 -0
  3. data/README.md +1 -1
  4. data/lib/context_dev/models/ai_extract_product_params.rb +28 -1
  5. data/lib/context_dev/models/ai_extract_product_response.rb +51 -1
  6. data/lib/context_dev/models/ai_extract_products_response.rb +51 -1
  7. data/lib/context_dev/models/brand_retrieve_response.rb +65 -65
  8. data/lib/context_dev/models/brand_retrieve_simplified_response.rb +66 -66
  9. data/lib/context_dev/models/industry_retrieve_naics_params.rb +28 -1
  10. data/lib/context_dev/models/industry_retrieve_sic_params.rb +28 -1
  11. data/lib/context_dev/models/parse_handle_params.rb +8 -6
  12. data/lib/context_dev/models/person_enrich_params.rb +28 -1
  13. data/lib/context_dev/models/web_answers_params.rb +28 -1
  14. data/lib/context_dev/models/web_extract_competitors_params.rb +28 -1
  15. data/lib/context_dev/models/web_extract_fonts_params.rb +2 -2
  16. data/lib/context_dev/models/web_extract_params.rb +28 -1
  17. data/lib/context_dev/models/web_extract_styleguide_params.rb +30 -3
  18. data/lib/context_dev/models/web_screenshot_params.rb +10 -8
  19. data/lib/context_dev/models/web_search_params.rb +30 -3
  20. data/lib/context_dev/models/web_search_response.rb +6 -2
  21. data/lib/context_dev/models/web_web_scrape_bytes_params.rb +8 -6
  22. data/lib/context_dev/models/web_web_scrape_html_params.rb +188 -9
  23. data/lib/context_dev/models/web_web_scrape_html_response.rb +41 -1
  24. data/lib/context_dev/models/web_web_scrape_images_params.rb +31 -4
  25. data/lib/context_dev/models/web_web_scrape_md_params.rb +10 -8
  26. data/lib/context_dev/models/web_web_scrape_screenshot_params.rb +471 -0
  27. data/lib/context_dev/models/web_web_scrape_screenshot_response.rb +169 -0
  28. data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +8 -6
  29. data/lib/context_dev/models.rb +2 -0
  30. data/lib/context_dev/resources/ai.rb +3 -1
  31. data/lib/context_dev/resources/industry.rb +6 -2
  32. data/lib/context_dev/resources/people.rb +3 -1
  33. data/lib/context_dev/resources/web.rb +96 -13
  34. data/lib/context_dev/version.rb +1 -1
  35. data/lib/context_dev.rb +2 -0
  36. data/rbi/context_dev/models/ai_extract_product_params.rbi +54 -0
  37. data/rbi/context_dev/models/ai_extract_product_response.rbi +98 -3
  38. data/rbi/context_dev/models/ai_extract_products_response.rbi +98 -3
  39. data/rbi/context_dev/models/brand_retrieve_response.rbi +128 -136
  40. data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +132 -140
  41. data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +59 -0
  42. data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +57 -0
  43. data/rbi/context_dev/models/parse_handle_params.rbi +12 -9
  44. data/rbi/context_dev/models/person_enrich_params.rbi +45 -0
  45. data/rbi/context_dev/models/web_answers_params.rbi +45 -0
  46. data/rbi/context_dev/models/web_extract_competitors_params.rbi +59 -0
  47. data/rbi/context_dev/models/web_extract_fonts_params.rbi +3 -3
  48. data/rbi/context_dev/models/web_extract_params.rbi +45 -0
  49. data/rbi/context_dev/models/web_extract_styleguide_params.rbi +62 -3
  50. data/rbi/context_dev/models/web_screenshot_params.rbi +15 -12
  51. data/rbi/context_dev/models/web_search_params.rbi +48 -3
  52. data/rbi/context_dev/models/web_search_response.rbi +4 -2
  53. data/rbi/context_dev/models/web_web_scrape_bytes_params.rbi +12 -9
  54. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +485 -12
  55. data/rbi/context_dev/models/web_web_scrape_html_response.rbi +103 -0
  56. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +62 -5
  57. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +15 -12
  58. data/rbi/context_dev/models/web_web_scrape_screenshot_params.rbi +1580 -0
  59. data/rbi/context_dev/models/web_web_scrape_screenshot_response.rbi +332 -0
  60. data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +12 -9
  61. data/rbi/context_dev/models.rbi +3 -0
  62. data/rbi/context_dev/resources/ai.rbi +7 -0
  63. data/rbi/context_dev/resources/industry.rbi +14 -0
  64. data/rbi/context_dev/resources/parse.rbi +4 -4
  65. data/rbi/context_dev/resources/people.rbi +7 -0
  66. data/rbi/context_dev/resources/web.rbi +173 -21
  67. data/sig/context_dev/models/ai_extract_product_params.rbs +21 -1
  68. data/sig/context_dev/models/ai_extract_product_response.rbs +44 -3
  69. data/sig/context_dev/models/ai_extract_products_response.rbs +44 -3
  70. data/sig/context_dev/models/brand_retrieve_response.rbs +51 -59
  71. data/sig/context_dev/models/brand_retrieve_simplified_response.rbs +51 -59
  72. data/sig/context_dev/models/industry_retrieve_naics_params.rbs +21 -1
  73. data/sig/context_dev/models/industry_retrieve_sic_params.rbs +21 -1
  74. data/sig/context_dev/models/person_enrich_params.rbs +21 -1
  75. data/sig/context_dev/models/web_answers_params.rbs +21 -1
  76. data/sig/context_dev/models/web_extract_competitors_params.rbs +21 -1
  77. data/sig/context_dev/models/web_extract_params.rbs +21 -1
  78. data/sig/context_dev/models/web_extract_styleguide_params.rbs +21 -1
  79. data/sig/context_dev/models/web_search_params.rbs +21 -1
  80. data/sig/context_dev/models/web_web_scrape_html_params.rbs +148 -0
  81. data/sig/context_dev/models/web_web_scrape_html_response.rbs +30 -0
  82. data/sig/context_dev/models/web_web_scrape_images_params.rbs +21 -1
  83. data/sig/context_dev/models/web_web_scrape_screenshot_params.rbs +619 -0
  84. data/sig/context_dev/models/web_web_scrape_screenshot_response.rbs +127 -0
  85. data/sig/context_dev/models.rbs +2 -0
  86. data/sig/context_dev/resources/ai.rbs +1 -0
  87. data/sig/context_dev/resources/industry.rbs +2 -0
  88. data/sig/context_dev/resources/people.rbs +1 -0
  89. data/sig/context_dev/resources/web.rbs +24 -0
  90. metadata +8 -2
@@ -50,7 +50,17 @@ module ContextDev
50
50
  # @return [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Type, nil]
51
51
  optional :type, enum: -> { ContextDev::IndustryRetrieveSicParams::Type }
52
52
 
53
- # @!method initialize(input:, max_results: nil, min_results: nil, tags: nil, timeout_opts: nil, type: nil, request_options: {})
53
+ # @!attribute zdr
54
+ # Set to enabled to bypass shared caches and omit request and response content
55
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
56
+ # omitted. Requires zero data retention to be enabled for your organization
57
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
58
+ # Successful ZDR responses include X-Context-ZDR: true.
59
+ #
60
+ # @return [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Zdr, nil]
61
+ optional :zdr, enum: -> { ContextDev::IndustryRetrieveSicParams::Zdr }
62
+
63
+ # @!method initialize(input:, max_results: nil, min_results: nil, tags: nil, timeout_opts: nil, type: nil, zdr: nil, request_options: {})
54
64
  # Some parameter documentations has been truncated, see
55
65
  # {ContextDev::Models::IndustryRetrieveSicParams} for more details.
56
66
  #
@@ -66,6 +76,8 @@ module ContextDev
66
76
  #
67
77
  # @param type [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Type] Which SIC dataset to classify against. `original_sic` uses the 1987 Standard Ind
68
78
  #
79
+ # @param zdr [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
80
+ #
69
81
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
70
82
 
71
83
  class TimeoutOpts < ContextDev::Internal::Type::BaseModel
@@ -125,6 +137,21 @@ module ContextDev
125
137
  # @!method self.values
126
138
  # @return [Array<Symbol>]
127
139
  end
140
+
141
+ # Set to enabled to bypass shared caches and omit request and response content
142
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
143
+ # omitted. Requires zero data retention to be enabled for your organization
144
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
145
+ # Successful ZDR responses include X-Context-ZDR: true.
146
+ module Zdr
147
+ extend ContextDev::Internal::Type::Enum
148
+
149
+ ENABLED = :enabled
150
+ DISABLED = :disabled
151
+
152
+ # @!method self.values
153
+ # @return [Array<Symbol>]
154
+ end
128
155
  end
129
156
  end
130
157
  end
@@ -74,9 +74,10 @@ module ContextDev
74
74
 
75
75
  # @!attribute zdr
76
76
  # Set to enabled to bypass shared caches and omit request and response content
77
- # from retained usage logs. Requires zero data retention to be enabled for your
78
- # organization (contact support@context.dev), otherwise the request fails with
79
- # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
77
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
78
+ # omitted. Requires zero data retention to be enabled for your organization
79
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
80
+ # Successful ZDR responses include X-Context-ZDR: true.
80
81
  #
81
82
  # @return [Symbol, ContextDev::Models::ParseHandleParams::Zdr, nil]
82
83
  optional :zdr, enum: -> { ContextDev::ParseHandleParams::Zdr }
@@ -215,9 +216,10 @@ module ContextDev
215
216
  end
216
217
 
217
218
  # Set to enabled to bypass shared caches and omit request and response content
218
- # from retained usage logs. Requires zero data retention to be enabled for your
219
- # organization (contact support@context.dev), otherwise the request fails with
220
- # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
219
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
220
+ # omitted. Requires zero data retention to be enabled for your organization
221
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
222
+ # Successful ZDR responses include X-Context-ZDR: true.
221
223
  module Zdr
222
224
  extend ContextDev::Internal::Type::Enum
223
225
 
@@ -51,7 +51,17 @@ module ContextDev
51
51
  # @return [ContextDev::Models::PersonEnrichParams::TimeoutOpts, nil]
52
52
  optional :timeout_opts, -> { ContextDev::PersonEnrichParams::TimeoutOpts }, api_name: :timeoutOpts
53
53
 
54
- # @!method initialize(company: nil, education: nil, email: nil, location: nil, name: nil, social_urls: nil, tags: nil, timeout_opts: nil, request_options: {})
54
+ # @!attribute zdr
55
+ # Set to enabled to bypass shared caches and omit request and response content
56
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
57
+ # omitted. Requires zero data retention to be enabled for your organization
58
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
59
+ # Successful ZDR responses include X-Context-ZDR: true.
60
+ #
61
+ # @return [Symbol, ContextDev::Models::PersonEnrichParams::Zdr, nil]
62
+ optional :zdr, enum: -> { ContextDev::PersonEnrichParams::Zdr }
63
+
64
+ # @!method initialize(company: nil, education: nil, email: nil, location: nil, name: nil, social_urls: nil, tags: nil, timeout_opts: nil, zdr: nil, request_options: {})
55
65
  # Some parameter documentations has been truncated, see
56
66
  # {ContextDev::Models::PersonEnrichParams} for more details.
57
67
  #
@@ -71,6 +81,8 @@ module ContextDev
71
81
  #
72
82
  # @param timeout_opts [ContextDev::Models::PersonEnrichParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
73
83
  #
84
+ # @param zdr [Symbol, ContextDev::Models::PersonEnrichParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
85
+ #
74
86
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
75
87
 
76
88
  class Company < ContextDev::Internal::Type::BaseModel
@@ -216,6 +228,21 @@ module ContextDev
216
228
  # @return [Array<Symbol>]
217
229
  end
218
230
  end
231
+
232
+ # Set to enabled to bypass shared caches and omit request and response content
233
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
234
+ # omitted. Requires zero data retention to be enabled for your organization
235
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
236
+ # Successful ZDR responses include X-Context-ZDR: true.
237
+ module Zdr
238
+ extend ContextDev::Internal::Type::Enum
239
+
240
+ ENABLED = :enabled
241
+ DISABLED = :disabled
242
+
243
+ # @!method self.values
244
+ # @return [Array<Symbol>]
245
+ end
219
246
  end
220
247
  end
221
248
  end
@@ -46,7 +46,17 @@ module ContextDev
46
46
  # @return [ContextDev::Models::WebAnswersParams::TimeoutOpts, nil]
47
47
  optional :timeout_opts, -> { ContextDev::WebAnswersParams::TimeoutOpts }, api_name: :timeoutOpts
48
48
 
49
- # @!method initialize(task:, json_format: nil, mode: nil, tags: nil, timeout_opts: nil, request_options: {})
49
+ # @!attribute zdr
50
+ # Set to enabled to bypass shared caches and omit request and response content
51
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
52
+ # omitted. Requires zero data retention to be enabled for your organization
53
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
54
+ # Successful ZDR responses include X-Context-ZDR: true.
55
+ #
56
+ # @return [Symbol, ContextDev::Models::WebAnswersParams::Zdr, nil]
57
+ optional :zdr, enum: -> { ContextDev::WebAnswersParams::Zdr }
58
+
59
+ # @!method initialize(task:, json_format: nil, mode: nil, tags: nil, timeout_opts: nil, zdr: nil, request_options: {})
50
60
  # Some parameter documentations has been truncated, see
51
61
  # {ContextDev::Models::WebAnswersParams} for more details.
52
62
  #
@@ -60,6 +70,8 @@ module ContextDev
60
70
  #
61
71
  # @param timeout_opts [ContextDev::Models::WebAnswersParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
62
72
  #
73
+ # @param zdr [Symbol, ContextDev::Models::WebAnswersParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
74
+ #
63
75
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
64
76
 
65
77
  # Research level: fast uses a smaller model and research budget for 10 credits;
@@ -119,6 +131,21 @@ module ContextDev
119
131
  # @return [Array<Symbol>]
120
132
  end
121
133
  end
134
+
135
+ # Set to enabled to bypass shared caches and omit request and response content
136
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
137
+ # omitted. Requires zero data retention to be enabled for your organization
138
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
139
+ # Successful ZDR responses include X-Context-ZDR: true.
140
+ module Zdr
141
+ extend ContextDev::Internal::Type::Enum
142
+
143
+ ENABLED = :enabled
144
+ DISABLED = :disabled
145
+
146
+ # @!method self.values
147
+ # @return [Array<Symbol>]
148
+ end
122
149
  end
123
150
  end
124
151
  end
@@ -35,7 +35,17 @@ module ContextDev
35
35
  # @return [ContextDev::Models::WebExtractCompetitorsParams::TimeoutOpts, nil]
36
36
  optional :timeout_opts, -> { ContextDev::WebExtractCompetitorsParams::TimeoutOpts }
37
37
 
38
- # @!method initialize(domain:, num_competitors: nil, tags: nil, timeout_opts: nil, request_options: {})
38
+ # @!attribute zdr
39
+ # Set to enabled to bypass shared caches and omit request and response content
40
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
41
+ # omitted. Requires zero data retention to be enabled for your organization
42
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
43
+ # Successful ZDR responses include X-Context-ZDR: true.
44
+ #
45
+ # @return [Symbol, ContextDev::Models::WebExtractCompetitorsParams::Zdr, nil]
46
+ optional :zdr, enum: -> { ContextDev::WebExtractCompetitorsParams::Zdr }
47
+
48
+ # @!method initialize(domain:, num_competitors: nil, tags: nil, timeout_opts: nil, zdr: nil, request_options: {})
39
49
  # Some parameter documentations has been truncated, see
40
50
  # {ContextDev::Models::WebExtractCompetitorsParams} for more details.
41
51
  #
@@ -47,6 +57,8 @@ module ContextDev
47
57
  #
48
58
  # @param timeout_opts [ContextDev::Models::WebExtractCompetitorsParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
49
59
  #
60
+ # @param zdr [Symbol, ContextDev::Models::WebExtractCompetitorsParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
61
+ #
50
62
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
51
63
 
52
64
  class TimeoutOpts < ContextDev::Internal::Type::BaseModel
@@ -93,6 +105,21 @@ module ContextDev
93
105
  # @return [Array<Symbol>]
94
106
  end
95
107
  end
108
+
109
+ # Set to enabled to bypass shared caches and omit request and response content
110
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
111
+ # omitted. Requires zero data retention to be enabled for your organization
112
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
113
+ # Successful ZDR responses include X-Context-ZDR: true.
114
+ module Zdr
115
+ extend ContextDev::Internal::Type::Enum
116
+
117
+ ENABLED = :enabled
118
+ DISABLED = :disabled
119
+
120
+ # @!method self.values
121
+ # @return [Array<Symbol>]
122
+ end
96
123
  end
97
124
  end
98
125
  end
@@ -75,7 +75,7 @@ module ContextDev
75
75
  # credits. "return-partial" returns usable results collected so far; if none are
76
76
  # available, the request still fails without charging credits. Partial results are
77
77
  # not cached as complete results. "return-partial" requires milliseconds of at
78
- # least 15000.
78
+ # least 5000.
79
79
  #
80
80
  # @return [Symbol, ContextDev::Models::WebExtractFontsParams::TimeoutOpts::Behavior, nil]
81
81
  optional :behavior, enum: -> { ContextDev::WebExtractFontsParams::TimeoutOpts::Behavior }
@@ -96,7 +96,7 @@ module ContextDev
96
96
  # credits. "return-partial" returns usable results collected so far; if none are
97
97
  # available, the request still fails without charging credits. Partial results are
98
98
  # not cached as complete results. "return-partial" requires milliseconds of at
99
- # least 15000.
99
+ # least 5000.
100
100
  #
101
101
  # @see ContextDev::Models::WebExtractFontsParams::TimeoutOpts#behavior
102
102
  module Behavior
@@ -125,7 +125,17 @@ module ContextDev
125
125
  # @return [Integer, nil]
126
126
  optional :wait_for_ms, Integer, api_name: :waitForMs
127
127
 
128
- # @!method initialize(schema:, url:, actions: nil, fact_check: nil, follow_subdomains: nil, include_frames: nil, instructions: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, settle_animations: nil, stop_after_ms: nil, tags: nil, timeout_opts: nil, wait_for_ms: nil, request_options: {})
128
+ # @!attribute zdr
129
+ # Set to enabled to bypass shared caches and omit request and response content
130
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
131
+ # omitted. Requires zero data retention to be enabled for your organization
132
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
133
+ # Successful ZDR responses include X-Context-ZDR: true.
134
+ #
135
+ # @return [Symbol, ContextDev::Models::WebExtractParams::Zdr, nil]
136
+ optional :zdr, enum: -> { ContextDev::WebExtractParams::Zdr }
137
+
138
+ # @!method initialize(schema:, url:, actions: nil, fact_check: nil, follow_subdomains: nil, include_frames: nil, instructions: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, settle_animations: nil, stop_after_ms: nil, tags: nil, timeout_opts: nil, wait_for_ms: nil, zdr: nil, request_options: {})
129
139
  # Some parameter documentations has been truncated, see
130
140
  # {ContextDev::Models::WebExtractParams} for more details.
131
141
  #
@@ -161,6 +171,8 @@ module ContextDev
161
171
  #
162
172
  # @param wait_for_ms [Integer] Optional browser wait time in milliseconds after initial page load for each craw
163
173
  #
174
+ # @param zdr [Symbol, ContextDev::Models::WebExtractParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
175
+ #
164
176
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
165
177
 
166
178
  # Browser action discriminated by `do`. Each variant exposes only its applicable
@@ -387,6 +399,21 @@ module ContextDev
387
399
  # @return [Array<Symbol>]
388
400
  end
389
401
  end
402
+
403
+ # Set to enabled to bypass shared caches and omit request and response content
404
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
405
+ # omitted. Requires zero data retention to be enabled for your organization
406
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
407
+ # Successful ZDR responses include X-Context-ZDR: true.
408
+ module Zdr
409
+ extend ContextDev::Internal::Type::Enum
410
+
411
+ ENABLED = :enabled
412
+ DISABLED = :disabled
413
+
414
+ # @!method self.values
415
+ # @return [Array<Symbol>]
416
+ end
390
417
  end
391
418
  end
392
419
  end
@@ -55,7 +55,17 @@ module ContextDev
55
55
  # @return [ContextDev::Models::WebExtractStyleguideParams::TimeoutOpts, nil]
56
56
  optional :timeout_opts, -> { ContextDev::WebExtractStyleguideParams::TimeoutOpts }
57
57
 
58
- # @!method initialize(color_scheme: nil, direct_url: nil, domain: nil, max_age_ms: nil, tags: nil, timeout_opts: nil, request_options: {})
58
+ # @!attribute zdr
59
+ # Set to enabled to bypass shared caches and omit request and response content
60
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
61
+ # omitted. Requires zero data retention to be enabled for your organization
62
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
63
+ # Successful ZDR responses include X-Context-ZDR: true.
64
+ #
65
+ # @return [Symbol, ContextDev::Models::WebExtractStyleguideParams::Zdr, nil]
66
+ optional :zdr, enum: -> { ContextDev::WebExtractStyleguideParams::Zdr }
67
+
68
+ # @!method initialize(color_scheme: nil, direct_url: nil, domain: nil, max_age_ms: nil, tags: nil, timeout_opts: nil, zdr: nil, request_options: {})
59
69
  # Some parameter documentations has been truncated, see
60
70
  # {ContextDev::Models::WebExtractStyleguideParams} for more details.
61
71
  #
@@ -71,6 +81,8 @@ module ContextDev
71
81
  #
72
82
  # @param timeout_opts [ContextDev::Models::WebExtractStyleguideParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
73
83
  #
84
+ # @param zdr [Symbol, ContextDev::Models::WebExtractStyleguideParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
85
+ #
74
86
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
75
87
 
76
88
  # Optional browser color scheme to emulate for websites that respond to
@@ -97,7 +109,7 @@ module ContextDev
97
109
  # credits. "return-partial" returns usable results collected so far; if none are
98
110
  # available, the request still fails without charging credits. Partial results are
99
111
  # not cached as complete results. "return-partial" requires milliseconds of at
100
- # least 15000.
112
+ # least 5000.
101
113
  #
102
114
  # @return [Symbol, ContextDev::Models::WebExtractStyleguideParams::TimeoutOpts::Behavior, nil]
103
115
  optional :behavior, enum: -> { ContextDev::WebExtractStyleguideParams::TimeoutOpts::Behavior }
@@ -118,7 +130,7 @@ module ContextDev
118
130
  # credits. "return-partial" returns usable results collected so far; if none are
119
131
  # available, the request still fails without charging credits. Partial results are
120
132
  # not cached as complete results. "return-partial" requires milliseconds of at
121
- # least 15000.
133
+ # least 5000.
122
134
  #
123
135
  # @see ContextDev::Models::WebExtractStyleguideParams::TimeoutOpts#behavior
124
136
  module Behavior
@@ -131,6 +143,21 @@ module ContextDev
131
143
  # @return [Array<Symbol>]
132
144
  end
133
145
  end
146
+
147
+ # Set to enabled to bypass shared caches and omit request and response content
148
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
149
+ # omitted. Requires zero data retention to be enabled for your organization
150
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
151
+ # Successful ZDR responses include X-Context-ZDR: true.
152
+ module Zdr
153
+ extend ContextDev::Internal::Type::Enum
154
+
155
+ ENABLED = :enabled
156
+ DISABLED = :disabled
157
+
158
+ # @!method self.values
159
+ # @return [Array<Symbol>]
160
+ end
134
161
  end
135
162
  end
136
163
  end
@@ -125,9 +125,10 @@ module ContextDev
125
125
 
126
126
  # @!attribute zdr
127
127
  # Set to enabled to bypass shared caches and omit request and response content
128
- # from retained usage logs. Requires zero data retention to be enabled for your
129
- # organization (contact support@context.dev), otherwise the request fails with
130
- # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
128
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
129
+ # omitted. Requires zero data retention to be enabled for your organization
130
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
131
+ # Successful ZDR responses include X-Context-ZDR: true.
131
132
  #
132
133
  # @return [Symbol, ContextDev::Models::WebScreenshotParams::Zdr, nil]
133
134
  optional :zdr, enum: -> { ContextDev::WebScreenshotParams::Zdr }
@@ -440,7 +441,7 @@ module ContextDev
440
441
  # credits. "return-partial" returns usable results collected so far; if none are
441
442
  # available, the request still fails without charging credits. Partial results are
442
443
  # not cached as complete results. "return-partial" requires milliseconds of at
443
- # least 15000.
444
+ # least 5000.
444
445
  #
445
446
  # @return [Symbol, ContextDev::Models::WebScreenshotParams::TimeoutOpts::Behavior, nil]
446
447
  optional :behavior, enum: -> { ContextDev::WebScreenshotParams::TimeoutOpts::Behavior }
@@ -461,7 +462,7 @@ module ContextDev
461
462
  # credits. "return-partial" returns usable results collected so far; if none are
462
463
  # available, the request still fails without charging credits. Partial results are
463
464
  # not cached as complete results. "return-partial" requires milliseconds of at
464
- # least 15000.
465
+ # least 5000.
465
466
  #
466
467
  # @see ContextDev::Models::WebScreenshotParams::TimeoutOpts#behavior
467
468
  module Behavior
@@ -497,9 +498,10 @@ module ContextDev
497
498
  end
498
499
 
499
500
  # Set to enabled to bypass shared caches and omit request and response content
500
- # from retained usage logs. Requires zero data retention to be enabled for your
501
- # organization (contact support@context.dev), otherwise the request fails with
502
- # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
501
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
502
+ # omitted. Requires zero data retention to be enabled for your organization
503
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
504
+ # Successful ZDR responses include X-Context-ZDR: true.
503
505
  module Zdr
504
506
  extend ContextDev::Internal::Type::Enum
505
507
 
@@ -75,7 +75,17 @@ module ContextDev
75
75
  # @return [ContextDev::Models::WebSearchParams::TimeoutOpts, nil]
76
76
  optional :timeout_opts, -> { ContextDev::WebSearchParams::TimeoutOpts }, api_name: :timeoutOpts
77
77
 
78
- # @!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, request_options: {})
78
+ # @!attribute zdr
79
+ # Set to enabled to bypass shared caches and omit request and response content
80
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
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.
84
+ #
85
+ # @return [Symbol, ContextDev::Models::WebSearchParams::Zdr, nil]
86
+ optional :zdr, enum: -> { ContextDev::WebSearchParams::Zdr }
87
+
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: {})
79
89
  # Some parameter documentations has been truncated, see
80
90
  # {ContextDev::Models::WebSearchParams} for more details.
81
91
  #
@@ -99,6 +109,8 @@ module ContextDev
99
109
  #
100
110
  # @param timeout_opts [ContextDev::Models::WebSearchParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
101
111
  #
112
+ # @param zdr [Symbol, ContextDev::Models::WebSearchParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
113
+ #
102
114
  # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
103
115
 
104
116
  # Two-letter ISO 3166-1 alpha-2 country code to localize results to a specific
@@ -503,7 +515,7 @@ module ContextDev
503
515
  # credits. "return-partial" returns usable results collected so far; if none are
504
516
  # available, the request still fails without charging credits. Partial results are
505
517
  # not cached as complete results. "return-partial" requires milliseconds of at
506
- # least 15000.
518
+ # least 5000.
507
519
  #
508
520
  # @return [Symbol, ContextDev::Models::WebSearchParams::MarkdownOptions::TimeoutOpts::Behavior, nil]
509
521
  optional :behavior, enum: -> { ContextDev::WebSearchParams::MarkdownOptions::TimeoutOpts::Behavior }
@@ -525,7 +537,7 @@ module ContextDev
525
537
  # credits. "return-partial" returns usable results collected so far; if none are
526
538
  # available, the request still fails without charging credits. Partial results are
527
539
  # not cached as complete results. "return-partial" requires milliseconds of at
528
- # least 15000.
540
+ # least 5000.
529
541
  #
530
542
  # @see ContextDev::Models::WebSearchParams::MarkdownOptions::TimeoutOpts#behavior
531
543
  module Behavior
@@ -584,6 +596,21 @@ module ContextDev
584
596
  # @return [Array<Symbol>]
585
597
  end
586
598
  end
599
+
600
+ # Set to enabled to bypass shared caches and omit request and response content
601
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
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.
605
+ module Zdr
606
+ extend ContextDev::Internal::Type::Enum
607
+
608
+ ENABLED = :enabled
609
+ DISABLED = :disabled
610
+
611
+ # @!method self.values
612
+ # @return [Array<Symbol>]
613
+ end
587
614
  end
588
615
  end
589
616
  end
@@ -106,7 +106,8 @@ module ContextDev
106
106
 
107
107
  class Result < ContextDev::Internal::Type::BaseModel
108
108
  # @!attribute description
109
- # Snippet excerpt from the page.
109
+ # Snippet excerpt from the page. Empty string when the search provider does not
110
+ # supply a snippet.
110
111
  #
111
112
  # @return [String]
112
113
  required :description, String
@@ -136,7 +137,10 @@ module ContextDev
136
137
  required :url, String
137
138
 
138
139
  # @!method initialize(description:, markdown:, relevance:, title:, url:)
139
- # @param description [String] Snippet excerpt from the page.
140
+ # Some parameter documentations has been truncated, see
141
+ # {ContextDev::Models::WebSearchResponse::Result} for more details.
142
+ #
143
+ # @param description [String] Snippet excerpt from the page. Empty string when the search provider does not su
140
144
  #
141
145
  # @param markdown [ContextDev::Models::WebSearchResponse::Result::Markdown] Markdown scrape status and content for this result.
142
146
  #
@@ -47,9 +47,10 @@ module ContextDev
47
47
 
48
48
  # @!attribute zdr
49
49
  # Set to enabled to bypass shared caches and omit request and response content
50
- # from retained usage logs. Requires zero data retention to be enabled for your
51
- # organization (contact support@context.dev), otherwise the request fails with
52
- # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
50
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
51
+ # omitted. Requires zero data retention to be enabled for your organization
52
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
53
+ # Successful ZDR responses include X-Context-ZDR: true.
53
54
  #
54
55
  # @return [Symbol, ContextDev::Models::WebWebScrapeBytesParams::Zdr, nil]
55
56
  optional :zdr, enum: -> { ContextDev::WebWebScrapeBytesParams::Zdr }
@@ -327,9 +328,10 @@ module ContextDev
327
328
  end
328
329
 
329
330
  # Set to enabled to bypass shared caches and omit request and response content
330
- # from retained usage logs. Requires zero data retention to be enabled for your
331
- # organization (contact support@context.dev), otherwise the request fails with
332
- # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
331
+ # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
332
+ # omitted. Requires zero data retention to be enabled for your organization
333
+ # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
334
+ # Successful ZDR responses include X-Context-ZDR: true.
333
335
  module Zdr
334
336
  extend ContextDev::Internal::Type::Enum
335
337