context.dev 2.11.0 → 2.13.0

data/rbi/context_dev/models/web_web_scrape_md_response.rbi

@@ -11,6 +11,20 @@ module ContextDev
           )
         end
 
+      # Cache outcome for this response. Composite responses are hits only when every
+      # cache-controlled fetch contributing to the output was a hit; age_ms is the
+      # oldest contributing hit.
+      sig { returns(ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata) }
+      attr_reader :cache_metadata
+
+      sig do
+        params(
+          cache_metadata:
+            ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::OrHash
+        ).void
+      end
+      attr_writer :cache_metadata
+
       # UTF-8 byte length of the returned Markdown. Use 0 to identify an empty result
       # and compare small values against your workload's minimum useful-content
       # threshold.
@@ -100,6 +114,8 @@ module ContextDev
 
       sig do
         params(
+          cache_metadata:
+            ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::OrHash,
           content_length: Integer,
           markdown: String,
           metadata:
@@ -118,6 +134,10 @@ module ContextDev
         ).returns(T.attached_class)
       end
       def self.new(
+        # Cache outcome for this response. Composite responses are hits only when every
+        # cache-controlled fetch contributing to the output was a hit; age_ms is the
+        # oldest contributing hit.
+        cache_metadata:,
         # UTF-8 byte length of the returned Markdown. Use 0 to identify an empty result
         # and compare small values against your workload's minimum useful-content
         # threshold.
@@ -148,6 +168,8 @@ module ContextDev
       sig do
         override.returns(
           {
+            cache_metadata:
+              ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata,
             content_length: Integer,
             markdown: String,
             metadata: ContextDev::Models::WebWebScrapeMdResponse::Metadata,
@@ -168,6 +190,101 @@ module ContextDev
       def to_hash
       end
 
+      class CacheMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Age of the cached data in milliseconds. Zero for miss and zdr responses.
+        sig { returns(Integer) }
+        attr_accessor :age_ms
+
+        # Whether the response was served from cache, required fresh work, or honored
+        # zero-data-retention cache bypass.
+        sig do
+          returns(
+            ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # Cache outcome for this response. Composite responses are hits only when every
+        # cache-controlled fetch contributing to the output was a hit; age_ms is the
+        # oldest contributing hit.
+        sig do
+          params(
+            age_ms: Integer,
+            status:
+              ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::Status::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Age of the cached data in milliseconds. Zero for miss and zdr responses.
+          age_ms:,
+          # Whether the response was served from cache, required fresh work, or honored
+          # zero-data-retention cache bypass.
+          status:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              age_ms: Integer,
+              status:
+                ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::Status::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Whether the response was served from cache, required fresh work, or honored
+        # zero-data-retention cache bypass.
+        module Status
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          HIT =
+            T.let(
+              :hit,
+              ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::Status::TaggedSymbol
+            )
+          MISS =
+            T.let(
+              :miss,
+              ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::Status::TaggedSymbol
+            )
+          ZDR =
+            T.let(
+              :zdr,
+              ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Models::WebWebScrapeMdResponse::CacheMetadata::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       class Metadata < ContextDev::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/context_dev/resources/web.rbi

@@ -9,6 +9,14 @@ module ContextDev
         params(
           schema: T::Hash[Symbol, T.anything],
           url: String,
+          actions:
+            T::Array[
+              T.any(
+                ContextDev::WebExtractParams::Action::Wait::OrHash,
+                ContextDev::WebExtractParams::Action::Perform::OrHash,
+                ContextDev::WebExtractParams::Action::Scroll::OrHash
+              )
+            ],
           fact_check: T::Boolean,
           follow_subdomains: T::Boolean,
           include_frames: T::Boolean,
@@ -26,13 +34,20 @@ module ContextDev
         ).returns(ContextDev::Models::WebExtractResponse)
       end
       def extract(
-        # JSON Schema for the returned data object. TypeScript Zod users can pass a JSON
-        # Schema generated from a Zod object; Python users can pass the equivalent JSON
-        # Schema object.
+        # JSON Schema for the returned data object. Image fields such as `image_urls` or
+        # `product_photos` automatically make page image references available to
+        # extraction, so product data and photos can be returned in one call. TypeScript
+        # Zod users can pass a JSON Schema generated from a Zod object; Python users can
+        # pass the equivalent JSON Schema object.
         schema:,
         # The starting website URL to crawl and extract from. Must include http:// or
         # https://.
         url:,
+        # Optional browser actions executed in order on the requested page after it loads,
+        # before links are discovered or additional pages are crawled. Requires a paid
+        # plan. When actions are provided and stopAfterMs is omitted, the crawl budget
+        # defaults to 110000 ms.
+        actions: nil,
         # When true, every returned value must be grounded in facts stated on the page;
         # fields that cannot be supported by the page are returned as null/empty. When
         # false (default), the model may make reasonable inferences and derivations from
@@ -61,7 +76,8 @@ module ContextDev
         # exchange for more stable output on animated pages.
         settle_animations: nil,
         # Soft time budget for the crawl in milliseconds. Min: 10000 (10s). Max: 110000
-        # (110s). Default: 80000 (80s).
+        # (110s). Defaults to 80000 (80s), or 110000 (110s) when browser actions are
+        # provided.
         stop_after_ms: nil,
         # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
         tags: nil,
@@ -408,13 +424,15 @@ module ContextDev
         # than this value, it will be aborted with a 408 status code. Maximum allowed
         # value is 300000ms (5 minutes).
         timeout_ms: nil,
-        # Regex pattern. Only URLs matching this pattern will be followed and scraped.
+        # 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.
         url_regex: nil,
         # Extract only the main content, stripping headers, footers, sidebars, and
         # navigation
         use_main_content_only: nil,
-        # Optional browser wait time in milliseconds after initial page load for each
-        # crawled page. Min: 0. Max: 30000 (30 seconds).
+        # Browser wait time in milliseconds after initial page load for each crawled page.
+        # Defaults to 3500 (3.5 seconds). Min: 0. Max: 30000 (30 seconds).
         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
@@ -435,7 +453,8 @@ module ContextDev
               T::Array[
                 T.any(
                   ContextDev::WebWebScrapeHTMLParams::Action::Wait::OrHash,
-                  ContextDev::WebWebScrapeHTMLParams::Action::Perform::OrHash
+                  ContextDev::WebWebScrapeHTMLParams::Action::Perform::OrHash,
+                  ContextDev::WebWebScrapeHTMLParams::Action::Scroll::OrHash
                 )
               ]
             ),
@@ -526,7 +545,8 @@ module ContextDev
               T::Array[
                 T.any(
                   ContextDev::WebWebScrapeImagesParams::Action::Wait::OrHash,
-                  ContextDev::WebWebScrapeImagesParams::Action::Perform::OrHash
+                  ContextDev::WebWebScrapeImagesParams::Action::Perform::OrHash,
+                  ContextDev::WebWebScrapeImagesParams::Action::Scroll::OrHash
                 )
               ]
             ),
@@ -615,7 +635,8 @@ module ContextDev
               T::Array[
                 T.any(
                   ContextDev::WebWebScrapeMdParams::Action::Wait::OrHash,
-                  ContextDev::WebWebScrapeMdParams::Action::Perform::OrHash
+                  ContextDev::WebWebScrapeMdParams::Action::Perform::OrHash,
+                  ContextDev::WebWebScrapeMdParams::Action::Scroll::OrHash
                 )
               ]
             ),

data/sig/context_dev/models/ai_extract_product_response.rbs

@@ -2,6 +2,7 @@ module ContextDev
   module Models
     type ai_extract_product_response =
       {
+        cache_metadata: ContextDev::Models::AIExtractProductResponse::CacheMetadata,
         is_product_page: bool,
         key_metadata: ContextDev::Models::AIExtractProductResponse::KeyMetadata,
         platform: ContextDev::Models::AIExtractProductResponse::platform?,
@@ -9,6 +10,8 @@ module ContextDev
       }
 
     class AIExtractProductResponse < ContextDev::Internal::Type::BaseModel
+      attr_accessor cache_metadata: ContextDev::Models::AIExtractProductResponse::CacheMetadata
+
       attr_reader is_product_page: bool?
 
       def is_product_page=: (bool) -> bool
@@ -24,6 +27,7 @@ module ContextDev
       attr_accessor product: ContextDev::Models::AIExtractProductResponse::Product?
 
       def initialize: (
+        cache_metadata: ContextDev::Models::AIExtractProductResponse::CacheMetadata,
         ?is_product_page: bool,
         ?key_metadata: ContextDev::Models::AIExtractProductResponse::KeyMetadata,
         ?platform: ContextDev::Models::AIExtractProductResponse::platform?,
@@ -31,12 +35,47 @@ module ContextDev
       ) -> void
 
       def to_hash: -> {
+        cache_metadata: ContextDev::Models::AIExtractProductResponse::CacheMetadata,
         is_product_page: bool,
         key_metadata: ContextDev::Models::AIExtractProductResponse::KeyMetadata,
         platform: ContextDev::Models::AIExtractProductResponse::platform?,
         product: ContextDev::Models::AIExtractProductResponse::Product?
       }
 
+      type cache_metadata =
+        {
+          age_ms: Integer,
+          status: ContextDev::Models::AIExtractProductResponse::CacheMetadata::status
+        }
+
+      class CacheMetadata < ContextDev::Internal::Type::BaseModel
+        attr_accessor age_ms: Integer
+
+        attr_accessor status: ContextDev::Models::AIExtractProductResponse::CacheMetadata::status
+
+        def initialize: (
+          age_ms: Integer,
+          status: ContextDev::Models::AIExtractProductResponse::CacheMetadata::status
+        ) -> void
+
+        def to_hash: -> {
+          age_ms: Integer,
+          status: ContextDev::Models::AIExtractProductResponse::CacheMetadata::status
+        }
+
+        type status = :hit | :miss | :zdr
+
+        module Status
+          extend ContextDev::Internal::Type::Enum
+
+          HIT: :hit
+          MISS: :miss
+          ZDR: :zdr
+
+          def self?.values: -> ::Array[ContextDev::Models::AIExtractProductResponse::CacheMetadata::status]
+        end
+      end
+
       type key_metadata =
         { credits_consumed: Integer, credits_remaining: Integer }
 
@@ -78,12 +117,15 @@ module ContextDev
           sku: String?,
           tags: ::Array[String],
           target_audience: ::Array[String],
+          availability: ContextDev::Models::AIExtractProductResponse::Product::availability?,
           billing_frequency: ContextDev::Models::AIExtractProductResponse::Product::billing_frequency?,
           category: String?,
           currency: String?,
+          dimensions: ::Array[String],
           image_url: String?,
           price: Float?,
           pricing_model: ContextDev::Models::AIExtractProductResponse::Product::pricing_model?,
+          regular_price: Float?,
           url: String?
         }
 
@@ -102,18 +144,26 @@ module ContextDev
 
         attr_accessor target_audience: ::Array[String]
 
+        attr_accessor availability: ContextDev::Models::AIExtractProductResponse::Product::availability?
+
         attr_accessor billing_frequency: ContextDev::Models::AIExtractProductResponse::Product::billing_frequency?
 
         attr_accessor category: String?
 
         attr_accessor currency: String?
 
+        attr_reader dimensions: ::Array[String]?
+
+        def dimensions=: (::Array[String]) -> ::Array[String]
+
         attr_accessor image_url: String?
 
         attr_accessor price: Float?
 
         attr_accessor pricing_model: ContextDev::Models::AIExtractProductResponse::Product::pricing_model?
 
+        attr_accessor regular_price: Float?
+
         attr_accessor url: String?
 
         def initialize: (
@@ -124,12 +174,15 @@ module ContextDev
           sku: String?,
           tags: ::Array[String],
           target_audience: ::Array[String],
+          ?availability: ContextDev::Models::AIExtractProductResponse::Product::availability?,
           ?billing_frequency: ContextDev::Models::AIExtractProductResponse::Product::billing_frequency?,
           ?category: String?,
           ?currency: String?,
+          ?dimensions: ::Array[String],
           ?image_url: String?,
           ?price: Float?,
           ?pricing_model: ContextDev::Models::AIExtractProductResponse::Product::pricing_model?,
+          ?regular_price: Float?,
           ?url: String?
         ) -> void
 
@@ -141,15 +194,41 @@ module ContextDev
           sku: String?,
           tags: ::Array[String],
           target_audience: ::Array[String],
+          availability: ContextDev::Models::AIExtractProductResponse::Product::availability?,
           billing_frequency: ContextDev::Models::AIExtractProductResponse::Product::billing_frequency?,
           category: String?,
           currency: String?,
+          dimensions: ::Array[String],
           image_url: String?,
           price: Float?,
           pricing_model: ContextDev::Models::AIExtractProductResponse::Product::pricing_model?,
+          regular_price: Float?,
           url: String?
         }
 
+        type availability =
+          :in_stock
+          | :out_of_stock
+          | :limited_availability
+          | :preorder
+          | :backorder
+          | :made_to_order
+          | :discontinued
+
+        module Availability
+          extend ContextDev::Internal::Type::Enum
+
+          IN_STOCK: :in_stock
+          OUT_OF_STOCK: :out_of_stock
+          LIMITED_AVAILABILITY: :limited_availability
+          PREORDER: :preorder
+          BACKORDER: :backorder
+          MADE_TO_ORDER: :made_to_order
+          DISCONTINUED: :discontinued
+
+          def self?.values: -> ::Array[ContextDev::Models::AIExtractProductResponse::Product::availability]
+        end
+
         type billing_frequency = :monthly | :yearly | :one_time | :usage_based
 
         module BillingFrequency

data/sig/context_dev/models/ai_extract_products_response.rbs

@@ -2,11 +2,14 @@ module ContextDev
   module Models
     type ai_extract_products_response =
       {
+        cache_metadata: ContextDev::Models::AIExtractProductsResponse::CacheMetadata,
         key_metadata: ContextDev::Models::AIExtractProductsResponse::KeyMetadata,
         products: ::Array[ContextDev::Models::AIExtractProductsResponse::Product]
       }
 
     class AIExtractProductsResponse < ContextDev::Internal::Type::BaseModel
+      attr_accessor cache_metadata: ContextDev::Models::AIExtractProductsResponse::CacheMetadata
+
       attr_reader key_metadata: ContextDev::Models::AIExtractProductsResponse::KeyMetadata?
 
       def key_metadata=: (
@@ -20,15 +23,51 @@ module ContextDev
       ) -> ::Array[ContextDev::Models::AIExtractProductsResponse::Product]
 
       def initialize: (
+        cache_metadata: ContextDev::Models::AIExtractProductsResponse::CacheMetadata,
         ?key_metadata: ContextDev::Models::AIExtractProductsResponse::KeyMetadata,
         ?products: ::Array[ContextDev::Models::AIExtractProductsResponse::Product]
       ) -> void
 
       def to_hash: -> {
+        cache_metadata: ContextDev::Models::AIExtractProductsResponse::CacheMetadata,
         key_metadata: ContextDev::Models::AIExtractProductsResponse::KeyMetadata,
         products: ::Array[ContextDev::Models::AIExtractProductsResponse::Product]
       }
 
+      type cache_metadata =
+        {
+          age_ms: Integer,
+          status: ContextDev::Models::AIExtractProductsResponse::CacheMetadata::status
+        }
+
+      class CacheMetadata < ContextDev::Internal::Type::BaseModel
+        attr_accessor age_ms: Integer
+
+        attr_accessor status: ContextDev::Models::AIExtractProductsResponse::CacheMetadata::status
+
+        def initialize: (
+          age_ms: Integer,
+          status: ContextDev::Models::AIExtractProductsResponse::CacheMetadata::status
+        ) -> void
+
+        def to_hash: -> {
+          age_ms: Integer,
+          status: ContextDev::Models::AIExtractProductsResponse::CacheMetadata::status
+        }
+
+        type status = :hit | :miss | :zdr
+
+        module Status
+          extend ContextDev::Internal::Type::Enum
+
+          HIT: :hit
+          MISS: :miss
+          ZDR: :zdr
+
+          def self?.values: -> ::Array[ContextDev::Models::AIExtractProductsResponse::CacheMetadata::status]
+        end
+      end
+
       type key_metadata =
         { credits_consumed: Integer, credits_remaining: Integer }
 
@@ -57,12 +96,15 @@ module ContextDev
           sku: String?,
           tags: ::Array[String],
           target_audience: ::Array[String],
+          availability: ContextDev::Models::AIExtractProductsResponse::Product::availability?,
           billing_frequency: ContextDev::Models::AIExtractProductsResponse::Product::billing_frequency?,
           category: String?,
           currency: String?,
+          dimensions: ::Array[String],
           image_url: String?,
           price: Float?,
           pricing_model: ContextDev::Models::AIExtractProductsResponse::Product::pricing_model?,
+          regular_price: Float?,
           url: String?
         }
 
@@ -81,18 +123,26 @@ module ContextDev
 
         attr_accessor target_audience: ::Array[String]
 
+        attr_accessor availability: ContextDev::Models::AIExtractProductsResponse::Product::availability?
+
         attr_accessor billing_frequency: ContextDev::Models::AIExtractProductsResponse::Product::billing_frequency?
 
         attr_accessor category: String?
 
         attr_accessor currency: String?
 
+        attr_reader dimensions: ::Array[String]?
+
+        def dimensions=: (::Array[String]) -> ::Array[String]
+
         attr_accessor image_url: String?
 
         attr_accessor price: Float?
 
         attr_accessor pricing_model: ContextDev::Models::AIExtractProductsResponse::Product::pricing_model?
 
+        attr_accessor regular_price: Float?
+
         attr_accessor url: String?
 
         def initialize: (
@@ -103,12 +153,15 @@ module ContextDev
           sku: String?,
           tags: ::Array[String],
           target_audience: ::Array[String],
+          ?availability: ContextDev::Models::AIExtractProductsResponse::Product::availability?,
           ?billing_frequency: ContextDev::Models::AIExtractProductsResponse::Product::billing_frequency?,
           ?category: String?,
           ?currency: String?,
+          ?dimensions: ::Array[String],
           ?image_url: String?,
           ?price: Float?,
           ?pricing_model: ContextDev::Models::AIExtractProductsResponse::Product::pricing_model?,
+          ?regular_price: Float?,
           ?url: String?
         ) -> void
 
@@ -120,15 +173,41 @@ module ContextDev
           sku: String?,
           tags: ::Array[String],
           target_audience: ::Array[String],
+          availability: ContextDev::Models::AIExtractProductsResponse::Product::availability?,
           billing_frequency: ContextDev::Models::AIExtractProductsResponse::Product::billing_frequency?,
           category: String?,
           currency: String?,
+          dimensions: ::Array[String],
           image_url: String?,
           price: Float?,
           pricing_model: ContextDev::Models::AIExtractProductsResponse::Product::pricing_model?,
+          regular_price: Float?,
           url: String?
         }
 
