context.dev 2.21.0 → 2.22.0

data/lib/context_dev/models/utility_prefetch_params.rb

@@ -14,37 +14,31 @@ module ContextDev
       required :identifier, union: -> { ContextDev::UtilityPrefetchParams::Identifier }
 
       # @!attribute type
-      #   What to prefetch: 'brand' warms the brand data cache, 'styleguide' warms the
-      #   styleguide cache.
+      #   Data to prefetch.
       #
       #   @return [Symbol, ContextDev::Models::UtilityPrefetchParams::Type]
       required :type, enum: -> { ContextDev::UtilityPrefetchParams::Type }
 
       # @!attribute tags
-      #   Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      #   Labels for filtering usage in the dashboard.
       #
       #   @return [Array<String>, nil]
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
 
       # @!attribute timeout_opts
-      #   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.
       #
       #   @return [ContextDev::Models::UtilityPrefetchParams::TimeoutOpts, nil]
       optional :timeout_opts, -> { ContextDev::UtilityPrefetchParams::TimeoutOpts }, api_name: :timeoutOpts
 
       # @!method initialize(identifier:, type:, tags: nil, timeout_opts: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {ContextDev::Models::UtilityPrefetchParams} for more details.
-      #
       #   @param identifier [ContextDev::Models::UtilityPrefetchParams::Identifier::UtilityPrefetchDomainIdentifier, ContextDev::Models::UtilityPrefetchParams::Identifier::UtilityPrefetchEmailIdentifier] Identifier of the target to prefetch. Provide exactly one of domain or email.
       #
-      #   @param type [Symbol, ContextDev::Models::UtilityPrefetchParams::Type] What to prefetch: 'brand' warms the brand data cache, 'styleguide' warms the sty
+      #   @param type [Symbol, ContextDev::Models::UtilityPrefetchParams::Type] Data to prefetch.
       #
-      #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      #   @param tags [Array<String>] Labels for filtering usage in the dashboard.
       #
-      #   @param timeout_opts [ContextDev::Models::UtilityPrefetchParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
+      #   @param timeout_opts [ContextDev::Models::UtilityPrefetchParams::TimeoutOpts] Request deadline and what to return when it passes.
       #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
 
@@ -60,7 +54,7 @@ module ContextDev
 
         class UtilityPrefetchDomainIdentifier < ContextDev::Internal::Type::BaseModel
           # @!attribute domain
-          #   Domain name to prefetch data for
+          #   Domain, e.g. `stripe.com`.
           #
           #   @return [String]
           required :domain, String
@@ -68,7 +62,7 @@ module ContextDev
           # @!method initialize(domain:)
           #   Prefetch by domain.
           #
-          #   @param domain [String] Domain name to prefetch data for
+          #   @param domain [String] Domain, e.g. `stripe.com`.
         end
 
         class UtilityPrefetchEmailIdentifier < ContextDev::Internal::Type::BaseModel
@@ -94,8 +88,7 @@ module ContextDev
         #   @return [Array(ContextDev::Models::UtilityPrefetchParams::Identifier::UtilityPrefetchDomainIdentifier, ContextDev::Models::UtilityPrefetchParams::Identifier::UtilityPrefetchEmailIdentifier)]
       end
 
-      # What to prefetch: 'brand' warms the brand data cache, 'styleguide' warms the
-      # styleguide cache.
+      # Data to prefetch.
       module Type
         extend ContextDev::Internal::Type::Enum
 
@@ -108,32 +101,25 @@ module ContextDev
 
       class TimeoutOpts < ContextDev::Internal::Type::BaseModel
         # @!attribute milliseconds
-        #   Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #   Deadline in milliseconds.
         #
         #   @return [Integer]
         required :milliseconds, Integer
 
         # @!attribute behavior
-        #   What to do at the deadline. This endpoint supports "fail": return 408
-        #   REQUEST_TIMEOUT without charging credits.
+        #   Only "fail" is supported: return 408 at the deadline.
         #
         #   @return [Symbol, ContextDev::Models::UtilityPrefetchParams::TimeoutOpts::Behavior, nil]
         optional :behavior, enum: -> { ContextDev::UtilityPrefetchParams::TimeoutOpts::Behavior }
 
         # @!method initialize(milliseconds:, behavior: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {ContextDev::Models::UtilityPrefetchParams::TimeoutOpts} for more details.
