context.dev 2.15.0 → 2.17.0

data/rbi/context_dev/models/web_extract_params.rbi

@@ -145,14 +145,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::WebExtractParams::TimeoutOpts)) }
+      attr_reader :timeout_opts
 
-      sig { params(timeout_ms: Integer).void }
-      attr_writer :timeout_ms
+      sig do
+        params(
+          timeout_opts: ContextDev::WebExtractParams::TimeoutOpts::OrHash
+        ).void
+      end
+      attr_writer :timeout_opts
 
       # Optional browser wait time in milliseconds after initial page load for each
       # crawled page.
@@ -185,7 +189,7 @@ module ContextDev
           settle_animations: T::Boolean,
           stop_after_ms: Integer,
           tags: T::Array[String],
-          timeout_ms: Integer,
+          timeout_opts: ContextDev::WebExtractParams::TimeoutOpts::OrHash,
           wait_for_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -238,10 +242,10 @@ module ContextDev
         stop_after_ms: 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,
         # Optional browser wait time in milliseconds after initial page load for each
         # crawled page.
         wait_for_ms: nil,
@@ -273,7 +277,7 @@ module ContextDev
             settle_animations: T::Boolean,
             stop_after_ms: Integer,
             tags: T::Array[String],
-            timeout_ms: Integer,
+            timeout_opts: ContextDev::WebExtractParams::TimeoutOpts,
             wait_for_ms: Integer,
             request_options: ContextDev::RequestOptions
           }
@@ -624,6 +628,109 @@ module ContextDev
         def to_hash
         end
       end
+
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::WebExtractParams::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::WebExtractParams::TimeoutOpts::Behavior::OrSymbol
+            )
+          )
+        end
+        attr_reader :behavior
+
+        sig do
+          params(
+            behavior:
+              ContextDev::WebExtractParams::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::WebExtractParams::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::WebExtractParams::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::WebExtractParams::TimeoutOpts::Behavior)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FAIL =
+            T.let(
+              :fail,
+              ContextDev::WebExtractParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+          RETURN_PARTIAL =
+            T.let(
+              :"return-partial",
+              ContextDev::WebExtractParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::WebExtractParams::TimeoutOpts::Behavior::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
     end
   end
 end

data/rbi/context_dev/models/web_extract_response.rbi

@@ -39,6 +39,11 @@ module ContextDev
       end
       attr_writer :metadata
 
+      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      # it when contacting support about a failed request.
+      sig { returns(String) }
+      attr_accessor :request_id
+
       # Status of the response, e.g., 'ok'
       sig { returns(String) }
       attr_accessor :status
@@ -65,17 +70,27 @@ module ContextDev
       end
       attr_writer :key_metadata
 
+      # True when the timeout ended processing and this response contains only usable
+      # results completed so far. Unfinished results are omitted.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :partial
+
+      sig { params(partial: T::Boolean).void }
+      attr_writer :partial
+
       sig do
         params(
           cache_metadata:
             ContextDev::Models::WebExtractResponse::CacheMetadata::OrHash,
           data: T::Hash[Symbol, T.anything],
           metadata: ContextDev::Models::WebExtractResponse::Metadata::OrHash,
+          request_id: String,
           status: String,
           url: String,
           urls_analyzed: T::Array[String],
           key_metadata:
-            ContextDev::Models::WebExtractResponse::KeyMetadata::OrHash
+            ContextDev::Models::WebExtractResponse::KeyMetadata::OrHash,
+          partial: T::Boolean
         ).returns(T.attached_class)
       end
       def self.new(
@@ -86,6 +101,9 @@ module ContextDev
         # Extracted data matching the request schema
         data:,
         metadata:,
+        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        # it when contacting support about a failed request.
+        request_id:,
         # Status of the response, e.g., 'ok'
         status:,
         # The starting URL that was analyzed
@@ -93,7 +111,10 @@ module ContextDev
         # List of URLs whose Markdown was used for extraction
         urls_analyzed:,
         # Credit usage, included whenever a valid API key is provided.
-        key_metadata: nil
+        key_metadata: nil,
+        # True when the timeout ended processing and this response contains only usable
+        # results completed so far. Unfinished results are omitted.
+        partial: nil
       )
       end
 
@@ -104,10 +125,12 @@ module ContextDev
               ContextDev::Models::WebExtractResponse::CacheMetadata,
             data: T::Hash[Symbol, T.anything],
             metadata: ContextDev::Models::WebExtractResponse::Metadata,
+            request_id: String,
             status: String,
             url: String,
             urls_analyzed: T::Array[String],
-            key_metadata: ContextDev::Models::WebExtractResponse::KeyMetadata
+            key_metadata: ContextDev::Models::WebExtractResponse::KeyMetadata,
+            partial: T::Boolean
           }
         )
       end

data/rbi/context_dev/models/web_extract_styleguide_params.rbi

@@ -53,9 +53,9 @@ module ContextDev
       attr_writer :domain
 
       # Maximum age in milliseconds for cached brand data before the API performs a hard
-      # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
-      # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
-      # year.
+      # refresh. Defaults to 3 months (7776000000 ms). Set to 0 to always perform a hard
+      # refresh. Negative values are clamped to 0; values above 1 year (31536000000 ms)
+      # are clamped to 1 year.
       sig { returns(T.nilable(Integer)) }
       attr_accessor :max_age_ms
 
