context.dev 2.16.0 → 2.17.1

data/rbi/context_dev/models/web_web_scrape_images_params.rbi

@@ -83,19 +83,26 @@ module ContextDev
       sig { params(tags: T::Array[String]).void }
       attr_writer :tags
 
-      # 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).
-      sig { returns(T.nilable(Integer)) }
-      attr_reader :timeout_ms
+      # Optional request deadline and behavior on timeout. For GET requests, use
+      # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+      # timeoutOpts object.
+      sig do
+        returns(T.nilable(ContextDev::WebWebScrapeImagesParams::TimeoutOpts))
+      end
+      attr_reader :timeout_opts
 
-      sig { params(timeout_ms: Integer).void }
-      attr_writer :timeout_ms
+      sig do
+        params(
+          timeout_opts:
+            ContextDev::WebWebScrapeImagesParams::TimeoutOpts::OrHash
+        ).void
+      end
+      attr_writer :timeout_opts
 
       # Optional browser wait time in milliseconds after initial page load before
       # collecting images. Min: 0. Max: 30000 (30 seconds). When combined with
-      # timeoutMS, timeoutMS must be at least waitForMs + 10000 ms; a shorter deadline
-      # is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
+      # timeoutOpts, timeoutOpts.milliseconds must be at least waitForMs + 10000 ms; a
+      # shorter deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
       sig { returns(T.nilable(Integer)) }
       attr_accessor :wait_for_ms
 
@@ -118,7 +125,8 @@ module ContextDev
           headers: T::Hash[Symbol, String],
           max_age_ms: T.nilable(Integer),
           tags: T::Array[String],
-          timeout_ms: Integer,
+          timeout_opts:
+            ContextDev::WebWebScrapeImagesParams::TimeoutOpts::OrHash,
           wait_for_ms: T.nilable(Integer),
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -148,14 +156,14 @@ module ContextDev
         # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
         # characters.
         tags: nil,
-        # 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).
-        timeout_ms: nil,
+        # Optional request deadline and behavior on timeout. For GET requests, use
+        # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+        # timeoutOpts object.
+        timeout_opts: nil,
         # Optional browser wait time in milliseconds after initial page load before
         # collecting images. Min: 0. Max: 30000 (30 seconds). When combined with
-        # timeoutMS, timeoutMS must be at least waitForMs + 10000 ms; a shorter deadline
-        # is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
+        # timeoutOpts, timeoutOpts.milliseconds must be at least waitForMs + 10000 ms; a
+        # shorter deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
         wait_for_ms: nil,
         request_options: {}
       )
@@ -181,7 +189,7 @@ module ContextDev
             headers: T::Hash[Symbol, String],
             max_age_ms: T.nilable(Integer),
             tags: T::Array[String],
-            timeout_ms: Integer,
+            timeout_opts: ContextDev::WebWebScrapeImagesParams::TimeoutOpts,
             wait_for_ms: T.nilable(Integer),
             request_options: ContextDev::RequestOptions
           }
@@ -549,6 +557,115 @@ module ContextDev
         def to_hash
         end
       end
