context.dev 2.21.0 → 2.22.0

data/rbi/context_dev/models/web_scrape_response.rbi

@@ -11,8 +11,7 @@ module ContextDev
           )
         end
 
-      # Original HTTP response body. Waiting, actions, and content filters never change
-      # it.
+      # The original HTTP response body, unchanged by waits, actions, and filters.
       sig { returns(ContextDev::Models::WebScrapeResponse::Bytes) }
       attr_reader :bytes
 
@@ -21,9 +20,7 @@ module ContextDev
       end
       attr_writer :bytes
 
-      # Cache outcome for this response. Composite responses are hits only when every
-      # cache-controlled fetch contributing to the output was a hit; age_ms is the
-      # oldest contributing hit.
+      # Whether this response came from cache.
       sig { returns(ContextDev::Models::WebScrapeResponse::CacheMetadata) }
       attr_reader :cache_metadata
 
@@ -35,9 +32,8 @@ module ContextDev
       end
       attr_writer :cache_metadata
 
-      # Relevant Markdown excerpts for your question or topic, in page order. Headings
-      # in square brackets supply necessary context; ellipses mark omitted portions.
-      # Empty when the page has no text.
+      # Relevant Markdown excerpts in page order. `[Heading]` adds context; `…` marks
+      # omitted text.
       sig { returns(ContextDev::Models::WebScrapeResponse::Highlights) }
       attr_reader :highlights
 
@@ -57,7 +53,7 @@ module ContextDev
       end
       attr_writer :html
 
-      # Images after content filters. Empty when none are found.
+      # Images after content filters. `[]` when none are found.
       sig { returns(ContextDev::Models::WebScrapeResponse::Images) }
       attr_reader :images
 
@@ -68,7 +64,7 @@ module ContextDev
       end
       attr_writer :images
 
-      # Page data extracted using your schema.
+      # Object matching `jsonParams.schema`.
       sig { returns(ContextDev::Models::WebScrapeResponse::Json) }
       attr_reader :json
 
@@ -88,7 +84,7 @@ module ContextDev
       end
       attr_writer :markdown
 
-      # Page details, when available.
+      # Page metadata. Fields are omitted when not found.
       sig { returns(ContextDev::Models::WebScrapeResponse::Metadata) }
       attr_reader :metadata
 
@@ -99,7 +95,8 @@ module ContextDev
       end
       attr_writer :metadata
 
-      # Fields produced by parseParams.rules, after shared content filters.
+      # Fields from `parseParams.rules`, after content filters. Unmatched fields are
+      # `null` (`[]` for lists).
       sig { returns(ContextDev::Models::WebScrapeResponse::Parsed) }
       attr_reader :parsed
 
@@ -121,12 +118,12 @@ module ContextDev
       end
       attr_writer :product
 
-      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
-      # it when contacting support about a failed request.
+      # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+      # support.
       sig { returns(String) }
       attr_accessor :request_id
 
-      # An image data URL. Use directly as an image src.
+      # Screenshot as a base64 image data URL.
       sig { returns(ContextDev::Models::WebScrapeResponse::Screenshot) }
       attr_reader :screenshot
 
@@ -141,11 +138,8 @@ module ContextDev
       sig { returns(String) }
       attr_accessor :url
 
