context.dev 2.16.0 → 2.17.0

data/lib/context_dev/models/web_screenshot_response.rb

@@ -31,6 +31,18 @@ module ContextDev
       #   @return [String, nil]
       optional :domain, String
 
+      # @!attribute final_dom_state
+      #   How complete the returned content is. `loaded` means the page finished the waits
+      #   the request asked for. `still-loading` only occurs with
+      #   timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
+      #   reached first, so the content reflects the DOM at that moment and late-rendering
+      #   parts may be missing. Partial results are billed at the base request cost.
+      #
+      #   @return [Symbol, ContextDev::Models::WebScreenshotResponse::FinalDomState, nil]
+      optional :final_dom_state,
+               enum: -> { ContextDev::Models::WebScreenshotResponse::FinalDomState },
+               api_name: :finalDOMState
+
       # @!attribute height
       #   Height in pixels of the returned screenshot image
       #
@@ -70,7 +82,7 @@ module ContextDev
       #   @return [Integer, nil]
       optional :width, Integer
 
-      # @!method initialize(cache_metadata:, request_id:, code: nil, domain: nil, height: nil, key_metadata: nil, screenshot: nil, screenshot_type: nil, status: nil, width: nil)
+      # @!method initialize(cache_metadata:, request_id:, code: nil, domain: nil, final_dom_state: nil, height: nil, key_metadata: nil, screenshot: nil, screenshot_type: nil, status: nil, width: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebScreenshotResponse} for more details.
       #
@@ -82,6 +94,8 @@ module ContextDev
       #
       #   @param domain [String] The normalized domain that was processed
       #
+      #   @param final_dom_state [Symbol, ContextDev::Models::WebScreenshotResponse::FinalDomState] How complete the returned content is. `loaded` means the page finished the waits
+      #
       #   @param height [Integer] Height in pixels of the returned screenshot image
       #
       #   @param key_metadata [ContextDev::Models::WebScreenshotResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
@@ -137,6 +151,23 @@ module ContextDev
         end
       end
 
+      # How complete the returned content is. `loaded` means the page finished the waits
+      # the request asked for. `still-loading` only occurs with
+      # timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
+      # reached first, so the content reflects the DOM at that moment and late-rendering
+      # parts may be missing. Partial results are billed at the base request cost.
+      #
+      # @see ContextDev::Models::WebScreenshotResponse#final_dom_state
+      module FinalDomState
+        extend ContextDev::Internal::Type::Enum
+
+        LOADED = :loaded
+        STILL_LOADING = :"still-loading"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # @see ContextDev::Models::WebScreenshotResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed

data/lib/context_dev/models/web_search_params.rb

@@ -67,15 +67,15 @@ module ContextDev
       #   @return [Array<String>, nil]
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
 
-      # @!attribute timeout_ms
-      #   Optional timeout in milliseconds for the request. If the request takes longer
-      #   than this value, it will be aborted with a 408 status code. Maximum allowed
-      #   value is 300000ms (5 minutes).
+      # @!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.
       #
-      #   @return [Integer, nil]
-      optional :timeout_ms, Integer, api_name: :timeoutMS
+      #   @return [ContextDev::Models::WebSearchParams::TimeoutOpts, nil]
+      optional :timeout_opts, -> { ContextDev::WebSearchParams::TimeoutOpts }, api_name: :timeoutOpts
 
-      # @!method initialize(query:, country: nil, exclude_domains: nil, freshness: nil, include_domains: nil, markdown_options: nil, num_results: nil, query_fanout: nil, tags: nil, timeout_ms: nil, request_options: {})
+      # @!method initialize(query:, country: nil, exclude_domains: nil, freshness: nil, include_domains: nil, markdown_options: nil, num_results: nil, query_fanout: nil, tags: nil, timeout_opts: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebSearchParams} for more details.
       #
@@ -97,7 +97,7 @@ module ContextDev
       #
       #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
       #
-      #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #   @param timeout_opts [ContextDev::Models::WebSearchParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
 