-        #
-        #   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.
         #
-        #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #   @param milliseconds [Integer] Deadline in milliseconds.
         #
-        #   @param behavior [Symbol, ContextDev::Models::UtilityPrefetchParams::TimeoutOpts::Behavior] What to do at the deadline. This endpoint supports "fail": return 408 REQUEST_TI
+        #   @param behavior [Symbol, ContextDev::Models::UtilityPrefetchParams::TimeoutOpts::Behavior] Only "fail" is supported: return 408 at the deadline.
 
-        # What to do at the deadline. This endpoint supports "fail": return 408
-        # REQUEST_TIMEOUT without charging credits.
+        # Only "fail" is supported: return 408 at the deadline.
         #
         # @see ContextDev::Models::UtilityPrefetchParams::TimeoutOpts#behavior
         module Behavior

data/lib/context_dev/models/utility_prefetch_response.rb

@@ -5,8 +5,8 @@ module ContextDev
     # @see ContextDev::Resources::Utility#prefetch
     class UtilityPrefetchResponse < ContextDev::Internal::Type::BaseModel
       # @!attribute request_id
-      #   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.
       #
       #   @return [String]
       required :request_id, String
@@ -18,7 +18,7 @@ module ContextDev
       optional :domain, String
 
       # @!attribute key_metadata
-      #   Credit usage, included whenever a valid API key is provided.
+      #   Credits this request used and your remaining balance.
       #
       #   @return [ContextDev::Models::UtilityPrefetchResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::UtilityPrefetchResponse::KeyMetadata }
@@ -30,7 +30,7 @@ module ContextDev
       optional :message, String
 
       # @!attribute status
-      #   Status of the response, e.g., 'ok'
+      #   Always `ok` on success.
       #
       #   @return [String, nil]
       optional :status, String
@@ -45,22 +45,22 @@ module ContextDev
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::UtilityPrefetchResponse} for more details.
       #
-      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #   @param request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
       #
       #   @param domain [String] The domain that was queued for prefetching
       #
-      #   @param key_metadata [ContextDev::Models::UtilityPrefetchResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+      #   @param key_metadata [ContextDev::Models::UtilityPrefetchResponse::KeyMetadata] Credits this request used and your remaining balance.
       #
       #   @param message [String] Success message
       #
-      #   @param status [String] Status of the response, e.g., 'ok'
+      #   @param status [String] Always `ok` on success.
       #
       #   @param type [Symbol, ContextDev::Models::UtilityPrefetchResponse::Type] The type of prefetch that was queued, echoed from the request
 
       # @see ContextDev::Models::UtilityPrefetchResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   Credits used by this request.
+        #   Credits charged for this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
@@ -72,9 +72,9 @@ module ContextDev
         required :credits_remaining, Integer
 
         # @!method initialize(credits_consumed:, credits_remaining:)
-        #   Credit usage, included whenever a valid API key is provided.
+        #   Credits this request used and your remaining balance.
         #
-        #   @param credits_consumed [Integer] Credits used by this request.
+        #   @param credits_consumed [Integer] Credits charged for this request.
         #
         #   @param credits_remaining [Integer] Credits remaining for your organization.
       end

data/lib/context_dev/models/web_answers_params.rb

@@ -8,50 +8,41 @@ module ContextDev
       include ContextDev::Internal::Type::RequestParameters
 
       # @!attribute task
-      #   What to research and answer, in plain language. Naming a domain in the task (for
-      #   example "pricing on context.dev") makes the agent read that site before it
-      #   searches.
+      #   Research task. The agent selects company/profile lookups, web searches, or page
+      #   reads. Include domains or URLs to focus the research.
       #
       #   @return [String]
       required :task, String
 
       # @!attribute json_format
