context.dev 2.12.0 → 2.14.0

data/rbi/context_dev/models/web_web_scrape_html_response.rbi

@@ -11,6 +11,22 @@ 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 do
+        returns(ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata)
+      end
+      attr_reader :cache_metadata
+
+      sig do
+        params(
+          cache_metadata:
+            ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::OrHash
+        ).void
+      end
+      attr_writer :cache_metadata
+
       # The scraped content of the page. For normal pages this is the raw HTML. When the
       # page is a sitemap or feed served behind an XSL stylesheet (which browsers render
       # into HTML), this is the underlying XML instead — see the `type` field.
@@ -101,6 +117,8 @@ module ContextDev
 
       sig do
         params(
+          cache_metadata:
+            ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::OrHash,
           html: String,
           metadata:
             ContextDev::Models::WebWebScrapeHTMLResponse::Metadata::OrHash,
@@ -118,6 +136,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:,
         # The scraped content of the page. For normal pages this is the raw HTML. When the
         # page is a sitemap or feed served behind an XSL stylesheet (which browsers render
         # into HTML), this is the underlying XML instead — see the `type` field.
@@ -147,6 +169,8 @@ module ContextDev
       sig do
         override.returns(
           {
+            cache_metadata:
+              ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata,
             html: String,
             metadata: ContextDev::Models::WebWebScrapeHTMLResponse::Metadata,
             success:
@@ -167,6 +191,101 @@ module ContextDev
       def to_hash
       end
 
+      class CacheMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebWebScrapeHTMLResponse::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::WebWebScrapeHTMLResponse::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::WebWebScrapeHTMLResponse::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::WebWebScrapeHTMLResponse::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::WebWebScrapeHTMLResponse::CacheMetadata::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          HIT =
+            T.let(
+              :hit,
+              ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::Status::TaggedSymbol
+            )
+          MISS =
+            T.let(
+              :miss,
+              ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::Status::TaggedSymbol
+            )
+          ZDR =
+            T.let(
+              :zdr,
+              ContextDev::Models::WebWebScrapeHTMLResponse::CacheMetadata::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Models::WebWebScrapeHTMLResponse::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/models/web_web_scrape_images_response.rbi

@@ -11,6 +11,22 @@ 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 do
+        returns(ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata)
+      end
+      attr_reader :cache_metadata
+
+      sig do
+        params(
+          cache_metadata:
+            ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::OrHash
+        ).void
+      end
+      attr_writer :cache_metadata
+
       # Images found on the page.
       sig do
         returns(T::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image])
@@ -70,6 +86,8 @@ module ContextDev
 
       sig do
         params(
+          cache_metadata:
+            ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::OrHash,
           images:
             T::Array[
               ContextDev::Models::WebWebScrapeImagesResponse::Image::OrHash
@@ -86,6 +104,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:,
         # Images found on the page.
         images:,
         # Always true on success.
@@ -103,6 +125,8 @@ module ContextDev
       sig do
         override.returns(
           {
+            cache_metadata:
+              ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata,
             images:
               T::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image],
             success:
@@ -120,6 +144,101 @@ module ContextDev
       def to_hash
       end
 
+      class CacheMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebWebScrapeImagesResponse::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::WebWebScrapeImagesResponse::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::WebWebScrapeImagesResponse::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::WebWebScrapeImagesResponse::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::WebWebScrapeImagesResponse::CacheMetadata::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          HIT =
+            T.let(
+              :hit,
+              ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status::TaggedSymbol
+            )
+          MISS =
+            T.let(
+              :miss,
+              ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status::TaggedSymbol
+            )
+          ZDR =
+            T.let(
+              :zdr,
+              ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Models::WebWebScrapeImagesResponse::CacheMetadata::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       class Image < ContextDev::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

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/models/web_web_scrape_sitemap_params.rbi

@@ -27,6 +27,14 @@ module ContextDev
       sig { params(headers: T::Hash[Symbol, String]).void }
       attr_writer :headers
 
+      # When true, discover and include public pages and sitemaps on subdomains of the
+      # requested domain. Defaults to false.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :include_subdomains
+
+      sig { params(include_subdomains: T::Boolean).void }
+      attr_writer :include_subdomains
+
       # Maximum number of links to return from the sitemap crawl. Defaults to 10,000.
       # Minimum is 1, maximum is 100,000.
       sig { returns(T.nilable(Integer)) }
@@ -96,6 +104,7 @@ module ContextDev
         params(
           domain: String,
           headers: T::Hash[Symbol, String],
+          include_subdomains: T::Boolean,
           max_links: Integer,
           search: String,
           sitemap_url: String,
@@ -113,6 +122,9 @@ module ContextDev
         # deep-object query params such as headers[X-Custom]=value. When provided, caching
         # is bypassed: the result is neither read from nor written to cache.
         headers: nil,
+        # When true, discover and include public pages and sitemaps on subdomains of the
+        # requested domain. Defaults to false.
+        include_subdomains: nil,
         # Maximum number of links to return from the sitemap crawl. Defaults to 10,000.
         # Minimum is 1, maximum is 100,000.
         max_links: nil,
@@ -148,6 +160,7 @@ module ContextDev
           {
             domain: String,
             headers: T::Hash[Symbol, String],
+            include_subdomains: T::Boolean,
             max_links: Integer,
             search: String,
             sitemap_url: String,

data/rbi/context_dev/resources/web.rbi

@@ -729,15 +729,17 @@ module ContextDev
       )
       end
 
-      # Crawl an entire website's sitemap and return all discovered page URLs. Pass
-      # `search` to have the crawled sitemap filtered down to the pages about a phrase
-      # (for example `pricing and plans` or `api authentication docs`), most relevant
-      # first — a searched crawl scans the whole sitemap and costs 2 credits instead
-      # of 1.
+      # Crawl an entire website's sitemap and return all discovered page URLs. Set
+      # `includeSubdomains=true` to also discover public pages and sitemaps on child
+      # hosts such as `docs.example.com` or `brand.example.com`. Pass `search` to have
+      # the discovered URLs filtered down to the pages about a phrase (for example
+      # `pricing and plans` or `api authentication docs`), most relevant first — a
+      # searched crawl scans the whole sitemap and costs 2 credits instead of 1.
       sig do
         params(
           domain: String,
           headers: T::Hash[Symbol, String],
+          include_subdomains: T::Boolean,
           max_links: Integer,
           search: String,
           sitemap_url: String,
@@ -755,6 +757,9 @@ module ContextDev
         # deep-object query params such as headers[X-Custom]=value. When provided, caching
         # is bypassed: the result is neither read from nor written to cache.
         headers: nil,
+        # When true, discover and include public pages and sitemaps on subdomains of the
+        # requested domain. Defaults to false.
+        include_subdomains: nil,
         # Maximum number of links to return from the sitemap crawl. Defaults to 10,000.
         # Minimum is 1, maximum is 100,000.
         max_links: nil,

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 }
 

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 }