context.dev 2.15.0 → 2.17.0

data/rbi/context_dev/models/web_search_response.rbi

@@ -29,6 +29,11 @@ module ContextDev
       sig { returns(String) }
       attr_accessor :query
 
+      # 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
+
       sig { returns(T::Array[ContextDev::Models::WebSearchResponse::Result]) }
       attr_accessor :results
 
@@ -46,15 +51,26 @@ module ContextDev
       end
       attr_writer :key_metadata
 
+      # True when timeoutOpts.behavior=return-partial returned the usable results
+      # collected before the deadline. Partial collections are not cached as complete
+      # results.
+      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::WebSearchResponse::CacheMetadata::OrHash,
           query: String,
+          request_id: String,
           results:
             T::Array[ContextDev::Models::WebSearchResponse::Result::OrHash],
           key_metadata:
-            ContextDev::Models::WebSearchResponse::KeyMetadata::OrHash
+            ContextDev::Models::WebSearchResponse::KeyMetadata::OrHash,
+          partial: T::Boolean
         ).returns(T.attached_class)
       end
       def self.new(
@@ -64,9 +80,16 @@ module ContextDev
         cache_metadata:,
         # Echo of the original query (useful when fanout was enabled).
         query:,
+        # 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:,
         results:,
         # Credit usage, included whenever a valid API key is provided.
-        key_metadata: nil
+        key_metadata: nil,
+        # True when timeoutOpts.behavior=return-partial returned the usable results
+        # collected before the deadline. Partial collections are not cached as complete
+        # results.
+        partial: nil
       )
       end
 
@@ -76,8 +99,10 @@ module ContextDev
             cache_metadata:
               ContextDev::Models::WebSearchResponse::CacheMetadata,
             query: String,
+            request_id: String,
             results: T::Array[ContextDev::Models::WebSearchResponse::Result],
-            key_metadata: ContextDev::Models::WebSearchResponse::KeyMetadata
+            key_metadata: ContextDev::Models::WebSearchResponse::KeyMetadata,
+            partial: T::Boolean
           }
         )
       end
@@ -282,12 +307,36 @@ module ContextDev
           sig { returns(T.nilable(String)) }
           attr_accessor :markdown
 
+          # 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::WebSearchResponse::Result::Markdown::FinalDomState::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :final_dom_state
+
+          sig do
+            params(
+              final_dom_state:
+                ContextDev::Models::WebSearchResponse::Result::Markdown::FinalDomState::OrSymbol
+            ).void
+          end
+          attr_writer :final_dom_state
+
           # Markdown scrape status and content for this result.
           sig do
             params(
               code:
                 ContextDev::Models::WebSearchResponse::Result::Markdown::Code::OrSymbol,
-              markdown: T.nilable(String)
+              markdown: T.nilable(String),
+              final_dom_state:
+                ContextDev::Models::WebSearchResponse::Result::Markdown::FinalDomState::OrSymbol
             ).returns(T.attached_class)
           end
           def self.new(
@@ -295,7 +344,13 @@ module ContextDev
             code:,
             # GFM Markdown of the page. Null unless markdownOptions.enabled is true and
             # scraping succeeded.
-            markdown:
+            markdown:,
+            # 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
           )
           end
 
@@ -304,7 +359,9 @@ module ContextDev
               {
                 code:
                   ContextDev::Models::WebSearchResponse::Result::Markdown::Code::TaggedSymbol,
-                markdown: T.nilable(String)
+                markdown: T.nilable(String),
+                final_dom_state:
+                  ContextDev::Models::WebSearchResponse::Result::Markdown::FinalDomState::TaggedSymbol
               }
             )
           end
@@ -365,6 +422,45 @@ module ContextDev
             def self.values
             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::WebSearchResponse::Result::Markdown::FinalDomState
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            LOADED =
+              T.let(
+                :loaded,
+                ContextDev::Models::WebSearchResponse::Result::Markdown::FinalDomState::TaggedSymbol
+              )
+            STILL_LOADING =
+              T.let(
+                :"still-loading",
+                ContextDev::Models::WebSearchResponse::Result::Markdown::FinalDomState::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  ContextDev::Models::WebSearchResponse::Result::Markdown::FinalDomState::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
 
         # Relevance to the original query.

data/rbi/context_dev/models/web_web_crawl_md_params.rbi

@@ -141,14 +141,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::WebWebCrawlMdParams::TimeoutOpts)) }
+      attr_reader :timeout_opts
 
-      sig { params(timeout_ms: Integer).void }
-      attr_writer :timeout_ms
+      sig do
+        params(
+          timeout_opts: ContextDev::WebWebCrawlMdParams::TimeoutOpts::OrHash
+        ).void
+      end
+      attr_writer :timeout_opts
 
       # Regex pattern. Only URLs matching this pattern will be followed and scraped. An
       # automatic prefix scope in the form ^<starting URL> follows a redirect of the
@@ -203,7 +207,7 @@ module ContextDev
           shorten_base64_images: T::Boolean,
           stop_after_ms: Integer,
           tags: T::Array[String],
-          timeout_ms: Integer,
+          timeout_opts: ContextDev::WebWebCrawlMdParams::TimeoutOpts::OrHash,
           url_regex: String,
           use_main_content_only: T::Boolean,
           wait_for_ms: Integer,
@@ -261,10 +265,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,
         # Regex pattern. Only URLs matching this pattern will be followed and scraped. An
         # automatic prefix scope in the form ^<starting URL> follows a redirect of the
         # starting page.
@@ -303,7 +307,7 @@ module ContextDev
             shorten_base64_images: T::Boolean,
             stop_after_ms: Integer,
             tags: T::Array[String],
-            timeout_ms: Integer,
+            timeout_opts: ContextDev::WebWebCrawlMdParams::TimeoutOpts,
             url_regex: String,
             use_main_content_only: T::Boolean,
             wait_for_ms: Integer,
@@ -623,6 +627,112 @@ module ContextDev
         end
       end
 
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::WebWebCrawlMdParams::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::WebWebCrawlMdParams::TimeoutOpts::Behavior::OrSymbol
+            )
+          )
+        end
+        attr_reader :behavior
+
+        sig do
+          params(
+            behavior:
+              ContextDev::WebWebCrawlMdParams::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::WebWebCrawlMdParams::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::WebWebCrawlMdParams::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::WebWebCrawlMdParams::TimeoutOpts::Behavior
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FAIL =
+            T.let(
+              :fail,
+              ContextDev::WebWebCrawlMdParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+          RETURN_PARTIAL =
+            T.let(
+              :"return-partial",
+              ContextDev::WebWebCrawlMdParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::WebWebCrawlMdParams::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_crawl_md_response.rbi

@@ -35,6 +35,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
+
       sig do
         returns(T::Array[ContextDev::Models::WebWebCrawlMdResponse::Result])
       end
@@ -56,15 +61,26 @@ module ContextDev
       end
       attr_writer :key_metadata
 
+      # True when timeoutOpts.behavior=return-partial returned the usable results
+      # collected before the deadline. Partial collections are not cached as complete
+      # results.
+      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::WebWebCrawlMdResponse::CacheMetadata::OrHash,
           metadata: ContextDev::Models::WebWebCrawlMdResponse::Metadata::OrHash,
+          request_id: String,
           results:
             T::Array[ContextDev::Models::WebWebCrawlMdResponse::Result::OrHash],
           key_metadata:
-            ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata::OrHash
+            ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata::OrHash,
+          partial: T::Boolean
         ).returns(T.attached_class)
       end
       def self.new(
@@ -73,9 +89,16 @@ module ContextDev
         # oldest contributing hit.
         cache_metadata:,
         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:,
         results:,
         # Credit usage, included whenever a valid API key is provided.
-        key_metadata: nil
+        key_metadata: nil,
+        # True when timeoutOpts.behavior=return-partial returned the usable results
+        # collected before the deadline. Partial collections are not cached as complete
+        # results.
+        partial: nil
       )
       end
 
@@ -85,9 +108,12 @@ module ContextDev
             cache_metadata:
               ContextDev::Models::WebWebCrawlMdResponse::CacheMetadata,
             metadata: ContextDev::Models::WebWebCrawlMdResponse::Metadata,
+            request_id: String,
             results:
               T::Array[ContextDev::Models::WebWebCrawlMdResponse::Result],
-            key_metadata: ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata
+            key_metadata:
+              ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata,
+            partial: T::Boolean
           }
         )
       end