@@ -89,10 +89,11 @@ class WebScrapeResponse < ContextDev::Internal::Type::BaseModel
8989 required :url , String
9090
9191 # @!attribute is_partial
92- # Present when return-partial captures a page that is still loading, returns
93- # images before image processing finishes, or cuts product AI extraction short.
94- # Also present if the optional product AI fallback fails. Partial responses are
95- # not cached.
92+ # Present when a requested output fails, capture returns a page that is still
93+ # loading, images return before processing finishes, or the optional product AI
94+ # fallback fails or is cut short. Check each output's success field for its
95+ # result. Valid captured pieces may be cached independently; failed retrievals and
96+ # incomplete captures are not cached.
9697 #
9798 # @return [Boolean, ContextDev::Models::WebScrapeResponse::IsPartial, nil]
9899 optional :is_partial , enum : -> { ContextDev ::Models ::WebScrapeResponse ::IsPartial } , api_name : :isPartial
@@ -133,7 +134,7 @@ class WebScrapeResponse < ContextDev::Internal::Type::BaseModel
133134 #
134135 # @param url [String] Final URL after redirects and browser actions.
135136 #
136- # @param is_partial [Boolean, ContextDev::Models::WebScrapeResponse::IsPartial] Present when return-partial captures a page that is still loading, returns image
137+ # @param is_partial [Boolean, ContextDev::Models::WebScrapeResponse::IsPartial] Present when a requested output fails, capture returns a page that is still load
137138 #
138139 # @param key_metadata [ContextDev::Models::WebScrapeResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
139140
@@ -149,12 +150,21 @@ class Bytes < ContextDev::Internal::Type::BaseModel
149150 # @return [Boolean]
150151 required :requested , ContextDev ::Internal ::Type ::Boolean
151152
152- # @!method initialize(data:, requested:)
153+ # @!attribute success
154+ # True when retrieved, false when retrieval failed, and null when not requested.
155+ #
156+ # @return [Boolean, nil]
157+ required :success , ContextDev ::Internal ::Type ::Boolean , nil? : true
158+
159+ # @!method initialize(data:, requested:, success:)
153160 # Original HTTP response body. Waiting, actions, and content filters never change
154161 # it.
155162 #
156163 # @param data [ContextDev::Models::WebScrapeResponse::Bytes::Data, nil]
164+ #
157165 # @param requested [Boolean]
166+ #
167+ # @param success [Boolean, nil] True when retrieved, false when retrieval failed, and null when not requested.
158168
159169 # @see ContextDev::Models::WebScrapeResponse::Bytes#data
160170 class Data < ContextDev ::Internal ::Type ::BaseModel
@@ -235,13 +245,22 @@ class Highlights < ContextDev::Internal::Type::BaseModel
235245 # @return [Boolean]
236246 required :requested , ContextDev ::Internal ::Type ::Boolean
237247
238- # @!method initialize(data:, requested:)
248+ # @!attribute success
249+ # True when retrieved, false when retrieval failed, and null when not requested.
250+ #
251+ # @return [Boolean, nil]
252+ required :success , ContextDev ::Internal ::Type ::Boolean , nil? : true
253+
254+ # @!method initialize(data:, requested:, success:)
239255 # Relevant passages for your question or topic, in page order. A heading in square
240256 # brackets is included when needed to interpret a passage. Empty when the page has
241257 # no text.
242258 #
243259 # @param data [Array<String>, nil]
260+ #
244261 # @param requested [Boolean]
262+ #
263+ # @param success [Boolean, nil] True when retrieved, false when retrieval failed, and null when not requested.
245264 end
246265
247266 # @see ContextDev::Models::WebScrapeResponse#html
@@ -256,11 +275,20 @@ class HTML < ContextDev::Internal::Type::BaseModel
256275 # @return [Boolean]
257276 required :requested , ContextDev ::Internal ::Type ::Boolean
258277
259- # @!method initialize(data:, requested:)
278+ # @!attribute success
279+ # True when retrieved, false when retrieval failed, and null when not requested.
280+ #
281+ # @return [Boolean, nil]
282+ required :success , ContextDev ::Internal ::Type ::Boolean , nil? : true
283+
284+ # @!method initialize(data:, requested:, success:)
260285 # Rendered HTML after content filters.
261286 #
262287 # @param data [String, nil]
288+ #
263289 # @param requested [Boolean]
290+ #
291+ # @param success [Boolean, nil] True when retrieved, false when retrieval failed, and null when not requested.
264292 end
265293
266294 # @see ContextDev::Models::WebScrapeResponse#images
@@ -277,11 +305,20 @@ class Images < ContextDev::Internal::Type::BaseModel
277305 # @return [Boolean]
278306 required :requested , ContextDev ::Internal ::Type ::Boolean
279307
280- # @!method initialize(data:, requested:)
308+ # @!attribute success
309+ # True when retrieved, false when retrieval failed, and null when not requested.
310+ #
311+ # @return [Boolean, nil]
312+ required :success , ContextDev ::Internal ::Type ::Boolean , nil? : true
313+
314+ # @!method initialize(data:, requested:, success:)
281315 # Images after content filters. Empty when none are found.
282316 #
283317 # @param data [Array<ContextDev::Models::WebScrapeResponse::Images::Data>, nil]
318+ #
284319 # @param requested [Boolean]
320+ #
321+ # @param success [Boolean, nil] True when retrieved, false when retrieval failed, and null when not requested.
285322
286323 class Data < ContextDev ::Internal ::Type ::BaseModel
287324 # @!attribute alt
@@ -365,11 +402,20 @@ class Json < ContextDev::Internal::Type::BaseModel
365402 # @return [Boolean]
366403 required :requested , ContextDev ::Internal ::Type ::Boolean
367404
368- # @!method initialize(data:, requested:)
405+ # @!attribute success
406+ # True when retrieved, false when retrieval failed, and null when not requested.
407+ #
408+ # @return [Boolean, nil]
409+ required :success , ContextDev ::Internal ::Type ::Boolean , nil? : true
410+
411+ # @!method initialize(data:, requested:, success:)
369412 # Page data extracted using your schema.
370413 #
371414 # @param data [Hash{Symbol=>Object}, nil]
415+ #
372416 # @param requested [Boolean]
417+ #
418+ # @param success [Boolean, nil] True when retrieved, false when retrieval failed, and null when not requested.
373419 end
374420
375421 # @see ContextDev::Models::WebScrapeResponse#markdown
@@ -384,11 +430,20 @@ class Markdown < ContextDev::Internal::Type::BaseModel
384430 # @return [Boolean]
385431 required :requested , ContextDev ::Internal ::Type ::Boolean
386432
387- # @!method initialize(data:, requested:)
433+ # @!attribute success
434+ # True when retrieved, false when retrieval failed, and null when not requested.
435+ #
436+ # @return [Boolean, nil]
437+ required :success , ContextDev ::Internal ::Type ::Boolean , nil? : true
438+
439+ # @!method initialize(data:, requested:, success:)
388440 # Markdown after content filters.
389441 #
390442 # @param data [String, nil]
443+ #
391444 # @param requested [Boolean]
445+ #
446+ # @param success [Boolean, nil] True when retrieved, false when retrieval failed, and null when not requested.
392447 end
393448
394449 # @see ContextDev::Models::WebScrapeResponse#metadata
@@ -662,11 +717,20 @@ class Parsed < ContextDev::Internal::Type::BaseModel
662717 # @return [Boolean]
663718 required :requested , ContextDev ::Internal ::Type ::Boolean
664719
665- # @!method initialize(data:, requested:)
720+ # @!attribute success
721+ # True when retrieved, false when retrieval failed, and null when not requested.
722+ #
723+ # @return [Boolean, nil]
724+ required :success , ContextDev ::Internal ::Type ::Boolean , nil? : true
725+
726+ # @!method initialize(data:, requested:, success:)
666727 # Fields produced by parseParams.rules, after shared content filters.
667728 #
668729 # @param data [Hash{Symbol=>Object}, nil]
730+ #
669731 # @param requested [Boolean]
732+ #
733+ # @param success [Boolean, nil] True when retrieved, false when retrieval failed, and null when not requested.
670734 end
671735
672736 # @see ContextDev::Models::WebScrapeResponse#product
@@ -681,11 +745,20 @@ class Product < ContextDev::Internal::Type::BaseModel
681745 # @return [Boolean]
682746 required :requested , ContextDev ::Internal ::Type ::Boolean
683747
684- # @!method initialize(data:, requested:)
748+ # @!attribute success
749+ # True when retrieved, false when retrieval failed, and null when not requested.
750+ #
751+ # @return [Boolean, nil]
752+ required :success , ContextDev ::Internal ::Type ::Boolean , nil? : true
753+
754+ # @!method initialize(data:, requested:, success:)
685755 # Product details found on the page.
686756 #
687757 # @param data [ContextDev::Models::WebScrapeResponse::Product::Data, nil]
758+ #
688759 # @param requested [Boolean]
760+ #
761+ # @param success [Boolean, nil] True when retrieved, false when retrieval failed, and null when not requested.
689762
690763 # @see ContextDev::Models::WebScrapeResponse::Product#data
691764 class Data < ContextDev ::Internal ::Type ::BaseModel
@@ -920,17 +993,27 @@ class Screenshot < ContextDev::Internal::Type::BaseModel
920993 # @return [Boolean]
921994 required :requested , ContextDev ::Internal ::Type ::Boolean
922995
923- # @!method initialize(data:, requested:)
996+ # @!attribute success
997+ # True when retrieved, false when retrieval failed, and null when not requested.
998+ #
999+ # @return [Boolean, nil]
1000+ required :success , ContextDev ::Internal ::Type ::Boolean , nil? : true
1001+
1002+ # @!method initialize(data:, requested:, success:)
9241003 # An image data URL. Use directly as an image src.
9251004 #
9261005 # @param data [String, nil]
1006+ #
9271007 # @param requested [Boolean]
1008+ #
1009+ # @param success [Boolean, nil] True when retrieved, false when retrieval failed, and null when not requested.
9281010 end
9291011
930- # Present when return-partial captures a page that is still loading, returns
931- # images before image processing finishes, or cuts product AI extraction short.
932- # Also present if the optional product AI fallback fails. Partial responses are
933- # not cached.
1012+ # Present when a requested output fails, capture returns a page that is still
1013+ # loading, images return before processing finishes, or the optional product AI
1014+ # fallback fails or is cut short. Check each output's success field for its
1015+ # result. Valid captured pieces may be cached independently; failed retrievals and
1016+ # incomplete captures are not cached.
9341017 #
9351018 # @see ContextDev::Models::WebScrapeResponse#is_partial
9361019 module IsPartial
0 commit comments