@@ -67,14 +67,21 @@ 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::WebExtractStyleguideParams::TimeoutOpts))
+      end
+      attr_reader :timeout_opts
 
-      sig { params(timeout_ms: Integer).void }
-      attr_writer :timeout_ms
+      sig do
+        params(
+          timeout_opts:
+            ContextDev::WebExtractStyleguideParams::TimeoutOpts::OrHash
+        ).void
+      end
+      attr_writer :timeout_opts
 
       sig do
         params(
@@ -84,7 +91,8 @@ module ContextDev
           domain: String,
           max_age_ms: T.nilable(Integer),
           tags: T::Array[String],
-          timeout_ms: Integer,
+          timeout_opts:
+            ContextDev::WebExtractStyleguideParams::TimeoutOpts::OrHash,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -102,17 +110,17 @@ module ContextDev
         # 'domain' or 'directUrl', but not both.
         domain: nil,
         # Maximum age in milliseconds for cached brand data before the API performs a hard
-        # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
-        # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
-        # year.
+        # refresh. Defaults to 3 months (7776000000 ms). Set to 0 to always perform a hard
+        # refresh. Negative values are clamped to 0; values above 1 year (31536000000 ms)
+        # are clamped to 1 year.
         max_age_ms: nil,
         # 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,
         request_options: {}
       )
       end
@@ -126,7 +134,7 @@ module ContextDev
             domain: String,
             max_age_ms: T.nilable(Integer),
             tags: T::Array[String],
-            timeout_ms: Integer,
+            timeout_opts: ContextDev::WebExtractStyleguideParams::TimeoutOpts,
             request_options: ContextDev::RequestOptions
           }
         )
@@ -166,6 +174,115 @@ module ContextDev
         def self.values
         end
       end
+
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::WebExtractStyleguideParams::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::WebExtractStyleguideParams::TimeoutOpts::Behavior::OrSymbol
+            )
+          )
+        end
+        attr_reader :behavior
+
+        sig do
+          params(
+            behavior:
+              ContextDev::WebExtractStyleguideParams::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::WebExtractStyleguideParams::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::WebExtractStyleguideParams::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::WebExtractStyleguideParams::TimeoutOpts::Behavior
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FAIL =
+            T.let(
+              :fail,
+              ContextDev::WebExtractStyleguideParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+          RETURN_PARTIAL =
+            T.let(
+              :"return-partial",
+              ContextDev::WebExtractStyleguideParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::WebExtractStyleguideParams::TimeoutOpts::Behavior::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
     end
   end
 end

data/rbi/context_dev/models/web_extract_styleguide_response.rbi

@@ -27,6 +27,11 @@ module ContextDev
       end
       attr_writer :cache_metadata
 
+      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      # it when contacting support about a failed request.
+      sig { returns(String) }
+      attr_accessor :request_id
+
       # HTTP status code
       sig { returns(T.nilable(Integer)) }
       attr_reader :code
@@ -41,6 +46,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::WebExtractStyleguideResponse::FinalDomState::TaggedSymbol
+          )
+        )
+      end
+      attr_reader :final_dom_state
+
+      sig do
+        params(
+          final_dom_state:
+            ContextDev::Models::WebExtractStyleguideResponse::FinalDomState::OrSymbol
+        ).void
+      end
+      attr_writer :final_dom_state
+
       # Credit usage, included whenever a valid API key is provided.
       sig do
         returns(
@@ -88,8 +115,11 @@ module ContextDev
         params(
           cache_metadata:
             ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata::OrHash,
+          request_id: String,
           code: Integer,
           domain: String,
+          final_dom_state:
+            ContextDev::Models::WebExtractStyleguideResponse::FinalDomState::OrSymbol,
           key_metadata:
             ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata::OrHash,
           status: String,
@@ -102,10 +132,19 @@ module ContextDev
         # cache-controlled fetch contributing to the output was a hit; age_ms is the
         # oldest contributing hit.
         cache_metadata:,
+        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        # it when contacting support about a failed request.
+        request_id:,
         # HTTP status code
         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,
         # Credit usage, included whenever a valid API key is provided.
         key_metadata: nil,
         # Status of the response, e.g., 'ok'
@@ -120,8 +159,11 @@ module ContextDev
           {
             cache_metadata:
               ContextDev::Models::WebExtractStyleguideResponse::CacheMetadata,
+            request_id: String,
             code: Integer,
             domain: String,
+            final_dom_state:
+              ContextDev::Models::WebExtractStyleguideResponse::FinalDomState::TaggedSymbol,
             key_metadata:
               ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata,
             status: String,
@@ -228,6 +270,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::WebExtractStyleguideResponse::FinalDomState
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LOADED =
+          T.let(
+            :loaded,
+            ContextDev::Models::WebExtractStyleguideResponse::FinalDomState::TaggedSymbol
+          )
+        STILL_LOADING =
+          T.let(
+            :"still-loading",
+            ContextDev::Models::WebExtractStyleguideResponse::FinalDomState::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::Models::WebExtractStyleguideResponse::FinalDomState::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         OrHash =
           T.type_alias do