-      # Present when at least one requested output succeeds while another fails, or when
-      # successful outputs come from a page that is still loading or images returned
-      # before processing finished. Absent when every requested output fails. Check each
-      # output's success field for its result. Valid captured pieces may be cached
-      # independently; failed retrievals and incomplete captures are not cached.
+      # True when at least one requested output succeeds but the response has failed or
+      # incomplete outputs. Absent when all requested outputs fail.
       sig do
         returns(
           T.nilable(
@@ -163,7 +157,7 @@ module ContextDev
       end
       attr_writer :is_partial
 
-      # Credit usage, included whenever a valid API key is provided.
+      # Credits this request used and your remaining balance.
       sig do
         returns(T.nilable(ContextDev::Models::WebScrapeResponse::KeyMetadata))
       end
@@ -200,45 +194,39 @@ module ContextDev
         ).returns(T.attached_class)
       end
       def self.new(
-        # Original HTTP response body. Waiting, actions, and content filters never change
-        # it.
+        # The original HTTP response body, unchanged by waits, actions, and filters.
         bytes:,
-        # Cache outcome for this response. Composite responses are hits only when every
-        # cache-controlled fetch contributing to the output was a hit; age_ms is the
-        # oldest contributing hit.
+        # Whether this response came from cache.
         cache_metadata:,
-        # Relevant Markdown excerpts for your question or topic, in page order. Headings
-        # in square brackets supply necessary context; ellipses mark omitted portions.
-        # Empty when the page has no text.
+        # Relevant Markdown excerpts in page order. `[Heading]` adds context; `…` marks
+        # omitted text.
         highlights:,
         # Rendered HTML after content filters.
         html:,
-        # Images after content filters. Empty when none are found.
+        # Images after content filters. `[]` when none are found.
         images:,
-        # Page data extracted using your schema.
+        # Object matching `jsonParams.schema`.
         json:,
         # Markdown after content filters.
         markdown:,
-        # Page details, when available.
+        # Page metadata. Fields are omitted when not found.
         metadata:,
-        # Fields produced by parseParams.rules, after shared content filters.
+        # Fields from `parseParams.rules`, after content filters. Unmatched fields are
+        # `null` (`[]` for lists).
         parsed:,
         # Product details found on the page.
         product:,
-        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
-        # it when contacting support about a failed request.
+        # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+        # support.
         request_id:,
-        # An image data URL. Use directly as an image src.
+        # Screenshot as a base64 image data URL.
         screenshot:,
         # Final URL after redirects and browser actions.
         url:,
-        # Present when at least one requested output succeeds while another fails, or when
-        # successful outputs come from a page that is still loading or images returned
-        # before processing finished. Absent when every requested output fails. Check each
-        # output's success field for its result. Valid captured pieces may be cached
-        # independently; failed retrievals and incomplete captures are not cached.
+        # True when at least one requested output succeeds but the response has failed or
+        # incomplete outputs. Absent when all requested outputs fail.
         is_partial: nil,
-        # Credit usage, included whenever a valid API key is provided.
+        # Credits this request used and your remaining balance.
         key_metadata: nil
       )
       end
@@ -296,12 +284,25 @@ module ContextDev
         sig { returns(T::Boolean) }
         attr_accessor :requested
 
-        # True when retrieved, false when retrieval failed, and null when not requested.
+        # `true` if returned, `false` if it failed, `null` if not requested.
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :success
 
-        # Original HTTP response body. Waiting, actions, and content filters never change
-        # it.
+        # Why the output failed. Present only when `success` is `false`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :error_code
+
+        sig { params(error_code: String).void }
+        attr_writer :error_code
+
+        # Explanation of the failure and possible next steps.
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
+        # The original HTTP response body, unchanged by waits, actions, and filters.
         sig do
           params(
             data:
@@ -309,14 +310,20 @@ module ContextDev
                 ContextDev::Models::WebScrapeResponse::Bytes::Data::OrHash
               ),
             requested: T::Boolean,
-            success: T.nilable(T::Boolean)
+            success: T.nilable(T::Boolean),
+            error_code: String,
+            message: String
           ).returns(T.attached_class)
         end
         def self.new(
           data:,
           requested:,
-          # True when retrieved, false when retrieval failed, and null when not requested.
-          success:
+          # `true` if returned, `false` if it failed, `null` if not requested.
+          success:,
+          # Why the output failed. Present only when `success` is `false`.
+          error_code: nil,
+          # Explanation of the failure and possible next steps.
+          message: nil
         )
         end
 
@@ -326,7 +333,9 @@ module ContextDev
               data:
                 T.nilable(ContextDev::Models::WebScrapeResponse::Bytes::Data),
               requested: T::Boolean,
-              success: T.nilable(T::Boolean)
+              success: T.nilable(T::Boolean),
+              error_code: String,
+              message: String
             }
           )
         end
@@ -342,8 +351,7 @@ module ContextDev
               )
             end
 
