context.dev 1.30.0 → 1.32.0

data/rbi/context_dev/models/web_web_scrape_images_response.rbi

@@ -29,6 +29,23 @@ module ContextDev
       sig { returns(String) }
       attr_accessor :url
 
+      # Metadata about the API key used for the request. Included in every response
+      # whenever a valid API key is provided, even when the response status is not 200.
+      sig do
+        returns(
+          T.nilable(ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata)
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       sig do
         params(
           images:
@@ -37,7 +54,9 @@ module ContextDev
             ],
           success:
             ContextDev::Models::WebWebScrapeImagesResponse::Success::OrBoolean,
-          url: String
+          url: String,
+          key_metadata:
+            ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
@@ -46,7 +65,10 @@ module ContextDev
         # Always true on success.
         success:,
         # Page URL that was scraped.
-        url:
+        url:,
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        key_metadata: nil
       )
       end
 
@@ -57,7 +79,9 @@ module ContextDev
               T::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image],
             success:
               ContextDev::Models::WebWebScrapeImagesResponse::Success::TaggedBoolean,
-            url: String
+            url: String,
+            key_metadata:
+              ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata
           }
         )
       end
@@ -459,6 +483,47 @@ module ContextDev
         def self.values
         end
       end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # The number of credits consumed by this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # The number of credits remaining for your organization after this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_remaining
+
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        sig do
+          params(credits_consumed: Integer, credits_remaining: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The number of credits consumed by this request.
+          credits_consumed:,
+          # The number of credits remaining for your organization after this request.
+          credits_remaining:
+        )
+        end
+
+        sig do
+          override.returns(
+            { credits_consumed: Integer, credits_remaining: Integer }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/context_dev/models/web_web_scrape_md_response.rbi

@@ -27,12 +27,31 @@ module ContextDev
       sig { returns(String) }
       attr_accessor :url
 
+      # Metadata about the API key used for the request. Included in every response
+      # whenever a valid API key is provided, even when the response status is not 200.
+      sig do
+        returns(
+          T.nilable(ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata)
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       sig do
         params(
           markdown: String,
           success:
             ContextDev::Models::WebWebScrapeMdResponse::Success::OrBoolean,
-          url: String
+          url: String,
+          key_metadata:
+            ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
@@ -41,7 +60,10 @@ module ContextDev
         # Indicates success
         success:,
         # The URL that was scraped
-        url:
+        url:,
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        key_metadata: nil
       )
       end
 
@@ -51,7 +73,9 @@ module ContextDev
             markdown: String,
             success:
               ContextDev::Models::WebWebScrapeMdResponse::Success::TaggedBoolean,
-            url: String
+            url: String,
+            key_metadata:
+              ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata
           }
         )
       end
@@ -87,6 +111,47 @@ module ContextDev
         def self.values
         end
       end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # The number of credits consumed by this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # The number of credits remaining for your organization after this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_remaining
+
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        sig do
+          params(credits_consumed: Integer, credits_remaining: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The number of credits consumed by this request.
+          credits_consumed:,
+          # The number of credits remaining for your organization after this request.
+          credits_remaining:
+        )
+        end
+
+        sig do
+          override.returns(
+            { credits_consumed: Integer, credits_remaining: Integer }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi

@@ -38,13 +38,34 @@ module ContextDev
       sig { returns(T::Array[String]) }
       attr_accessor :urls
 
+      # Metadata about the API key used for the request. Included in every response
+      # whenever a valid API key is provided, even when the response status is not 200.
+      sig do
+        returns(
+          T.nilable(
+            ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata
+          )
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       sig do
         params(
           domain: String,
           meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta::OrHash,
           success:
             ContextDev::Models::WebWebScrapeSitemapResponse::Success::OrBoolean,
-          urls: T::Array[String]
+          urls: T::Array[String],
+          key_metadata:
+            ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
@@ -55,7 +76,10 @@ module ContextDev
         # Indicates success
         success:,
         # Array of discovered page URLs from the sitemap (max 500)
-        urls:
+        urls:,
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        key_metadata: nil
       )
       end
 
@@ -66,7 +90,9 @@ module ContextDev
             meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta,
             success:
               ContextDev::Models::WebWebScrapeSitemapResponse::Success::TaggedBoolean,
-            urls: T::Array[String]
+            urls: T::Array[String],
+            key_metadata:
+              ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata
           }
         )
       end