-      #   An example object with placeholder values (for example {"pricing_page_url": "",
-      #   "plans": [{"name": "", "price": 0}]}). Object keys and value types are
-      #   preserved; unknown values may be null. Empty arrays accept any JSON items.
-      #   Defaults to {"result": ""}. Maximum 8 levels, 500 values, and 16000 characters.
+      #   Example answer object, not JSON Schema. Up to 8 levels, 500 values, and 16000
+      #   characters; unknowns may be null.
       #
       #   @return [Hash{Symbol=>Object}, nil]
       optional :json_format, ContextDev::Internal::Type::HashOf[ContextDev::Internal::Type::Unknown]
 
       # @!attribute mode
-      #   Research level: fast uses a smaller model and research budget for 10 credits;
-      #   ultra uses deeper reasoning and research for 100 credits. Defaults to ultra.
-      #   Only successful requests consume credits.
+      #   `fast` prioritizes speed, with extra verification for people and companies;
+      #   `ultra` supports deeper research (default).
       #
       #   @return [Symbol, ContextDev::Models::WebAnswersParams::Mode, nil]
       optional :mode, enum: -> { ContextDev::WebAnswersParams::Mode }
 
       # @!attribute tags
-      #   Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      #   Labels for filtering usage in the dashboard.
       #
       #   @return [Array<String>, nil]
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
 
       # @!attribute timeout_opts
-      #   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.
       #
       #   @return [ContextDev::Models::WebAnswersParams::TimeoutOpts, nil]
       optional :timeout_opts, -> { ContextDev::WebAnswersParams::TimeoutOpts }, api_name: :timeoutOpts
 
       # @!attribute zdr
-      #   Set to enabled to bypass shared caches and omit request and response content
-      #   from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-      #   omitted. 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.
       #
       #   @return [Symbol, ContextDev::Models::WebAnswersParams::Zdr, nil]
       optional :zdr, enum: -> { ContextDev::WebAnswersParams::Zdr }
@@ -60,23 +51,22 @@ module ContextDev
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebAnswersParams} for more details.
       #
-      #   @param task [String] What to research and answer, in plain language. Naming a domain in the task (for
+      #   @param task [String] Research task. The agent selects company/profile lookups, web searches, or page
       #
-      #   @param json_format [Hash{Symbol=>Object}] An example object with placeholder values (for example {"pricing_page_url": "",
+      #   @param json_format [Hash{Symbol=>Object}] Example answer object, not JSON Schema. Up to 8 levels, 500 values, and 16000 ch
       #
-      #   @param mode [Symbol, ContextDev::Models::WebAnswersParams::Mode] Research level: fast uses a smaller model and research budget for 10 credits; ul
+      #   @param mode [Symbol, ContextDev::Models::WebAnswersParams::Mode] `fast` prioritizes speed, with extra verification for people and companies; `ult
       #
-      #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      #   @param tags [Array<String>] Labels for filtering usage in the dashboard.
       #
-      #   @param timeout_opts [ContextDev::Models::WebAnswersParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
+      #   @param timeout_opts [ContextDev::Models::WebAnswersParams::TimeoutOpts] Request deadline and what to return when it passes.
       #
-      #   @param zdr [Symbol, ContextDev::Models::WebAnswersParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
+      #   @param zdr [Symbol, ContextDev::Models::WebAnswersParams::Zdr] `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless you
       #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
 
-      # Research level: fast uses a smaller model and research budget for 10 credits;
-      # ultra uses deeper reasoning and research for 100 credits. Defaults to ultra.
-      # Only successful requests consume credits.
+      # `fast` prioritizes speed, with extra verification for people and companies;
+      # `ultra` supports deeper research (default).
       module Mode
         extend ContextDev::Internal::Type::Enum
 
@@ -89,16 +79,14 @@ module ContextDev
 
       class TimeoutOpts < ContextDev::Internal::Type::BaseModel
         # @!attribute milliseconds
-        #   Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #   Deadline in milliseconds.
         #
         #   @return [Integer]
         required :milliseconds, Integer
 
         # @!attribute behavior
-        #   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.
         #
         #   @return [Symbol, ContextDev::Models::WebAnswersParams::TimeoutOpts::Behavior, nil]
         optional :behavior, enum: -> { ContextDev::WebAnswersParams::TimeoutOpts::Behavior }
@@ -107,18 +95,14 @@ module ContextDev
         #   Some parameter documentations has been truncated, see
         #   {ContextDev::Models::WebAnswersParams::TimeoutOpts} for more details.
         #
-        #   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.
         #
-        #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #   @param milliseconds [Integer] Deadline in milliseconds.
         #
-        #   @param behavior [Symbol, ContextDev::Models::WebAnswersParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+        #   @param behavior [Symbol, ContextDev::Models::WebAnswersParams::TimeoutOpts::Behavior] "fail" returns 408 at the deadline. "return-partial" returns available results;
 
-        # 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.
         #
         # @see ContextDev::Models::WebAnswersParams::TimeoutOpts#behavior
         module Behavior
@@ -132,11 +116,8 @@ module ContextDev
         end
       end
 
-      # Set to enabled to bypass shared caches and omit request and response content
-      # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-      # omitted. 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/lib/context_dev/models/web_answers_response.rb

@@ -11,14 +11,15 @@ module ContextDev
       required :json_content, ContextDev::Internal::Type::HashOf[ContextDev::Internal::Type::Unknown]
 
       # @!attribute sources
-      #   URLs that supplied search results or readable page content, in first-seen order.
-      #   Unreadable pages are excluded.
+      #   Public evidence URLs from searches, pages, or company/profile records, in
+      #   first-seen order. A listed URL may identify a record without its page being
+      #   read.
       #
       #   @return [Array<String>]
       required :sources, ContextDev::Internal::Type::ArrayOf[String]
 
       # @!attribute key_metadata
-      #   Credit usage, included whenever a valid API key is provided.
+      #   Credits this request used and your remaining balance.
       #
       #   @return [ContextDev::Models::WebAnswersResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebAnswersResponse::KeyMetadata }
@@ -36,16 +37,16 @@ module ContextDev
       #
       #   @param json_content [Hash{Symbol=>Object}] The answer, in the shape requested by json_format.
       #
-      #   @param sources [Array<String>] URLs that supplied search results or readable page content, in first-seen order.
+      #   @param sources [Array<String>] Public evidence URLs from searches, pages, or company/profile records, in first-
       #
-      #   @param key_metadata [ContextDev::Models::WebAnswersResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+      #   @param key_metadata [ContextDev::Models::WebAnswersResponse::KeyMetadata] Credits this request used and your remaining balance.
       #
       #   @param partial [Boolean] True when the request deadline ended research and the answer uses the evidence c
 
       # @see ContextDev::Models::WebAnswersResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   Credits used by this request.
+        #   Credits charged for this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
@@ -57,9 +58,9 @@ module ContextDev
         required :credits_remaining, Integer
 
         # @!method initialize(credits_consumed:, credits_remaining:)
-        #   Credit usage, included whenever a valid API key is provided.
+        #   Credits this request used and your remaining balance.
         #
-        #   @param credits_consumed [Integer] Credits used by this request.
+        #   @param credits_consumed [Integer] Credits charged for this request.
         #
         #   @param credits_remaining [Integer] Credits remaining for your organization.
       end

data/lib/context_dev/models/web_extract_competitors_params.rb

@@ -21,26 +21,20 @@ module ContextDev
       optional :num_competitors, Integer
 
       # @!attribute tags
-      #   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`.
       #
       #   @return [Array<String>, nil]
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
 
       # @!attribute timeout_opts
-      #   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.
       #
       #   @return [ContextDev::Models::WebExtractCompetitorsParams::TimeoutOpts, nil]
       optional :timeout_opts, -> { ContextDev::WebExtractCompetitorsParams::TimeoutOpts }
 
       # @!attribute zdr
-      #   Set to enabled to bypass shared caches and omit request and response content
-      #   from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-      #   omitted. 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.
       #
       #   @return [Symbol, ContextDev::Models::WebExtractCompetitorsParams::Zdr, nil]
       optional :zdr, enum: -> { ContextDev::WebExtractCompetitorsParams::Zdr }