-          # Original response body as base64, after HTTP decompression. Maximum decoded
-          # size: 20 MiB.
+          # Body as base64, after HTTP decompression. Up to 20 MiB decoded.
           sig { returns(String) }
           attr_accessor :base64
 
@@ -356,8 +364,7 @@ module ContextDev
             )
           end
           def self.new(
-            # Original response body as base64, after HTTP decompression. Maximum decoded
-            # size: 20 MiB.
+            # Body as base64, after HTTP decompression. Up to 20 MiB decoded.
             base64:,
             content_type:
           )
@@ -391,9 +398,7 @@ module ContextDev
         end
         attr_accessor :status
 
-        # Cache outcome for this response. Composite responses are hits only when every
-        # cache-controlled fetch contributing to the output was a hit; age_ms is the
-        # oldest contributing hit.
+        # Whether this response came from cache.
         sig do
           params(
             age_ms: Integer,
@@ -479,25 +484,44 @@ module ContextDev
         sig { returns(T::Boolean) }
         attr_accessor :requested
 
-        # True when retrieved, false when retrieval failed, and null when not requested.
+        # `true` if returned, `false` if it failed, `null` if not requested.
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :success
 
-        # Relevant Markdown excerpts for your question or topic, in page order. Headings
-        # in square brackets supply necessary context; ellipses mark omitted portions.
-        # Empty when the page has no text.
+        # Why the output failed. Present only when `success` is `false`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :error_code
+
+        sig { params(error_code: String).void }
+        attr_writer :error_code
+
+        # Explanation of the failure and possible next steps.
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
+        # Relevant Markdown excerpts in page order. `[Heading]` adds context; `…` marks
+        # omitted text.
         sig do
           params(
             data: T.nilable(T::Array[String]),
             requested: T::Boolean,
-            success: T.nilable(T::Boolean)
+            success: T.nilable(T::Boolean),
+            error_code: String,
+            message: String
           ).returns(T.attached_class)
         end
         def self.new(
           data:,
           requested:,
-          # True when retrieved, false when retrieval failed, and null when not requested.
-          success:
+          # `true` if returned, `false` if it failed, `null` if not requested.
+          success:,
+          # Why the output failed. Present only when `success` is `false`.
+          error_code: nil,
+          # Explanation of the failure and possible next steps.
+          message: nil
         )
         end
 
@@ -506,7 +530,9 @@ module ContextDev
             {
               data: T.nilable(T::Array[String]),
               requested: T::Boolean,
-              success: T.nilable(T::Boolean)
+              success: T.nilable(T::Boolean),
+              error_code: String,
+              message: String
             }
           )
         end
@@ -529,23 +555,43 @@ module ContextDev
         sig { returns(T::Boolean) }
         attr_accessor :requested
 
-        # True when retrieved, false when retrieval failed, and null when not requested.
+        # `true` if returned, `false` if it failed, `null` if not requested.
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :success
 
+        # Why the output failed. Present only when `success` is `false`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :error_code
+
+        sig { params(error_code: String).void }
+        attr_writer :error_code
+
+        # Explanation of the failure and possible next steps.
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
         # Rendered HTML after content filters.
         sig do
           params(
             data: T.nilable(String),
             requested: T::Boolean,
-            success: T.nilable(T::Boolean)
+            success: T.nilable(T::Boolean),
+            error_code: String,
+            message: String
           ).returns(T.attached_class)
         end
         def self.new(
           data:,
           requested:,
-          # True when retrieved, false when retrieval failed, and null when not requested.
-          success:
+          # `true` if returned, `false` if it failed, `null` if not requested.
+          success:,
+          # Why the output failed. Present only when `success` is `false`.
+          error_code: nil,
+          # Explanation of the failure and possible next steps.
+          message: nil
         )
         end
 
@@ -554,7 +600,9 @@ module ContextDev
             {
               data: T.nilable(String),
               requested: T::Boolean,
-              success: T.nilable(T::Boolean)
+              success: T.nilable(T::Boolean),
+              error_code: String,
+              message: String
             }
           )
         end
@@ -583,11 +631,25 @@ module ContextDev
         sig { returns(T::Boolean) }
         attr_accessor :requested
 