@@ -407,13 +407,15 @@ module ContextDev
         #   @return [Boolean, nil]
         optional :shorten_base64_images, ContextDev::Internal::Type::Boolean, api_name: :shortenBase64Images
 
-        # @!attribute timeout_ms
-        #   Optional timeout in milliseconds for the request. If the request takes longer
-        #   than this value, it will be aborted with a 408 status code. Maximum allowed
-        #   value is 300000ms (5 minutes).
+        # @!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.
         #
-        #   @return [Integer, nil]
-        optional :timeout_ms, Integer, api_name: :timeoutMS
+        #   @return [ContextDev::Models::WebSearchParams::MarkdownOptions::TimeoutOpts, nil]
+        optional :timeout_opts,
+                 -> { ContextDev::WebSearchParams::MarkdownOptions::TimeoutOpts },
+                 api_name: :timeoutOpts
 
         # @!attribute use_main_content_only
         #   Strip nav, header, footer, and sidebar — keep only the primary article content.
@@ -428,7 +430,7 @@ module ContextDev
         #   @return [Integer, nil]
         optional :wait_for_ms, Integer, api_name: :waitForMs
 
-        # @!method initialize(enabled: nil, include_frames: nil, include_images: nil, include_links: nil, max_age_ms: nil, pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil)
+        # @!method initialize(enabled: nil, include_frames: nil, include_images: nil, include_links: nil, max_age_ms: nil, pdf: nil, shorten_base64_images: nil, timeout_opts: nil, use_main_content_only: nil, wait_for_ms: nil)
         #   Some parameter documentations has been truncated, see
         #   {ContextDev::Models::WebSearchParams::MarkdownOptions} for more details.
         #
@@ -448,7 +450,7 @@ module ContextDev
         #
         #   @param shorten_base64_images [Boolean] Truncate inline base64 image payloads to keep responses small.
         #
-        #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+        #   @param timeout_opts [ContextDev::Models::WebSearchParams::MarkdownOptions::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
         #
         #   @param use_main_content_only [Boolean] Strip nav, header, footer, and sidebar — keep only the primary article content.
         #
@@ -487,6 +489,100 @@ module ContextDev
           #
           #   @param start [Integer] First PDF page to parse (1-based, inclusive). Defaults to page 1.
         end
+
+        # @see ContextDev::Models::WebSearchParams::MarkdownOptions#timeout_opts
+        class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+          # @!attribute milliseconds
+          #   Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+          #
+          #   @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. "return-partial" requires milliseconds of at
+          #   least 15000.
+          #
+          #   @return [Symbol, ContextDev::Models::WebSearchParams::MarkdownOptions::TimeoutOpts::Behavior, nil]
+          optional :behavior, enum: -> { ContextDev::WebSearchParams::MarkdownOptions::TimeoutOpts::Behavior }
+
+          # @!method initialize(milliseconds:, behavior: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {ContextDev::Models::WebSearchParams::MarkdownOptions::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.
+          #
+          #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+          #
+          #   @param behavior [Symbol, ContextDev::Models::WebSearchParams::MarkdownOptions::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+
+          # 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. "return-partial" requires milliseconds of at
+          # least 15000.
+          #
+          # @see ContextDev::Models::WebSearchParams::MarkdownOptions::TimeoutOpts#behavior
+          module Behavior
+            extend ContextDev::Internal::Type::Enum
+
+            FAIL = :fail
+            RETURN_PARTIAL = :"return-partial"
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        # @!attribute milliseconds
+        #   Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #
+        #   @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.
+        #
+        #   @return [Symbol, ContextDev::Models::WebSearchParams::TimeoutOpts::Behavior, nil]
+        optional :behavior, enum: -> { ContextDev::WebSearchParams::TimeoutOpts::Behavior }
+
+        # @!method initialize(milliseconds:, behavior: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::WebSearchParams::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.
+        #
+        #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #
+        #   @param behavior [Symbol, ContextDev::Models::WebSearchParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+
+        # 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.
+        #
+        # @see ContextDev::Models::WebSearchParams::TimeoutOpts#behavior
+        module Behavior
+          extend ContextDev::Internal::Type::Enum
+
+          FAIL = :fail
+          RETURN_PARTIAL = :"return-partial"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end

