context.dev 2.16.0 → 2.17.0

data/rbi/context_dev/models/web_screenshot_params.rbi

@@ -131,14 +131,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::WebScreenshotParams::TimeoutOpts)) }
+      attr_reader :timeout_opts
 
-      sig { params(timeout_ms: Integer).void }
-      attr_writer :timeout_ms
+      sig do
+        params(
+          timeout_opts: ContextDev::WebScreenshotParams::TimeoutOpts::OrHash
+        ).void
+      end
+      attr_writer :timeout_opts
 
       # Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080.
       sig { returns(T.nilable(ContextDev::WebScreenshotParams::Viewport)) }
@@ -151,8 +155,9 @@ module ContextDev
 
       # Optional browser wait time in milliseconds after initial page load before taking
       # the screenshot. Min: 0. Max: 30000 (30 seconds). Defaults to 3000 ms when
-      # omitted. When combined with timeoutMS, timeoutMS must be at least waitForMs +
-      # 10000 ms; a shorter deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
+      # omitted. When combined 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
 
@@ -180,7 +185,7 @@ module ContextDev
           page: ContextDev::WebScreenshotParams::Page::OrSymbol,
           scroll_offset: T.nilable(Integer),
           tags: T::Array[String],
-          timeout_ms: Integer,
+          timeout_opts: ContextDev::WebScreenshotParams::TimeoutOpts::OrHash,
           viewport: ContextDev::WebScreenshotParams::Viewport::OrHash,
           wait_for_ms: T.nilable(Integer),
           zdr: ContextDev::WebScreenshotParams::Zdr::OrSymbol,
@@ -236,16 +241,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,
         # Optional browser viewport dimensions for the screenshot. Defaults to 1920x1080.
         viewport: nil,
         # Optional browser wait time in milliseconds after initial page load before taking
         # the screenshot. Min: 0. Max: 30000 (30 seconds). Defaults to 3000 ms when
-        # omitted. When combined with timeoutMS, timeoutMS must be at least waitForMs +
-        # 10000 ms; a shorter deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
+        # omitted. When combined 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
@@ -272,7 +278,7 @@ module ContextDev
             page: ContextDev::WebScreenshotParams::Page::OrSymbol,
             scroll_offset: T.nilable(Integer),
             tags: T::Array[String],
-            timeout_ms: Integer,
+            timeout_opts: ContextDev::WebScreenshotParams::TimeoutOpts,
             viewport: ContextDev::WebScreenshotParams::Viewport,
             wait_for_ms: T.nilable(Integer),
             zdr: ContextDev::WebScreenshotParams::Zdr::OrSymbol,
@@ -610,6 +616,115 @@ module ContextDev
         end
       end
 
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::WebScreenshotParams::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::WebScreenshotParams::TimeoutOpts::Behavior::OrSymbol
+            )
+          )
+        end
+        attr_reader :behavior
+
+        sig do
+          params(
+            behavior:
+              ContextDev::WebScreenshotParams::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::WebScreenshotParams::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::WebScreenshotParams::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::WebScreenshotParams::TimeoutOpts::Behavior
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FAIL =
+            T.let(
+              :fail,
+              ContextDev::WebScreenshotParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+          RETURN_PARTIAL =
+            T.let(
+              :"return-partial",
+              ContextDev::WebScreenshotParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::WebScreenshotParams::TimeoutOpts::Behavior::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       class Viewport < ContextDev::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/context_dev/models/web_screenshot_response.rbi

@@ -44,6 +44,28 @@ module ContextDev
       sig { params(domain: String).void }
       attr_writer :domain
 
+      # 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::WebScreenshotResponse::FinalDomState::TaggedSymbol
+          )
+        )
+      end
+      attr_reader :final_dom_state
+
+      sig do
+        params(
+          final_dom_state:
+            ContextDev::Models::WebScreenshotResponse::FinalDomState::OrSymbol
+        ).void
+      end
+      attr_writer :final_dom_state
+
       # Height in pixels of the returned screenshot image
       sig { returns(T.nilable(Integer)) }
       attr_reader :height
@@ -114,6 +136,8 @@ module ContextDev
           request_id: String,
           code: Integer,
           domain: String,
+          final_dom_state:
+            ContextDev::Models::WebScreenshotResponse::FinalDomState::OrSymbol,
           height: Integer,
           key_metadata:
             ContextDev::Models::WebScreenshotResponse::KeyMetadata::OrHash,
@@ -136,6 +160,12 @@ module ContextDev
         code: nil,
         # The normalized domain that was processed
         domain: 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,
         # Height in pixels of the returned screenshot image
         height: nil,
         # Credit usage, included whenever a valid API key is provided.
@@ -160,6 +190,8 @@ module ContextDev
             request_id: String,
             code: Integer,
             domain: String,
+            final_dom_state:
+              ContextDev::Models::WebScreenshotResponse::FinalDomState::TaggedSymbol,
             height: Integer,
             key_metadata:
               ContextDev::Models::WebScreenshotResponse::KeyMetadata,
@@ -269,6 +301,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::WebScreenshotResponse::FinalDomState
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LOADED =
+          T.let(
+            :loaded,
+            ContextDev::Models::WebScreenshotResponse::FinalDomState::TaggedSymbol
+          )
+        STILL_LOADING =
+          T.let(
+            :"still-loading",
+            ContextDev::Models::WebScreenshotResponse::FinalDomState::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::Models::WebScreenshotResponse::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_search_params.rbi

@@ -85,14 +85,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::WebSearchParams::TimeoutOpts)) }
+      attr_reader :timeout_opts
 