-        # True when retrieved, false when retrieval failed, and null when not requested.
+        # `true` if returned, `false` if it failed, `null` if not requested.
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :success
 
-        # Images after content filters. Empty when none are found.
+        # Why the output failed. Present only when `success` is `false`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :error_code
+
+        sig { params(error_code: String).void }
+        attr_writer :error_code
+
+        # Explanation of the failure and possible next steps.
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
+        # Images after content filters. `[]` when none are found.
         sig do
           params(
             data:
@@ -597,14 +659,20 @@ module ContextDev
                 ]
               ),
             requested: T::Boolean,
-            success: T.nilable(T::Boolean)
+            success: T.nilable(T::Boolean),
+            error_code: String,
+            message: String
           ).returns(T.attached_class)
         end
         def self.new(
           data:,
           requested:,
-          # True when retrieved, false when retrieval failed, and null when not requested.
-          success:
+          # `true` if returned, `false` if it failed, `null` if not requested.
+          success:,
+          # Why the output failed. Present only when `success` is `false`.
+          error_code: nil,
+          # Explanation of the failure and possible next steps.
+          message: nil
         )
         end
 
@@ -616,7 +684,9 @@ module ContextDev
                   T::Array[ContextDev::Models::WebScrapeResponse::Images::Data]
                 ),
               requested: T::Boolean,
-              success: T.nilable(T::Boolean)
+              success: T.nilable(T::Boolean),
+              error_code: String,
+              message: String
             }
           )
         end
@@ -657,8 +727,8 @@ module ContextDev
           end
           attr_writer :classification
 
-          # Hosted copy when file enrichment is requested and zdr is disabled. Valid for 24
-          # hours from the original capture.
+          # Hosted image URL, valid for 24 hours after capture. Requires `file` enrichment
+          # and ZDR disabled.
           sig { returns(T.nilable(String)) }
           attr_reader :file_url
 
@@ -694,8 +764,8 @@ module ContextDev
             # Image URL, or a data URI for inline images.
             url:,
             classification: nil,
-            # Hosted copy when file enrichment is requested and zdr is disabled. Valid for 24
-            # hours from the original capture.
+            # Hosted image URL, valid for 24 hours after capture. Requires `file` enrichment
+            # and ZDR disabled.
             file_url: nil,
             height: nil,
             width: nil
@@ -799,23 +869,43 @@ module ContextDev
         sig { returns(T::Boolean) }
         attr_accessor :requested
 
-        # True when retrieved, false when retrieval failed, and null when not requested.
+        # `true` if returned, `false` if it failed, `null` if not requested.
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :success
 
-        # Page data extracted using your schema.
+        # Why the output failed. Present only when `success` is `false`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :error_code
+
+        sig { params(error_code: String).void }
+        attr_writer :error_code
+
+        # Explanation of the failure and possible next steps.
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
+        # Object matching `jsonParams.schema`.
         sig do
           params(
             data: T.nilable(T::Hash[Symbol, T.anything]),
             requested: T::Boolean,
-            success: T.nilable(T::Boolean)
+            success: T.nilable(T::Boolean),
+            error_code: String,
+            message: String
           ).returns(T.attached_class)
         end
         def self.new(
           data:,
           requested:,
-          # True when retrieved, false when retrieval failed, and null when not requested.
-          success:
+          # `true` if returned, `false` if it failed, `null` if not requested.
+          success:,
+          # Why the output failed. Present only when `success` is `false`.
+          error_code: nil,
+          # Explanation of the failure and possible next steps.
+          message: nil
         )
         end
 
@@ -824,7 +914,9 @@ module ContextDev
             {
               data: T.nilable(T::Hash[Symbol, T.anything]),
               requested: T::Boolean,
-              success: T.nilable(T::Boolean)
+              success: T.nilable(T::Boolean),
+              error_code: String,
+              message: String
             }
           )
         end
@@ -847,23 +939,43 @@ module ContextDev
         sig { returns(T::Boolean) }
         attr_accessor :requested
 
-        # True when retrieved, false when retrieval failed, and null when not requested.
+        # `true` if returned, `false` if it failed, `null` if not requested.
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :success
 