@@ -53,26 +47,24 @@ module ContextDev
       #
       #   @param num_competitors [Integer] Exact number of direct competitors to return. Defaults to 5.
       #
-      #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
+      #   @param tags [Array<String>] Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
       #
-      #   @param timeout_opts [ContextDev::Models::WebExtractCompetitorsParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
+      #   @param timeout_opts [ContextDev::Models::WebExtractCompetitorsParams::TimeoutOpts] Request deadline and what to return when it passes.
       #
-      #   @param zdr [Symbol, ContextDev::Models::WebExtractCompetitorsParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
+      #   @param zdr [Symbol, ContextDev::Models::WebExtractCompetitorsParams::Zdr] `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless you
       #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
 
       class TimeoutOpts < ContextDev::Internal::Type::BaseModel
         # @!attribute milliseconds
-        #   Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #   Deadline in milliseconds.
         #
         #   @return [Integer]
         required :milliseconds, Integer
 
         # @!attribute behavior
-        #   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.
         #
         #   @return [Symbol, ContextDev::Models::WebExtractCompetitorsParams::TimeoutOpts::Behavior, nil]
         optional :behavior, enum: -> { ContextDev::WebExtractCompetitorsParams::TimeoutOpts::Behavior }
@@ -81,18 +73,14 @@ module ContextDev
         #   Some parameter documentations has been truncated, see
         #   {ContextDev::Models::WebExtractCompetitorsParams::TimeoutOpts} for more details.
         #
-        #   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.
         #
-        #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #   @param milliseconds [Integer] Deadline in milliseconds.
         #
-        #   @param behavior [Symbol, ContextDev::Models::WebExtractCompetitorsParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+        #   @param behavior [Symbol, ContextDev::Models::WebExtractCompetitorsParams::TimeoutOpts::Behavior] "fail" returns 408 at the deadline. "return-partial" returns available results;
 
-        # 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.
         #
         # @see ContextDev::Models::WebExtractCompetitorsParams::TimeoutOpts#behavior
         module Behavior
@@ -106,11 +94,8 @@ module ContextDev
         end
       end
 
-      # Set to enabled to bypass shared caches and omit request and response content
-      # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-      # omitted. 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/lib/context_dev/models/web_extract_competitors_response.rb

@@ -18,8 +18,8 @@ module ContextDev
       required :domain, String
 
       # @!attribute request_id
-      #   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.
       #
       #   @return [String]
       required :request_id, String
@@ -37,7 +37,7 @@ module ContextDev
       required :target, -> { ContextDev::Models::WebExtractCompetitorsResponse::Target }
 
       # @!attribute key_metadata
-      #   Credit usage, included whenever a valid API key is provided.
+      #   Credits this request used and your remaining balance.
       #
       #   @return [ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata }
@@ -57,13 +57,13 @@ module ContextDev
       #
       #   @param domain [String] Normalized input domain.
       #
-      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #   @param request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
       #
       #   @param status [Symbol, ContextDev::Models::WebExtractCompetitorsResponse::Status] Status of the response.
       #
       #   @param target [ContextDev::Models::WebExtractCompetitorsResponse::Target] Target company profile inferred from the landing page.
       #
-      #   @param key_metadata [ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+      #   @param key_metadata [ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata] Credits this request used and your remaining balance.
       #
       #   @param partial [Boolean] True when the timeout ended processing and this response contains only usable re
 
@@ -185,7 +185,7 @@ module ContextDev
       # @see ContextDev::Models::WebExtractCompetitorsResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   Credits used by this request.
+        #   Credits charged for this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
@@ -197,9 +197,9 @@ module ContextDev
         required :credits_remaining, Integer
 
         # @!method initialize(credits_consumed:, credits_remaining:)
-        #   Credit usage, included whenever a valid API key is provided.
+        #   Credits this request used and your remaining balance.
         #
-        #   @param credits_consumed [Integer] Credits used by this request.
+        #   @param credits_consumed [Integer] Credits charged for this request.
         #
         #   @param credits_remaining [Integer] Credits remaining for your organization.
       end