@@ -162,6 +188,47 @@ module ContextDev
         def self.values
         end
       end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # The number of credits consumed by this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # The number of credits remaining for your organization after this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_remaining
+
+        # Metadata about the API key used for the request. Included in every response
+        # whenever a valid API key is provided, even when the response status is not 200.
+        sig do
+          params(credits_consumed: Integer, credits_remaining: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The number of credits consumed by this request.
+          credits_consumed:,
+          # The number of credits remaining for your organization after this request.
+          credits_remaining:
+        )
+        end
+
+        sig do
+          override.returns(
+            { credits_consumed: Integer, credits_remaining: Integer }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/context_dev/resources/web.rbi

@@ -14,6 +14,8 @@ module ContextDev
           include_frames: T::Boolean,
           instructions: String,
           max_age_ms: Integer,
+          max_depth: Integer,
+          max_pages: Integer,
           pdf: ContextDev::WebExtractParams::Pdf::OrHash,
           stop_after_ms: Integer,
           timeout_ms: Integer,
@@ -46,8 +48,14 @@ module ContextDev
         # Return cached scrape results if a prior scrape for the same parameters is
         # younger than this many milliseconds. Defaults to 7 days (604800000 ms).
         max_age_ms: nil,
+        # Optional maximum link depth from the starting URL (0 = only the starting page).
+        # If omitted, there is no crawl depth limit.
+        max_depth: nil,
+        # Maximum number of pages to analyze for extraction. Hard cap: 50. Defaults to 5.
+        max_pages: nil,
         pdf: nil,
-        # Soft time budget for the crawl in milliseconds.
+        # Soft time budget for the crawl in milliseconds. Min: 10000 (10s). Max: 110000
+        # (110s). Default: 80000 (80s).
         stop_after_ms: 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
@@ -308,8 +316,8 @@ module ContextDev
         shorten_base64_images: nil,
         # Soft time budget for the crawl in milliseconds. After each scrape, the crawler
         # checks the elapsed time and, if exceeded, returns the pages collected so far
-        # instead of continuing. Min: 10000 (10s). Max: 240000 (4 min). Default: 120000 (2
-        # min).
+        # instead of continuing. Min: 10000 (10s). Max: 110000 (110s). Default: 80000
+        # (80s).
         stop_after_ms: 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
@@ -338,6 +346,7 @@ module ContextDev
           max_age_ms: Integer,
           pdf: ContextDev::WebWebScrapeHTMLParams::Pdf::OrHash,
           timeout_ms: Integer,
+          use_main_content_only: T::Boolean,
           wait_for_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(ContextDev::Models::WebWebScrapeHTMLResponse)
@@ -370,6 +379,9 @@ module ContextDev
         # than this value, it will be aborted with a 408 status code. Maximum allowed
         # value is 300000ms (5 minutes).
         timeout_ms: nil,
+        # When true, return only the page's main content in the HTML response, excluding
+        # headers, footers, sidebars, and navigation when detectable.
+        use_main_content_only: nil,
         # Optional browser wait time in milliseconds after initial page load. Min: 0. Max:
         # 30000 (30 seconds).
         wait_for_ms: nil,

data/sig/context_dev/models/ai_ai_query_response.rbs

@@ -4,6 +4,7 @@ module ContextDev
       {
         data_extracted: ::Array[ContextDev::Models::AIAIQueryResponse::DataExtracted],
         domain: String,
+        key_metadata: ContextDev::Models::AIAIQueryResponse::KeyMetadata,
         status: String,
         urls_analyzed: ::Array[String]
       }
@@ -19,6 +20,12 @@ module ContextDev
 
       def domain=: (String) -> String
 
+      attr_reader key_metadata: ContextDev::Models::AIAIQueryResponse::KeyMetadata?
+
+      def key_metadata=: (
+        ContextDev::Models::AIAIQueryResponse::KeyMetadata
+      ) -> ContextDev::Models::AIAIQueryResponse::KeyMetadata
+
       attr_reader status: String?
 
       def status=: (String) -> String
@@ -30,6 +37,7 @@ module ContextDev
       def initialize: (
         ?data_extracted: ::Array[ContextDev::Models::AIAIQueryResponse::DataExtracted],
         ?domain: String,
+        ?key_metadata: ContextDev::Models::AIAIQueryResponse::KeyMetadata,
         ?status: String,
         ?urls_analyzed: ::Array[String]
       ) -> void
@@ -37,6 +45,7 @@ module ContextDev
       def to_hash: -> {
         data_extracted: ::Array[ContextDev::Models::AIAIQueryResponse::DataExtracted],
         domain: String,
+        key_metadata: ContextDev::Models::AIAIQueryResponse::KeyMetadata,
         status: String,
         urls_analyzed: ::Array[String]
       }
@@ -88,6 +97,25 @@ module ContextDev
           UnionMember5Array: ContextDev::Internal::Type::Converter
         end
       end
+
+      type key_metadata =
+        { credits_consumed: Integer, credits_remaining: Integer }
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        attr_accessor credits_consumed: Integer
+
+        attr_accessor credits_remaining: Integer
+
+        def initialize: (
+          credits_consumed: Integer,
+          credits_remaining: Integer
+        ) -> void
+
+        def to_hash: -> {
+          credits_consumed: Integer,
+          credits_remaining: Integer
+        }
+      end
     end
   end
 end

data/sig/context_dev/models/ai_extract_product_response.rbs

@@ -3,6 +3,7 @@ module ContextDev
     type ai_extract_product_response =
       {
         is_product_page: bool,
+        key_metadata: ContextDev::Models::AIExtractProductResponse::KeyMetadata,
         platform: ContextDev::Models::AIExtractProductResponse::platform?,
         product: ContextDev::Models::AIExtractProductResponse::Product?
       }
@@ -12,22 +13,49 @@ module ContextDev
 
       def is_product_page=: (bool) -> bool
 
+      attr_reader key_metadata: ContextDev::Models::AIExtractProductResponse::KeyMetadata?
+
+      def key_metadata=: (
+        ContextDev::Models::AIExtractProductResponse::KeyMetadata
+      ) -> ContextDev::Models::AIExtractProductResponse::KeyMetadata
+
       attr_accessor platform: ContextDev::Models::AIExtractProductResponse::platform?
 
       attr_accessor product: ContextDev::Models::AIExtractProductResponse::Product?
 
       def initialize: (
         ?is_product_page: bool,
+        ?key_metadata: ContextDev::Models::AIExtractProductResponse::KeyMetadata,
         ?platform: ContextDev::Models::AIExtractProductResponse::platform?,
         ?product: ContextDev::Models::AIExtractProductResponse::Product?
       ) -> void
 
       def to_hash: -> {
         is_product_page: bool,
+        key_metadata: ContextDev::Models::AIExtractProductResponse::KeyMetadata,
         platform: ContextDev::Models::AIExtractProductResponse::platform?,
         product: ContextDev::Models::AIExtractProductResponse::Product?
       }
 
+      type key_metadata =
+        { credits_consumed: Integer, credits_remaining: Integer }
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        attr_accessor credits_consumed: Integer
+
+        attr_accessor credits_remaining: Integer
+
+        def initialize: (
+          credits_consumed: Integer,
+          credits_remaining: Integer
+        ) -> void
+
+        def to_hash: -> {
+          credits_consumed: Integer,
+          credits_remaining: Integer
+        }
+      end
+
       type platform = :amazon | :tiktok_shop | :etsy | :generic
 
       module Platform

data/sig/context_dev/models/ai_extract_products_response.rbs

@@ -2,10 +2,17 @@ module ContextDev
   module Models
     type ai_extract_products_response =
       {
+        key_metadata: ContextDev::Models::AIExtractProductsResponse::KeyMetadata,
         products: ::Array[ContextDev::Models::AIExtractProductsResponse::Product]
       }
 
     class AIExtractProductsResponse < ContextDev::Internal::Type::BaseModel
+      attr_reader key_metadata: ContextDev::Models::AIExtractProductsResponse::KeyMetadata?
+
+      def key_metadata=: (
+        ContextDev::Models::AIExtractProductsResponse::KeyMetadata
+      ) -> ContextDev::Models::AIExtractProductsResponse::KeyMetadata
+
       attr_reader products: ::Array[ContextDev::Models::AIExtractProductsResponse::Product]?
 
       def products=: (
@@ -13,13 +20,34 @@ module ContextDev
       ) -> ::Array[ContextDev::Models::AIExtractProductsResponse::Product]
 
       def initialize: (
+        ?key_metadata: ContextDev::Models::AIExtractProductsResponse::KeyMetadata,
         ?products: ::Array[ContextDev::Models::AIExtractProductsResponse::Product]
       ) -> void
 
       def to_hash: -> {
+        key_metadata: ContextDev::Models::AIExtractProductsResponse::KeyMetadata,
         products: ::Array[ContextDev::Models::AIExtractProductsResponse::Product]
       }
 
+      type key_metadata =
+        { credits_consumed: Integer, credits_remaining: Integer }
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        attr_accessor credits_consumed: Integer
+
+        attr_accessor credits_remaining: Integer
+
+        def initialize: (
+          credits_consumed: Integer,
+          credits_remaining: Integer
+        ) -> void
+
+        def to_hash: -> {
+          credits_consumed: Integer,
+          credits_remaining: Integer
+        }
+      end
+
       type product =
         {
           description: String,

data/sig/context_dev/models/brand_identify_from_transaction_response.rbs

@@ -4,6 +4,7 @@ module ContextDev
       {
         brand: ContextDev::Models::BrandIdentifyFromTransactionResponse::Brand,
         code: Integer,
+        key_metadata: ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata,
         status: String
       }
 
@@ -18,6 +19,12 @@ module ContextDev
 
       def code=: (Integer) -> Integer
 
+      attr_reader key_metadata: ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata?
+
+      def key_metadata=: (
+        ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata
+      ) -> ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata
+
       attr_reader status: String?
 
       def status=: (String) -> String
@@ -25,12 +32,14 @@ module ContextDev
       def initialize: (
         ?brand: ContextDev::Models::BrandIdentifyFromTransactionResponse::Brand,
         ?code: Integer,
+        ?key_metadata: ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata,
         ?status: String
       ) -> void
 
       def to_hash: -> {
         brand: ContextDev::Models::BrandIdentifyFromTransactionResponse::Brand,
         code: Integer,
+        key_metadata: ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata,
         status: String
       }
 
@@ -1408,6 +1417,25 @@ module ContextDev
           def to_hash: -> { exchange: String, ticker: String }
         end
       end
+
+      type key_metadata =
+        { credits_consumed: Integer, credits_remaining: Integer }
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        attr_accessor credits_consumed: Integer
+
+        attr_accessor credits_remaining: Integer
+
+        def initialize: (
+          credits_consumed: Integer,
+          credits_remaining: Integer
+        ) -> void
+
+        def to_hash: -> {
+          credits_consumed: Integer,
+          credits_remaining: Integer
+        }
+      end
     end
   end
 end

data/sig/context_dev/models/brand_retrieve_by_email_response.rbs

@@ -4,6 +4,7 @@ module ContextDev
       {
         brand: ContextDev::Models::BrandRetrieveByEmailResponse::Brand,
         code: Integer,
+        key_metadata: ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata,
         status: String
       }
 
@@ -18,6 +19,12 @@ module ContextDev
 
       def code=: (Integer) -> Integer
 
+      attr_reader key_metadata: ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata?
+
+      def key_metadata=: (
+        ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata
+      ) -> ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata
+
       attr_reader status: String?
 
       def status=: (String) -> String
@@ -25,12 +32,14 @@ module ContextDev
       def initialize: (
         ?brand: ContextDev::Models::BrandRetrieveByEmailResponse::Brand,
         ?code: Integer,
+        ?key_metadata: ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata,
         ?status: String
       ) -> void
 
       def to_hash: -> {
         brand: ContextDev::Models::BrandRetrieveByEmailResponse::Brand,
         code: Integer,
+        key_metadata: ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata,
         status: String
       }
 
@@ -1408,6 +1417,25 @@ module ContextDev
           def to_hash: -> { exchange: String, ticker: String }
         end
       end
+
+      type key_metadata =
+        { credits_consumed: Integer, credits_remaining: Integer }
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        attr_accessor credits_consumed: Integer
+
+        attr_accessor credits_remaining: Integer
+
+        def initialize: (
+          credits_consumed: Integer,
+          credits_remaining: Integer
+        ) -> void
+
+        def to_hash: -> {
+          credits_consumed: Integer,
+          credits_remaining: Integer
+        }
+      end
     end
   end
 end