+        # Why the output failed. Present only when `success` is `false`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :error_code
+
+        sig { params(error_code: String).void }
+        attr_writer :error_code
+
+        # Explanation of the failure and possible next steps.
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
         # Markdown after content filters.
         sig do
           params(
             data: T.nilable(String),
             requested: T::Boolean,
-            success: T.nilable(T::Boolean)
+            success: T.nilable(T::Boolean),
+            error_code: String,
+            message: String
           ).returns(T.attached_class)
         end
         def self.new(
           data:,
           requested:,
-          # True when retrieved, false when retrieval failed, and null when not requested.
-          success:
+          # `true` if returned, `false` if it failed, `null` if not requested.
+          success:,
+          # Why the output failed. Present only when `success` is `false`.
+          error_code: nil,
+          # Explanation of the failure and possible next steps.
+          message: nil
         )
         end
 
@@ -872,7 +984,9 @@ module ContextDev
             {
               data: T.nilable(String),
               requested: T::Boolean,
-              success: T.nilable(T::Boolean)
+              success: T.nilable(T::Boolean),
+              error_code: String,
+              message: String
             }
           )
         end
@@ -963,8 +1077,7 @@ module ContextDev
         sig { params(favicon: String).void }
         attr_writer :favicon
 
-        # Page headings (h1–h6) in document order, extracted from the unfiltered document.
-        # Capped at the first 500 headings. Omitted when the page has none.
+        # Up to 500 h1–h6 headings in document order, before content filtering.
         sig do
           returns(
             T.nilable(
@@ -1095,7 +1208,7 @@ module ContextDev
         end
         attr_writer :twitter
 
-        # Page details, when available.
+        # Page metadata. Fields are omitted when not found.
         sig do
           params(
             additional_meta:
@@ -1149,8 +1262,7 @@ module ContextDev
           description: nil,
           # Resolved favicon URL, when present.
           favicon: nil,
-          # Page headings (h1–h6) in document order, extracted from the unfiltered document.
-          # Capped at the first 500 headings. Omitted when the page has none.
+          # Up to 500 h1–h6 headings in document order, before content filtering.
           headings: nil,
           # Primary resolved preview image from Open Graph, Twitter, or image metadata.
           image: nil,
@@ -1398,23 +1510,44 @@ module ContextDev
         sig { returns(T::Boolean) }
         attr_accessor :requested
 
-        # True when retrieved, false when retrieval failed, and null when not requested.
+        # `true` if returned, `false` if it failed, `null` if not requested.
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :success
 
-        # Fields produced by parseParams.rules, after shared content filters.
+        # Why the output failed. Present only when `success` is `false`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :error_code
+
+        sig { params(error_code: String).void }
+        attr_writer :error_code
+
+        # Explanation of the failure and possible next steps.
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
+        # Fields from `parseParams.rules`, after content filters. Unmatched fields are
+        # `null` (`[]` for lists).
         sig do
           params(
             data: T.nilable(T::Hash[Symbol, T.anything]),
             requested: T::Boolean,
-            success: T.nilable(T::Boolean)
+            success: T.nilable(T::Boolean),
+            error_code: String,
+            message: String
           ).returns(T.attached_class)
         end
         def self.new(
           data:,
           requested:,
-          # True when retrieved, false when retrieval failed, and null when not requested.
-          success:
+          # `true` if returned, `false` if it failed, `null` if not requested.
+          success:,
+          # Why the output failed. Present only when `success` is `false`.
+          error_code: nil,
+          # Explanation of the failure and possible next steps.
+          message: nil
         )
         end
 
@@ -1423,7 +1556,9 @@ module ContextDev
             {
               data: T.nilable(T::Hash[Symbol, T.anything]),
               requested: T::Boolean,
-              success: T.nilable(T::Boolean)
+              success: T.nilable(T::Boolean),
+              error_code: String,
+              message: String
             }
           )
         end
@@ -1460,10 +1595,24 @@ module ContextDev
         sig { returns(T::Boolean) }
         attr_accessor :requested
 
-        # True when retrieved, false when retrieval failed, and null when not requested.
+        # `true` if returned, `false` if it failed, `null` if not requested.
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :success
 
+        # Why the output failed. Present only when `success` is `false`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :error_code
+
+        sig { params(error_code: String).void }
+        attr_writer :error_code
+
+        # Explanation of the failure and possible next steps.
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
         # Product details found on the page.
         sig do
           params(
@@ -1472,14 +1621,20 @@ module ContextDev
                 ContextDev::Models::WebScrapeResponse::Product::Data::OrHash
               ),
             requested: T::Boolean,
-            success: T.nilable(T::Boolean)
+            success: T.nilable(T::Boolean),
+            error_code: String,
+            message: String
           ).returns(T.attached_class)
         end
         def self.new(
           data:,
           requested:,
-          # True when retrieved, false when retrieval failed, and null when not requested.
-          success:
+          # `true` if returned, `false` if it failed, `null` if not requested.
+          success:,
+          # Why the output failed. Present only when `success` is `false`.
+          error_code: nil,
+          # Explanation of the failure and possible next steps.
+          message: nil
         )
         end
 
@@ -1489,7 +1644,9 @@ module ContextDev
               data:
                 T.nilable(ContextDev::Models::WebScrapeResponse::Product::Data),
               requested: T::Boolean,
-              success: T.nilable(T::Boolean)
+              success: T.nilable(T::Boolean),
+              error_code: String,
+              message: String
             }
           )
         end