data/lib/context_dev/models/web_search_response.rb

@@ -37,7 +37,15 @@ module ContextDev
       #   @return [ContextDev::Models::WebSearchResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebSearchResponse::KeyMetadata }
 
-      # @!method initialize(cache_metadata:, query:, request_id:, results:, key_metadata: nil)
+      # @!attribute partial
+      #   True when timeoutOpts.behavior=return-partial returned the usable results
+      #   collected before the deadline. Partial collections are not cached as complete
+      #   results.
+      #
+      #   @return [Boolean, nil]
+      optional :partial, ContextDev::Internal::Type::Boolean
+
+      # @!method initialize(cache_metadata:, query:, request_id:, results:, key_metadata: nil, partial: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebSearchResponse} for more details.
       #
@@ -50,6 +58,8 @@ module ContextDev
       #   @param results [Array<ContextDev::Models::WebSearchResponse::Result>]
       #
       #   @param key_metadata [ContextDev::Models::WebSearchResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+      #
+      #   @param partial [Boolean] True when timeoutOpts.behavior=return-partial returned the usable results collec
 
       # @see ContextDev::Models::WebSearchResponse#cache_metadata
       class CacheMetadata < ContextDev::Internal::Type::BaseModel
@@ -151,7 +161,19 @@ module ContextDev
           #   @return [String, nil]
           required :markdown, String, nil?: true
 
-          # @!method initialize(code:, markdown:)
+          # @!attribute final_dom_state
+          #   How complete the returned content is. `loaded` means the page finished the waits
+          #   the request asked for. `still-loading` only occurs with
+          #   timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
+          #   reached first, so the content reflects the DOM at that moment and late-rendering
+          #   parts may be missing. Partial results are billed at the base request cost.
+          #
+          #   @return [Symbol, ContextDev::Models::WebSearchResponse::Result::Markdown::FinalDomState, nil]
+          optional :final_dom_state,
+                   enum: -> { ContextDev::Models::WebSearchResponse::Result::Markdown::FinalDomState },
+                   api_name: :finalDOMState
+
+          # @!method initialize(code:, markdown:, final_dom_state: nil)
           #   Some parameter documentations has been truncated, see
           #   {ContextDev::Models::WebSearchResponse::Result::Markdown} for more details.
           #
@@ -160,6 +182,8 @@ module ContextDev
           #   @param code [Symbol, ContextDev::Models::WebSearchResponse::Result::Markdown::Code] Per-result scrape outcome. Inspect this before reading `markdown`.
           #
           #   @param markdown [String, nil] GFM Markdown of the page. Null unless markdownOptions.enabled is true and scrapi
+          #
+          #   @param final_dom_state [Symbol, ContextDev::Models::WebSearchResponse::Result::Markdown::FinalDomState] How complete the returned content is. `loaded` means the page finished the waits
 
           # Per-result scrape outcome. Inspect this before reading `markdown`.
           #
@@ -177,6 +201,23 @@ module ContextDev
             # @!method self.values
             #   @return [Array<Symbol>]
           end
+
+          # How complete the returned content is. `loaded` means the page finished the waits
+          # the request asked for. `still-loading` only occurs with
+          # timeoutOpts.behavior=return-partial: the timeoutOpts.milliseconds deadline was
+          # reached first, so the content reflects the DOM at that moment and late-rendering
+          # parts may be missing. Partial results are billed at the base request cost.
+          #
+          # @see ContextDev::Models::WebSearchResponse::Result::Markdown#final_dom_state
+          module FinalDomState
+            extend ContextDev::Internal::Type::Enum
+
+            LOADED = :loaded
+            STILL_LOADING = :"still-loading"
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
         end
 
         # Relevance to the original query.

data/lib/context_dev/models/web_web_crawl_md_params.rb

@@ -120,13 +120,13 @@ module ContextDev
       #   @return [Array<String>, nil]
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
 
-      # @!attribute timeout_ms
-      #   Optional timeout in milliseconds for the request. If the request takes longer
-      #   than this value, it will be aborted with a 408 status code. Maximum allowed
-      #   value is 300000ms (5 minutes).
+      # @!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.
       #
-      #   @return [Integer, nil]
-      optional :timeout_ms, Integer, api_name: :timeoutMS
+      #   @return [ContextDev::Models::WebWebCrawlMdParams::TimeoutOpts, nil]
+      optional :timeout_opts, -> { ContextDev::WebWebCrawlMdParams::TimeoutOpts }, api_name: :timeoutOpts
 
       # @!attribute url_regex
       #   Regex pattern. Only URLs matching this pattern will be followed and scraped. An
@@ -159,7 +159,7 @@ module ContextDev
       #   @return [Symbol, ContextDev::Models::WebWebCrawlMdParams::Zdr, nil]
       optional :zdr, enum: -> { ContextDev::WebWebCrawlMdParams::Zdr }
 
-      # @!method initialize(url:, country: nil, exclude_selectors: nil, follow_subdomains: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, settle_animations: nil, shorten_base64_images: nil, stop_after_ms: nil, tags: nil, timeout_ms: nil, url_regex: nil, use_main_content_only: nil, wait_for_ms: nil, zdr: nil, request_options: {})
+      # @!method initialize(url:, country: nil, exclude_selectors: nil, follow_subdomains: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, settle_animations: nil, shorten_base64_images: nil, stop_after_ms: nil, tags: nil, timeout_opts: nil, url_regex: nil, use_main_content_only: nil, wait_for_ms: nil, zdr: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebWebCrawlMdParams} for more details.
       #
@@ -195,7 +195,7 @@ module ContextDev
       #
       #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
       #
-      #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #   @param timeout_opts [ContextDev::Models::WebWebCrawlMdParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       #   @param url_regex [String] Regex pattern. Only URLs matching this pattern will be followed and scraped. An
       #
@@ -467,6 +467,51 @@ module ContextDev
         #   @param start [Integer] First 1-based PDF page to parse. When omitted, parsing starts at the first page.
       end
 
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        # @!attribute milliseconds
+        #   Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #
+        #   @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.
+        #
+        #   @return [Symbol, ContextDev::Models::WebWebCrawlMdParams::TimeoutOpts::Behavior, nil]
+        optional :behavior, enum: -> { ContextDev::WebWebCrawlMdParams::TimeoutOpts::Behavior }
+
+        # @!method initialize(milliseconds:, behavior: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::WebWebCrawlMdParams::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.
+        #
+        #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #
+        #   @param behavior [Symbol, ContextDev::Models::WebWebCrawlMdParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+
+        # 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.
+        #
+        # @see ContextDev::Models::WebWebCrawlMdParams::TimeoutOpts#behavior
+        module Behavior
+          extend ContextDev::Internal::Type::Enum
+
+          FAIL = :fail
+          RETURN_PARTIAL = :"return-partial"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        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

data/lib/context_dev/models/web_web_crawl_md_response.rb

@@ -36,7 +36,15 @@ module ContextDev
       #   @return [ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata }
 
-      # @!method initialize(cache_metadata:, metadata:, request_id:, results:, key_metadata: nil)
+      # @!attribute partial
+      #   True when timeoutOpts.behavior=return-partial returned the usable results
+      #   collected before the deadline. Partial collections are not cached as complete
+      #   results.
+      #
+      #   @return [Boolean, nil]
+      optional :partial, ContextDev::Internal::Type::Boolean
+
+      # @!method initialize(cache_metadata:, metadata:, request_id:, results:, key_metadata: nil, partial: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebWebCrawlMdResponse} for more details.
       #
@@ -49,6 +57,8 @@ module ContextDev
       #   @param results [Array<ContextDev::Models::WebWebCrawlMdResponse::Result>]
       #
       #   @param key_metadata [ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+      #
+      #   @param partial [Boolean] True when timeoutOpts.behavior=return-partial returned the usable results collec
 
       # @see ContextDev::Models::WebWebCrawlMdResponse#cache_metadata
       class CacheMetadata < ContextDev::Internal::Type::BaseModel