+
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::WebWebScrapeImagesParams::TimeoutOpts,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        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. "return-partial" requires milliseconds of at
+        # least 15000.
+        sig do
+          returns(
+            T.nilable(
+              ContextDev::WebWebScrapeImagesParams::TimeoutOpts::Behavior::OrSymbol
+            )
+          )
+        end
+        attr_reader :behavior
+
+        sig do
+          params(
+            behavior:
+              ContextDev::WebWebScrapeImagesParams::TimeoutOpts::Behavior::OrSymbol
+          ).void
+        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.
+        sig do
+          params(
+            milliseconds: Integer,
+            behavior:
+              ContextDev::WebWebScrapeImagesParams::TimeoutOpts::Behavior::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+          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. "return-partial" requires milliseconds of at
+          # least 15000.
+          behavior: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              milliseconds: Integer,
+              behavior:
+                ContextDev::WebWebScrapeImagesParams::TimeoutOpts::Behavior::OrSymbol
+            }
+          )
+        end
+        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. "return-partial" requires milliseconds of at
+        # least 15000.
+        module Behavior
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::WebWebScrapeImagesParams::TimeoutOpts::Behavior
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FAIL =
+            T.let(
+              :fail,
+              ContextDev::WebWebScrapeImagesParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+          RETURN_PARTIAL =
+            T.let(
+              :"return-partial",
+              ContextDev::WebWebScrapeImagesParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::WebWebScrapeImagesParams::TimeoutOpts::Behavior::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
     end
   end
 end

data/rbi/context_dev/models/web_web_scrape_images_response.rbi

@@ -72,6 +72,28 @@ module ContextDev
       end
       attr_writer :actions_applied
 
+      # 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.
+      sig do
+        returns(
+          T.nilable(
+            ContextDev::Models::WebWebScrapeImagesResponse::FinalDomState::TaggedSymbol
+          )
+        )
+      end
+      attr_reader :final_dom_state
+
+      sig do
+        params(
+          final_dom_state:
+            ContextDev::Models::WebWebScrapeImagesResponse::FinalDomState::OrSymbol
+        ).void
+      end
+      attr_writer :final_dom_state
+
       # Credit usage, included whenever a valid API key is provided.
       sig do
         returns(
@@ -88,6 +110,15 @@ module ContextDev
       end
       attr_writer :key_metadata
 
+      # True when the deadline interrupted rendering or image enrichment. Partial
+      # results are billed at the base request cost, without enrichment or actions
+      # surcharges.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :partial
+
+      sig { params(partial: T::Boolean).void }
+      attr_writer :partial
+
       sig do
         params(
           cache_metadata:
@@ -104,8 +135,11 @@ module ContextDev
             T::Array[
               ContextDev::Models::WebWebScrapeImagesResponse::ActionsApplied::OrHash
             ],
+          final_dom_state:
+            ContextDev::Models::WebWebScrapeImagesResponse::FinalDomState::OrSymbol,
           key_metadata:
-            ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata::OrHash
+            ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata::OrHash,
+          partial: T::Boolean
         ).returns(T.attached_class)
       end
       def self.new(
@@ -124,8 +158,18 @@ module ContextDev
         url:,
         # One verified outcome per requested browser action, in request order.
         actions_applied: nil,
+        # 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.
+        final_dom_state: nil,
         # Credit usage, included whenever a valid API key is provided.
-        key_metadata: nil
+        key_metadata: nil,
+        # True when the deadline interrupted rendering or image enrichment. Partial
+        # results are billed at the base request cost, without enrichment or actions
+        # surcharges.
+        partial: nil
       )
       end
 
@@ -144,8 +188,11 @@ module ContextDev
               T::Array[
                 ContextDev::Models::WebWebScrapeImagesResponse::ActionsApplied
               ],
+            final_dom_state:
+              ContextDev::Models::WebWebScrapeImagesResponse::FinalDomState::TaggedSymbol,
             key_metadata:
-              ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata
+              ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata,
+            partial: T::Boolean
           }
         )
       end
@@ -780,6 +827,45 @@ 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.
+      module FinalDomState
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ContextDev::Models::WebWebScrapeImagesResponse::FinalDomState
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LOADED =
+          T.let(
+            :loaded,
+            ContextDev::Models::WebWebScrapeImagesResponse::FinalDomState::TaggedSymbol
+          )
+        STILL_LOADING =
+          T.let(
+            :"still-loading",
+            ContextDev::Models::WebWebScrapeImagesResponse::FinalDomState::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::Models::WebWebScrapeImagesResponse::FinalDomState::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/context_dev/models/web_web_scrape_md_params.rbi

@@ -137,14 +137,18 @@ module ContextDev
       sig { params(tags: T::Array[String]).void }
       attr_writer :tags
 
-      # 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).
-      sig { returns(T.nilable(Integer)) }
-      attr_reader :timeout_ms
+      # Optional request deadline and behavior on timeout. For GET requests, use
+      # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+      # timeoutOpts object.
+      sig { returns(T.nilable(ContextDev::WebWebScrapeMdParams::TimeoutOpts)) }
+      attr_reader :timeout_opts
 
-      sig { params(timeout_ms: Integer).void }
-      attr_writer :timeout_ms
+      sig do
+        params(
+          timeout_opts: ContextDev::WebWebScrapeMdParams::TimeoutOpts::OrHash
+        ).void
+      end
+      attr_writer :timeout_opts
 
       # Extract only the main content of the page, excluding headers, footers, sidebars,
       # and navigation
@@ -156,8 +160,8 @@ module ContextDev
 
       # Optional browser wait time in milliseconds after initial page load before
       # converting the page to Markdown. Min: 0. Max: 30000 (30 seconds). When combined
-      # with timeoutMS, timeoutMS must be at least waitForMs + 10000 ms; a shorter
-      # deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
+      # with timeoutOpts, timeoutOpts.milliseconds must be at least waitForMs + 10000
+      # ms; a shorter deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
       sig { returns(T.nilable(Integer)) }
       attr_accessor :wait_for_ms
 
@@ -199,7 +203,7 @@ module ContextDev
           settle_animations: T::Boolean,
           shorten_base64_images: T::Boolean,
           tags: T::Array[String],
-          timeout_ms: Integer,
+          timeout_opts: ContextDev::WebWebScrapeMdParams::TimeoutOpts::OrHash,
           use_main_content_only: T::Boolean,
           wait_for_ms: T.nilable(Integer),
           zdr: ContextDev::WebWebScrapeMdParams::Zdr::OrSymbol,
@@ -255,17 +259,17 @@ module ContextDev
         # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
         # characters.
         tags: nil,
-        # 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).
-        timeout_ms: nil,
+        # Optional request deadline and behavior on timeout. For GET requests, use
+        # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+        # timeoutOpts object.
+        timeout_opts: nil,
         # Extract only the main content of the page, excluding headers, footers, sidebars,
         # and navigation
         use_main_content_only: nil,
         # Optional browser wait time in milliseconds after initial page load before
         # converting the page to Markdown. Min: 0. Max: 30000 (30 seconds). When combined
-        # with timeoutMS, timeoutMS must be at least waitForMs + 10000 ms; a shorter
-        # deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
+        # with timeoutOpts, timeoutOpts.milliseconds must be at least waitForMs + 10000
+        # ms; a shorter deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
         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
@@ -303,7 +307,7 @@ module ContextDev
             settle_animations: T::Boolean,
             shorten_base64_images: T::Boolean,
             tags: T::Array[String],
-            timeout_ms: Integer,
+            timeout_opts: ContextDev::WebWebScrapeMdParams::TimeoutOpts,
             use_main_content_only: T::Boolean,
             wait_for_ms: T.nilable(Integer),
             zdr: ContextDev::WebWebScrapeMdParams::Zdr::OrSymbol,
@@ -907,6 +911,115 @@ module ContextDev
         end
       end
 
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::WebWebScrapeMdParams::TimeoutOpts,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        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. "return-partial" requires milliseconds of at
+        # least 15000.
+        sig do
+          returns(
+            T.nilable(
+              ContextDev::WebWebScrapeMdParams::TimeoutOpts::Behavior::OrSymbol
+            )
+          )
+        end
+        attr_reader :behavior
+
+        sig do
+          params(
+            behavior:
+              ContextDev::WebWebScrapeMdParams::TimeoutOpts::Behavior::OrSymbol
+          ).void
+        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.
+        sig do
+          params(
+            milliseconds: Integer,
+            behavior:
+              ContextDev::WebWebScrapeMdParams::TimeoutOpts::Behavior::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+          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. "return-partial" requires milliseconds of at
+          # least 15000.
+          behavior: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              milliseconds: Integer,
+              behavior:
+                ContextDev::WebWebScrapeMdParams::TimeoutOpts::Behavior::OrSymbol
+            }
+          )
+        end
+        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. "return-partial" requires milliseconds of at
+        # least 15000.
+        module Behavior
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::WebWebScrapeMdParams::TimeoutOpts::Behavior
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FAIL =
+            T.let(
+              :fail,
+              ContextDev::WebWebScrapeMdParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+          RETURN_PARTIAL =
+            T.let(
+              :"return-partial",
+              ContextDev::WebWebScrapeMdParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::WebWebScrapeMdParams::TimeoutOpts::Behavior::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        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/rbi/context_dev/models/web_web_scrape_md_response.rbi

@@ -31,6 +31,18 @@ module ContextDev
       sig { returns(Integer) }
       attr_accessor :content_length
 
+      # 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.
+      sig do
+        returns(
+          ContextDev::Models::WebWebScrapeMdResponse::FinalDomState::TaggedSymbol
+        )
+      end
+      attr_accessor :final_dom_state
+
       # Page content converted to GitHub Flavored Markdown
       sig { returns(String) }
       attr_accessor :markdown
@@ -121,6 +133,8 @@ module ContextDev
           cache_metadata:
             ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::OrHash,
           content_length: Integer,
+          final_dom_state:
+            ContextDev::Models::WebWebScrapeMdResponse::FinalDomState::OrSymbol,
           markdown: String,
           metadata:
             ContextDev::Models::WebWebScrapeMdResponse::Metadata::OrHash,
@@ -147,6 +161,12 @@ module ContextDev
         # and compare small values against your workload's minimum useful-content
         # threshold.
         content_length:,
+        # 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.
+        final_dom_state:,
         # Page content converted to GitHub Flavored Markdown
         markdown:,
         # Metadata extracted from the scraped page HTML.
@@ -178,6 +198,8 @@ module ContextDev
             cache_metadata:
               ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata,
             content_length: Integer,
+            final_dom_state:
+              ContextDev::Models::WebWebScrapeMdResponse::FinalDomState::TaggedSymbol,
             markdown: String,
             metadata: ContextDev::Models::WebWebScrapeMdResponse::Metadata,
             request_id: String,
@@ -293,6 +315,45 @@ 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.
+      module FinalDomState
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ContextDev::Models::WebWebScrapeMdResponse::FinalDomState
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LOADED =
+          T.let(
+            :loaded,
+            ContextDev::Models::WebWebScrapeMdResponse::FinalDomState::TaggedSymbol
+          )
+        STILL_LOADING =
+          T.let(
+            :"still-loading",
+            ContextDev::Models::WebWebScrapeMdResponse::FinalDomState::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::Models::WebWebScrapeMdResponse::FinalDomState::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       class Metadata < ContextDev::Internal::Type::BaseModel
         OrHash =
           T.type_alias do