@@ -1880,23 +2037,43 @@ module ContextDev
         sig { returns(T::Boolean) }
         attr_accessor :requested
 
-        # True when retrieved, false when retrieval failed, and null when not requested.
+        # `true` if returned, `false` if it failed, `null` if not requested.
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :success
 
-        # An image data URL. Use directly as an image src.
+        # Why the output failed. Present only when `success` is `false`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :error_code
+
+        sig { params(error_code: String).void }
+        attr_writer :error_code
+
+        # Explanation of the failure and possible next steps.
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
+        # Screenshot as a base64 image data URL.
         sig do
           params(
             data: T.nilable(String),
             requested: T::Boolean,
-            success: T.nilable(T::Boolean)
+            success: T.nilable(T::Boolean),
+            error_code: String,
+            message: String
           ).returns(T.attached_class)
         end
         def self.new(
           data:,
           requested:,
-          # True when retrieved, false when retrieval failed, and null when not requested.
-          success:
+          # `true` if returned, `false` if it failed, `null` if not requested.
+          success:,
+          # Why the output failed. Present only when `success` is `false`.
+          error_code: nil,
+          # Explanation of the failure and possible next steps.
+          message: nil
         )
         end
 
@@ -1905,7 +2082,9 @@ module ContextDev
             {
               data: T.nilable(String),
               requested: T::Boolean,
-              success: T.nilable(T::Boolean)
+              success: T.nilable(T::Boolean),
+              error_code: String,
+              message: String
             }
           )
         end
@@ -1913,11 +2092,8 @@ module ContextDev
         end
       end
 
-      # Present when at least one requested output succeeds while another fails, or when
-      # successful outputs come from a page that is still loading or images returned
-      # before processing finished. Absent when every requested output fails. Check each
-      # output's success field for its result. Valid captured pieces may be cached
-      # independently; failed retrievals and incomplete captures are not cached.
+      # True when at least one requested output succeeds but the response has failed or
+      # incomplete outputs. Absent when all requested outputs fail.
       module IsPartial
         extend ContextDev::Internal::Type::Enum
 
@@ -1953,7 +2129,7 @@ module ContextDev
             )
           end
 
-        # Credits used by this request.
+        # Credits charged for this request.
         sig { returns(Integer) }
         attr_accessor :credits_consumed
 
@@ -1961,14 +2137,14 @@ module ContextDev
         sig { returns(Integer) }
         attr_accessor :credits_remaining
 
-        # Credit usage, included whenever a valid API key is provided.
+        # Credits this request used and your remaining balance.
         sig do
           params(credits_consumed: Integer, credits_remaining: Integer).returns(
             T.attached_class
           )
         end
         def self.new(
-          # Credits used by this request.
+          # Credits charged for this request.
           credits_consumed:,
           # Credits remaining for your organization.
           credits_remaining: