context.dev 2.21.0 → 2.22.0

data/rbi/context_dev/models/web_web_crawl_md_params.rbi

@@ -11,12 +11,11 @@ module ContextDev
           T.any(ContextDev::WebWebCrawlMdParams, ContextDev::Internal::AnyHash)
         end
 
-      # The starting URL for the crawl (must include http:// or https:// protocol)
+      # Start URL, including `http://` or `https://`.
       sig { returns(String) }
       attr_accessor :url
 
-      # Fetch the target page through a residential proxy in this country (ISO 3166-1
-      # alpha-2).
+      # Fetch from this country (ISO 3166-1 alpha-2).
       sig do
         returns(T.nilable(ContextDev::WebWebCrawlMdParams::Country::OrSymbol))
       end
@@ -27,9 +26,7 @@ module ContextDev
       end
       attr_writer :country
 
-      # CSS selectors to remove before each crawled page is converted to Markdown.
-      # Applied after includeSelectors. Exclusion takes precedence: an element matching
-      # both is removed. Examples: "nav", "footer", ".ad-banner", "[aria-hidden=true]".
+      # Remove matching elements after inclusions. Exclusions take precedence.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :exclude_selectors
 
@@ -67,19 +64,14 @@ module ContextDev
       sig { params(include_links: T::Boolean).void }
       attr_writer :include_links
 
-      # CSS selectors. When provided, only matching HTML subtrees (and their
-      # descendants) are kept before each crawled page is converted to Markdown. When
-      # omitted, the entire document is kept. Examples: "article.main", "#content",
-      # "[role=main]".
+      # Keep matching HTML subtrees before converting each page to Markdown.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :include_selectors
 
       sig { params(include_selectors: T::Array[String]).void }
       attr_writer :include_selectors
 
-      # Return a cached result if a prior scrape for the same parameters exists and is
-      # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
-      # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
+      # Maximum cache age in milliseconds. Defaults to 1 day; `0` fetches fresh.
       sig { returns(T.nilable(Integer)) }
       attr_reader :max_age_ms
 
@@ -93,24 +85,22 @@ module ContextDev
       sig { params(max_depth: Integer).void }
       attr_writer :max_depth
 
-      # Maximum number of pages to crawl. Hard cap: 500.
+      # Maximum pages to crawl.
       sig { returns(T.nilable(Integer)) }
       attr_reader :max_pages
 
       sig { params(max_pages: Integer).void }
       attr_writer :max_pages
 
-      # PDF parsing controls. Use start/end to limit text extraction and embedded-image
-      # detection/OCR to an inclusive 1-based page range.
+      # PDF handling. `start`/`end` limit parsing to an inclusive, 1-based page range.
       sig { returns(T.nilable(ContextDev::WebWebCrawlMdParams::Pdf)) }
       attr_reader :pdf
 
       sig { params(pdf: ContextDev::WebWebCrawlMdParams::Pdf::OrHash).void }
       attr_writer :pdf
 
-      # When true, waits briefly for CSS and transition animations to settle before
-      # extracting each crawled page. Defaults to false. This adds a bit of latency in
-      # exchange for more stable output on animated pages.
+      # Wait briefly for CSS animations and transitions to settle before reading each
+      # page.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :settle_animations
 
@@ -124,26 +114,22 @@ module ContextDev
       sig { params(shorten_base64_images: T::Boolean).void }
       attr_writer :shorten_base64_images
 
-      # Soft time budget for the crawl in milliseconds. After each scrape, the crawler
-      # checks the elapsed time and, if exceeded, returns the pages collected so far
-      # instead of continuing. Min: 10000 (10s). Max: 110000 (110s). Default: 80000
-      # (80s).
+      # Soft crawl deadline in milliseconds. Returns pages collected before the next
+      # deadline check.
       sig { returns(T.nilable(Integer)) }
       attr_reader :stop_after_ms
 
       sig { params(stop_after_ms: Integer).void }
       attr_writer :stop_after_ms
 
-      # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      # Labels for filtering usage in the dashboard.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :tags
 
       sig { params(tags: T::Array[String]).void }
       attr_writer :tags
 
-      # Optional request deadline and behavior on timeout. For GET requests, use
-      # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-      # timeoutOpts object.
+      # Request deadline and what to return when it passes.
       sig { returns(T.nilable(ContextDev::WebWebCrawlMdParams::TimeoutOpts)) }
       attr_reader :timeout_opts
 
@@ -179,10 +165,8 @@ module ContextDev
       sig { params(wait_for_ms: Integer).void }
       attr_writer :wait_for_ms
 
-      # Set to enabled to bypass shared caches and omit request and response content
-      # from retained usage logs. Requires zero data retention to be enabled for your
-      # organization (contact support@context.dev), otherwise the request fails with
-      # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
+      # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
+      # your organization has ZDR.
       sig { returns(T.nilable(ContextDev::WebWebCrawlMdParams::Zdr::OrSymbol)) }
       attr_reader :zdr
 
@@ -216,14 +200,11 @@ module ContextDev
         ).returns(T.attached_class)
       end
       def self.new(
-        # The starting URL for the crawl (must include http:// or https:// protocol)
+        # Start URL, including `http://` or `https://`.
         url:,
-        # Fetch the target page through a residential proxy in this country (ISO 3166-1
-        # alpha-2).
+        # Fetch from this country (ISO 3166-1 alpha-2).
         country: nil,
-        # CSS selectors to remove before each crawled page is converted to Markdown.
-        # Applied after includeSelectors. Exclusion takes precedence: an element matching
-        # both is removed. Examples: "nav", "footer", ".ad-banner", "[aria-hidden=true]".
+        # Remove matching elements after inclusions. Exclusions take precedence.
         exclude_selectors: nil,
         # When true, follow links on subdomains of the starting URL's domain (e.g.
         # docs.example.com when starting from example.com). www and apex are always
@@ -236,38 +217,27 @@ module ContextDev
         include_images: nil,
         # Preserve hyperlinks in the Markdown output
         include_links: nil,
-        # CSS selectors. When provided, only matching HTML subtrees (and their
-        # descendants) are kept before each crawled page is converted to Markdown. When
-        # omitted, the entire document is kept. Examples: "article.main", "#content",
-        # "[role=main]".
+        # Keep matching HTML subtrees before converting each page to Markdown.
         include_selectors: nil,
-        # Return a cached result if a prior scrape for the same parameters exists and is
-        # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
-        # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
+        # Maximum cache age in milliseconds. Defaults to 1 day; `0` fetches fresh.
         max_age_ms: nil,
         # Maximum link depth from the starting URL (0 = only the starting page)
         max_depth: nil,
-        # Maximum number of pages to crawl. Hard cap: 500.
+        # Maximum pages to crawl.
         max_pages: nil,
-        # PDF parsing controls. Use start/end to limit text extraction and embedded-image
-        # detection/OCR to an inclusive 1-based page range.
+        # PDF handling. `start`/`end` limit parsing to an inclusive, 1-based page range.
         pdf: nil,
-        # When true, waits briefly for CSS and transition animations to settle before
-        # extracting each crawled page. Defaults to false. This adds a bit of latency in
-        # exchange for more stable output on animated pages.
+        # Wait briefly for CSS animations and transitions to settle before reading each
+        # page.
         settle_animations: nil,
         # Truncate base64-encoded image data in the Markdown output
         shorten_base64_images: nil,
-        # Soft time budget for the crawl in milliseconds. After each scrape, the crawler
-        # checks the elapsed time and, if exceeded, returns the pages collected so far
-        # instead of continuing. Min: 10000 (10s). Max: 110000 (110s). Default: 80000
-        # (80s).
+        # Soft crawl deadline in milliseconds. Returns pages collected before the next
+        # deadline check.
         stop_after_ms: nil,
-        # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+        # Labels for filtering usage in the dashboard.
         tags: nil,
-        # Optional request deadline and behavior on timeout. For GET requests, use
-        # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-        # timeoutOpts object.
+        # Request deadline and what to return when it passes.
         timeout_opts: nil,
         # Regex pattern. Only URLs matching this pattern will be followed and scraped. An
         # automatic prefix scope in the form ^<starting URL> follows a redirect of the
@@ -279,10 +249,8 @@ module ContextDev
         # Browser wait time in milliseconds after initial page load for each crawled page.
         # Defaults to 3500 (3.5 seconds). Min: 0. Max: 30000 (30 seconds).
         wait_for_ms: nil,
-        # Set to enabled to bypass shared caches and omit request and response content
-        # from retained usage logs. Requires zero data retention to be enabled for your
-        # organization (contact support@context.dev), otherwise the request fails with
-        # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
+        # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
+        # your organization has ZDR.
         zdr: nil,
         request_options: {}
       )
@@ -319,8 +287,7 @@ module ContextDev
       def to_hash
       end
 
-      # Fetch the target page through a residential proxy in this country (ISO 3166-1
-      # alpha-2).
+      # Fetch from this country (ISO 3166-1 alpha-2).
       module Country
         extend ContextDev::Internal::Type::Enum
 
@@ -561,10 +528,7 @@ module ContextDev
         sig { params(end_: Integer).void }
         attr_writer :end_
 
-        # When true, OCR the selected PDF pages that have no usable text layer (scans),
-        # replacing each recovered page's text with the OCR result while pages with a real
-        # text layer keep it. Billed at 1 credit per page OCR actually recovered, on top
-        # of the base request cost.
+        # Read scanned PDF pages with OCR; preserve pages that already contain text.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :ocr
 
@@ -586,8 +550,7 @@ module ContextDev
         sig { params(start: Integer).void }
         attr_writer :start
 
-        # PDF parsing controls. Use start/end to limit text extraction and embedded-image
-        # detection/OCR to an inclusive 1-based page range.
+        # PDF handling. `start`/`end` limit parsing to an inclusive, 1-based page range.
         sig do
           params(
             end_: Integer,
@@ -600,10 +563,7 @@ module ContextDev
           # Last 1-based PDF page to parse. When omitted, parsing ends at the last page.
           # Must be greater than or equal to start when both are provided.
           end_: nil,
-          # When true, OCR the selected PDF pages that have no usable text layer (scans),
-          # replacing each recovered page's text with the OCR result while pages with a real
-          # text layer keep it. Billed at 1 credit per page OCR actually recovered, on top
-          # of the base request cost.
+          # Read scanned PDF pages with OCR; preserve pages that already contain text.
           ocr: nil,
           # When true, PDF pages are fetched and parsed. When false, PDF pages are skipped
           # entirely (not included in results and not counted as failures).
@@ -636,14 +596,12 @@ module ContextDev
             )
           end
 
-        # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        # Deadline in milliseconds.
         sig { returns(Integer) }
         attr_accessor :milliseconds
 
-        # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-        # credits. "return-partial" returns usable results collected so far; if none are
-        # available, the request still fails without charging credits. Partial results are
-        # not cached as complete results.
+        # "fail" returns 408 at the deadline. "return-partial" returns available results;
+        # inspect the response’s partial flag.
         sig do
           returns(
             T.nilable(
@@ -661,9 +619,7 @@ module ContextDev
         end
         attr_writer :behavior
 
-        # Optional request deadline and behavior on timeout. For GET requests, use
-        # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-        # timeoutOpts object.
+        # Request deadline and what to return when it passes.
         sig do
           params(
             milliseconds: Integer,
@@ -672,12 +628,10 @@ module ContextDev
           ).returns(T.attached_class)
         end
         def self.new(
-          # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+          # Deadline in milliseconds.
           milliseconds:,
-          # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-          # credits. "return-partial" returns usable results collected so far; if none are
-          # available, the request still fails without charging credits. Partial results are
-          # not cached as complete results.
+          # "fail" returns 408 at the deadline. "return-partial" returns available results;
+          # inspect the response’s partial flag.
           behavior: nil
         )
         end
@@ -694,10 +648,8 @@ module ContextDev
         def to_hash
         end
 
-        # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-        # credits. "return-partial" returns usable results collected so far; if none are
-        # available, the request still fails without charging credits. Partial results are
-        # not cached as complete results.
+        # "fail" returns 408 at the deadline. "return-partial" returns available results;
+        # inspect the response’s partial flag.
         module Behavior
           extend ContextDev::Internal::Type::Enum
 
@@ -733,10 +685,8 @@ module ContextDev
         end
       end
 
-      # Set to enabled to bypass shared caches and omit request and response content
-      # from retained usage logs. Requires zero data retention to be enabled for your
-      # organization (contact support@context.dev), otherwise the request fails with
-      # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
+      # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
+      # your organization has ZDR.
       module Zdr
         extend ContextDev::Internal::Type::Enum
 

data/rbi/context_dev/models/web_web_crawl_md_response.rbi

@@ -11,9 +11,7 @@ module ContextDev
           )
         end
 
-      # 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::WebWebCrawlMdResponse::CacheMetadata) }
       attr_reader :cache_metadata
 
@@ -35,8 +33,8 @@ module ContextDev
       end
       attr_writer :metadata
 
-      # 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
 
@@ -45,7 +43,7 @@ module ContextDev
       end
       attr_accessor :results
 
-      # 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::WebWebCrawlMdResponse::KeyMetadata)
@@ -84,16 +82,14 @@ module ContextDev
         ).returns(T.attached_class)
       end
       def self.new(
-        # 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:,
         metadata:,
-        # 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:,
         results:,
-        # Credit usage, included whenever a valid API key is provided.
+        # Credits this request used and your remaining balance.
         key_metadata: nil,
         # True when timeoutOpts.behavior=return-partial returned the usable results
         # collected before the deadline. Partial collections are not cached as complete
@@ -142,9 +138,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,
@@ -899,7 +893,7 @@ module ContextDev
             )
           end
 
-        # Credits used by this request.
+        # Credits charged for this request.
         sig { returns(Integer) }
         attr_accessor :credits_consumed
 
@@ -907,14 +901,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:

data/rbi/context_dev/models/webhook_delivery.rbi

@@ -35,9 +35,7 @@ module ContextDev
       sig { returns(T.nilable(Integer)) }
       attr_accessor :http_status
 
-      # Delivery outcome. delivered means any 2xx response; rejected means a non-2xx
-      # response; failed means no HTTP response was received; skipped_unsafe_url means
-      # the URL failed the public-endpoint safety check.
+      # Outcome of the delivery attempt. Any 2xx response counts as delivered.
       sig { returns(ContextDev::WebhookDelivery::Status::TaggedSymbol) }
       attr_accessor :status
 
@@ -70,9 +68,7 @@ module ContextDev
         # The endpoint's final HTTP response status, or null when no response was
         # received.
         http_status:,
-        # Delivery outcome. delivered means any 2xx response; rejected means a non-2xx
-        # response; failed means no HTTP response was received; skipped_unsafe_url means
-        # the URL failed the public-endpoint safety check.
+        # Outcome of the delivery attempt. Any 2xx response counts as delivered.
         status:,
         # Delivery ID for status checks and retries, when available.
         delivery_id: nil
@@ -148,9 +144,7 @@ module ContextDev
         end
       end
 
-      # Delivery outcome. delivered means any 2xx response; rejected means a non-2xx
-      # response; failed means no HTTP response was received; skipped_unsafe_url means
-      # the URL failed the public-endpoint safety check.
+      # Outcome of the delivery attempt. Any 2xx response counts as delivered.
       module Status
         extend ContextDev::Internal::Type::Enum
 

data/rbi/context_dev/models/webhooks/attempt.rbi

@@ -36,7 +36,7 @@ module ContextDev
         sig { returns(Time) }
         attr_accessor :started_at
 
-        # What started this attempt.
+        # `initial`, `automatic` (scheduled retry), or `manual` (Retry endpoint).
         sig { returns(ContextDev::Webhooks::Attempt::Trigger::TaggedSymbol) }
         attr_accessor :trigger
 
@@ -66,7 +66,7 @@ module ContextDev
           http_status:,
           # Attempt start time.
           started_at:,
-          # What started this attempt.
+          # `initial`, `automatic` (scheduled retry), or `manual` (Retry endpoint).
           trigger:,
           # URL used for this attempt.
           url:
@@ -123,7 +123,7 @@ module ContextDev
           end
         end
 
-        # What started this attempt.
+        # `initial`, `automatic` (scheduled retry), or `manual` (Retry endpoint).
         module Trigger
           extend ContextDev::Internal::Type::Enum
 

data/rbi/context_dev/models/webhooks/delivery.rbi

@@ -63,7 +63,7 @@ module ContextDev
         sig { params(retry_: ContextDev::RetryConfig::OrHash).void }
         attr_writer :retry_
 
-        # Manual retry deadline, seven days after event creation.
+        # Last time you can retry manually (7 days after the event).
         sig { returns(Time) }
         attr_accessor :retry_expires_at
 
@@ -71,7 +71,8 @@ module ContextDev
         sig { returns(ContextDev::Webhooks::Delivery::Source::Variants) }
         attr_accessor :source
 