-      sig { params(timeout_ms: Integer).void }
-      attr_writer :timeout_ms
+      sig do
+        params(
+          timeout_opts: ContextDev::WebSearchParams::TimeoutOpts::OrHash
+        ).void
+      end
+      attr_writer :timeout_opts
 
       sig do
         params(
@@ -106,7 +110,7 @@ module ContextDev
           num_results: Integer,
           query_fanout: T::Boolean,
           tags: T::Array[String],
-          timeout_ms: Integer,
+          timeout_opts: ContextDev::WebSearchParams::TimeoutOpts::OrHash,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -133,10 +137,10 @@ module ContextDev
         query_fanout: nil,
         # Optional tags for tracking usage. Up to 20 tags, each 1 to 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,
         request_options: {}
       )
       end
@@ -153,7 +157,7 @@ module ContextDev
             num_results: Integer,
             query_fanout: T::Boolean,
             tags: T::Array[String],
-            timeout_ms: Integer,
+            timeout_opts: ContextDev::WebSearchParams::TimeoutOpts,
             request_options: ContextDev::RequestOptions
           }
         )
@@ -522,14 +526,23 @@ module ContextDev
         sig { params(shorten_base64_images: T::Boolean).void }
         attr_writer :shorten_base64_images
 
-        # 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::WebSearchParams::MarkdownOptions::TimeoutOpts)
+          )
+        end
+        attr_reader :timeout_opts
 
-        sig { params(timeout_ms: Integer).void }
-        attr_writer :timeout_ms
+        sig do
+          params(
+            timeout_opts:
+              ContextDev::WebSearchParams::MarkdownOptions::TimeoutOpts::OrHash
+          ).void
+        end
+        attr_writer :timeout_opts
 
         # Strip nav, header, footer, and sidebar — keep only the primary article content.
         sig { returns(T.nilable(T::Boolean)) }
@@ -556,7 +569,8 @@ module ContextDev
             max_age_ms: Integer,
             pdf: ContextDev::WebSearchParams::MarkdownOptions::Pdf::OrHash,
             shorten_base64_images: T::Boolean,
-            timeout_ms: Integer,
+            timeout_opts:
+              ContextDev::WebSearchParams::MarkdownOptions::TimeoutOpts::OrHash,
             use_main_content_only: T::Boolean,
             wait_for_ms: Integer
           ).returns(T.attached_class)
@@ -577,10 +591,10 @@ module ContextDev
           pdf: nil,
           # Truncate inline base64 image payloads to keep responses small.
           shorten_base64_images: 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,
           # Strip nav, header, footer, and sidebar — keep only the primary article content.
           use_main_content_only: nil,
           # Extra wait after page load before rendering, in ms (0–30000). Useful for
@@ -599,7 +613,8 @@ module ContextDev
               max_age_ms: Integer,
               pdf: ContextDev::WebSearchParams::MarkdownOptions::Pdf,
               shorten_base64_images: T::Boolean,
-              timeout_ms: Integer,
+              timeout_opts:
+                ContextDev::WebSearchParams::MarkdownOptions::TimeoutOpts,
               use_main_content_only: T::Boolean,
               wait_for_ms: Integer
             }
@@ -666,6 +681,218 @@ module ContextDev
           def to_hash
           end
         end
+
+        class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ContextDev::WebSearchParams::MarkdownOptions::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::WebSearchParams::MarkdownOptions::TimeoutOpts::Behavior::OrSymbol
+              )
+            )
+          end
+          attr_reader :behavior
+
+          sig do
+            params(
+              behavior:
+                ContextDev::WebSearchParams::MarkdownOptions::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::WebSearchParams::MarkdownOptions::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::WebSearchParams::MarkdownOptions::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::WebSearchParams::MarkdownOptions::TimeoutOpts::Behavior
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            FAIL =
+              T.let(
+                :fail,
+                ContextDev::WebSearchParams::MarkdownOptions::TimeoutOpts::Behavior::TaggedSymbol
+              )
+            RETURN_PARTIAL =
+              T.let(
+                :"return-partial",
+                ContextDev::WebSearchParams::MarkdownOptions::TimeoutOpts::Behavior::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  ContextDev::WebSearchParams::MarkdownOptions::TimeoutOpts::Behavior::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::WebSearchParams::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.
+        sig do
+          returns(
+            T.nilable(
+              ContextDev::WebSearchParams::TimeoutOpts::Behavior::OrSymbol
+            )
+          )
+        end
+        attr_reader :behavior
+
+        sig do
+          params(
+            behavior:
+              ContextDev::WebSearchParams::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::WebSearchParams::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.
+          behavior: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              milliseconds: Integer,
+              behavior:
+                ContextDev::WebSearchParams::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.
+        module Behavior
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, ContextDev::WebSearchParams::TimeoutOpts::Behavior)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FAIL =
+            T.let(
+              :fail,
+              ContextDev::WebSearchParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+          RETURN_PARTIAL =
+            T.let(
+              :"return-partial",
+              ContextDev::WebSearchParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::WebSearchParams::TimeoutOpts::Behavior::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end