+        type availability =
+          :in_stock
+          | :out_of_stock
+          | :limited_availability
+          | :preorder
+          | :backorder
+          | :made_to_order
+          | :discontinued
+
+        module Availability
+          extend ContextDev::Internal::Type::Enum
+
+          IN_STOCK: :in_stock
+          OUT_OF_STOCK: :out_of_stock
+          LIMITED_AVAILABILITY: :limited_availability
+          PREORDER: :preorder
+          BACKORDER: :backorder
+          MADE_TO_ORDER: :made_to_order
+          DISCONTINUED: :discontinued
+
+          def self?.values: -> ::Array[ContextDev::Models::AIExtractProductsResponse::Product::availability]
+        end
+
         type billing_frequency = :monthly | :yearly | :one_time | :usage_based
 
         module BillingFrequency

data/sig/context_dev/models/batch_get_results_response.rbs

@@ -50,6 +50,7 @@ module ContextDev
 
         type ok =
           {
+            cache_metadata: ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata,
             final_url: String,
             http_status: Integer?,
             metadata: ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata,
@@ -63,6 +64,8 @@ module ContextDev
           }
 
         class Ok < ContextDev::Internal::Type::BaseModel
+          attr_accessor cache_metadata: ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata
+
           attr_accessor final_url: String
 
           attr_accessor http_status: Integer?
@@ -94,6 +97,7 @@ module ContextDev
           def ocr_pages=: (Integer) -> Integer
 
           def initialize: (
+            cache_metadata: ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata,
             final_url: String,
             http_status: Integer?,
             metadata: ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata,
@@ -107,6 +111,7 @@ module ContextDev
           ) -> void
 
           def to_hash: -> {
+            cache_metadata: ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata,
             final_url: String,
             http_status: Integer?,
             metadata: ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata,
@@ -119,6 +124,40 @@ module ContextDev
             ocr_pages: Integer
           }
 
+          type cache_metadata =
+            {
+              age_ms: Integer,
+              status: ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata::status
+            }
+
+          class CacheMetadata < ContextDev::Internal::Type::BaseModel
+            attr_accessor age_ms: Integer
+
+            attr_accessor status: ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata::status
+
+            def initialize: (
+              age_ms: Integer,
+              status: ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata::status
+            ) -> void
+
+            def to_hash: -> {
+              age_ms: Integer,
+              status: ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata::status
+            }
+
+            type status = :hit | :miss | :zdr
+
+            module Status
+              extend ContextDev::Internal::Type::Enum
+
+              HIT: :hit
+              MISS: :miss
+              ZDR: :zdr
+
+              def self?.values: -> ::Array[ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata::status]
+            end
+          end
+
           type metadata =
             {
               final_url: String,