-        # Current delivery status.
+        # `pending`, `delivering`, `retrying`, `delivered`, `failed`, or `cancelled`
+        # (source or its webhook was removed).
         sig { returns(ContextDev::Webhooks::Delivery::Status::TaggedSymbol) }
         attr_accessor :status
 
@@ -120,11 +121,12 @@ module ContextDev
           next_attempt_at:,
           # Webhook retry settings. Use {} for the default schedule.
           retry_:,
-          # Manual retry deadline, seven days after event creation.
+          # Last time you can retry manually (7 days after the event).
           retry_expires_at:,
           # Batch or monitor run that produced the event.
           source:,
-          # Current delivery status.
+          # `pending`, `delivering`, `retrying`, `delivered`, `failed`, or `cancelled`
+          # (source or its webhook was removed).
           status:,
           # Webhook destination URL.
           url:
@@ -257,7 +259,7 @@ module ContextDev
             sig { returns(String) }
             attr_accessor :batch_id
 
-            # Delivery source.
+            # Which deliveries to list: `batch` or `monitor`.
             sig do
               returns(
                 ContextDev::Webhooks::Delivery::Source::Batch::Type::TaggedSymbol
@@ -275,7 +277,7 @@ module ContextDev
             def self.new(
               # Batch ID.
               batch_id:,
-              # Delivery source.
+              # Which deliveries to list: `batch` or `monitor`.
               type:
             )
             end
@@ -292,7 +294,7 @@ module ContextDev
             def to_hash
             end
 
-            # Delivery source.
+            # Which deliveries to list: `batch` or `monitor`.
             module Type
               extend ContextDev::Internal::Type::Enum
 
@@ -340,7 +342,7 @@ module ContextDev
             sig { returns(String) }
             attr_accessor :run_id
 
-            # Delivery source.
+            # Which deliveries to list: `batch` or `monitor`.
             sig do
               returns(
                 ContextDev::Webhooks::Delivery::Source::Monitor::Type::TaggedSymbol
@@ -361,7 +363,7 @@ module ContextDev
               monitor_id:,
               # Monitor run ID.
               run_id:,
-              # Delivery source.
+              # Which deliveries to list: `batch` or `monitor`.
               type:
             )
             end
@@ -379,7 +381,7 @@ module ContextDev
             def to_hash
             end
 
-            # Delivery source.
+            # Which deliveries to list: `batch` or `monitor`.
             module Type
               extend ContextDev::Internal::Type::Enum
 
@@ -419,7 +421,8 @@ module ContextDev
           end
         end
 
-        # Current delivery status.
+        # `pending`, `delivering`, `retrying`, `delivered`, `failed`, or `cancelled`
+        # (source or its webhook was removed).
         module Status
           extend ContextDev::Internal::Type::Enum
 

data/rbi/context_dev/models/webhooks/delivery_list_attempts_params.rbi

@@ -33,8 +33,7 @@ module ContextDev
         sig { params(limit: Integer).void }
         attr_writer :limit
 
-        # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
-        # characters.
+        # Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :tags
 
@@ -57,8 +56,7 @@ module ContextDev
           cursor: nil,
           # Number of attempts to return.
           limit: nil,
-          # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
-          # characters.
+          # Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
           tags: nil,
           request_options: {}
         )

data/rbi/context_dev/models/webhooks/delivery_list_attempts_response.rbi

@@ -24,12 +24,12 @@ module ContextDev
         sig { returns(T.nilable(String)) }
         attr_accessor :next_cursor
 
-        # 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
 
-        # Credit usage, included whenever a valid API key is provided.
+        # Credits this request used and your remaining balance.
         sig do
           returns(
             T.nilable(
@@ -64,10 +64,10 @@ module ContextDev
           has_more:,
           # Next page cursor, or null on the last page.
           next_cursor:,
-          # 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:,
-          # Credit usage, included whenever a valid API key is provided.
+          # Credits this request used and your remaining balance.
           key_metadata: nil
         )
         end
@@ -96,7 +96,7 @@ module ContextDev
               )
             end
 
-          # Credits used by this request.
+          # Credits charged for this request.
           sig { returns(Integer) }
           attr_accessor :credits_consumed
 
@@ -104,7 +104,7 @@ 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,
@@ -112,7 +112,7 @@ module ContextDev
             ).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: