context.dev 1.31.0 → 1.32.0

data/lib/context_dev/models/web_web_crawl_md_response.rb

@@ -15,9 +15,22 @@ module ContextDev
       required :results,
                -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebWebCrawlMdResponse::Result] }
 
-      # @!method initialize(metadata:, results:)
+      # @!attribute key_metadata
+      #   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.
+      #
+      #   @return [ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata }
+
+      # @!method initialize(metadata:, results:, key_metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::WebWebCrawlMdResponse} for more details.
+      #
       #   @param metadata [ContextDev::Models::WebWebCrawlMdResponse::Metadata]
+      #
       #   @param results [Array<ContextDev::Models::WebWebCrawlMdResponse::Result>]
+      #
+      #   @param key_metadata [ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
 
       # @see ContextDev::Models::WebWebCrawlMdResponse#metadata
       class Metadata < ContextDev::Internal::Type::BaseModel
@@ -128,6 +141,29 @@ module ContextDev
           #   @param url [String] The URL that was fetched
         end
       end
+
+      # @see ContextDev::Models::WebWebCrawlMdResponse#key_metadata
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute credits_consumed
+        #   The number of credits consumed by this request.
+        #
+        #   @return [Integer]
+        required :credits_consumed, Integer
+
+        # @!attribute credits_remaining
+        #   The number of credits remaining for your organization after this request.
+        #
+        #   @return [Integer]
+        required :credits_remaining, Integer
+
+        # @!method initialize(credits_consumed:, 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.
+        #
+        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #
+        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+      end
     end
   end
 end

data/lib/context_dev/models/web_web_scrape_html_response.rb

@@ -31,7 +31,14 @@ module ContextDev
       #   @return [String]
       required :url, String
 
-      # @!method initialize(html:, success:, type:, url:)
+      # @!attribute key_metadata
+      #   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.
+      #
+      #   @return [ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata }
+
+      # @!method initialize(html:, success:, type:, url:, key_metadata: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebWebScrapeHTMLResponse} for more details.
       #
@@ -42,6 +49,8 @@ module ContextDev
       #   @param type [Symbol, ContextDev::Models::WebWebScrapeHTMLResponse::Type] Detected content type of the returned `html` field. Sitemaps and feeds are surfa
       #
       #   @param url [String] The URL that was scraped
+      #
+      #   @param key_metadata [ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
 
       # Indicates success
       #
@@ -74,6 +83,29 @@ module ContextDev
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      # @see ContextDev::Models::WebWebScrapeHTMLResponse#key_metadata
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute credits_consumed
+        #   The number of credits consumed by this request.
+        #
+        #   @return [Integer]
+        required :credits_consumed, Integer
+
+        # @!attribute credits_remaining
+        #   The number of credits remaining for your organization after this request.
+        #
+        #   @return [Integer]
+        required :credits_remaining, Integer
+
+        # @!method initialize(credits_consumed:, 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.
+        #
+        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #
+        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+      end
     end
   end
 end

data/lib/context_dev/models/web_web_scrape_images_response.rb

@@ -23,12 +23,24 @@ module ContextDev
       #   @return [String]
       required :url, String
 
-      # @!method initialize(images:, success:, url:)
+      # @!attribute key_metadata
+      #   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.
+      #
+      #   @return [ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata }
+
+      # @!method initialize(images:, success:, url:, key_metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::WebWebScrapeImagesResponse} for more details.
+      #
       #   @param images [Array<ContextDev::Models::WebWebScrapeImagesResponse::Image>] Images found on the page.
       #
       #   @param success [Boolean, ContextDev::Models::WebWebScrapeImagesResponse::Success] Always true on success.
       #
       #   @param url [String] Page URL that was scraped.
+      #
+      #   @param key_metadata [ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
 
       class Image < ContextDev::Internal::Type::BaseModel
         # @!attribute alt
@@ -183,6 +195,29 @@ module ContextDev
         # @!method self.values
         #   @return [Array<Boolean>]
       end
+
+      # @see ContextDev::Models::WebWebScrapeImagesResponse#key_metadata
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute credits_consumed
+        #   The number of credits consumed by this request.
+        #
+        #   @return [Integer]
+        required :credits_consumed, Integer
+
+        # @!attribute credits_remaining
+        #   The number of credits remaining for your organization after this request.
+        #
+        #   @return [Integer]
+        required :credits_remaining, Integer
+
+        # @!method initialize(credits_consumed:, 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.
+        #
+        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #
+        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+      end
     end
   end
 end

data/lib/context_dev/models/web_web_scrape_md_response.rb

@@ -22,12 +22,24 @@ module ContextDev
       #   @return [String]
       required :url, String
 
-      # @!method initialize(markdown:, success:, url:)
+      # @!attribute key_metadata
+      #   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.
+      #
+      #   @return [ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata }
+
+      # @!method initialize(markdown:, success:, url:, key_metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::WebWebScrapeMdResponse} for more details.
+      #
       #   @param markdown [String] Page content converted to GitHub Flavored Markdown
       #
       #   @param success [Boolean, ContextDev::Models::WebWebScrapeMdResponse::Success] Indicates success
       #
       #   @param url [String] The URL that was scraped
+      #
+      #   @param key_metadata [ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
 
       # Indicates success
       #
@@ -40,6 +52,29 @@ module ContextDev
         # @!method self.values
         #   @return [Array<Boolean>]
       end
+
+      # @see ContextDev::Models::WebWebScrapeMdResponse#key_metadata
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute credits_consumed
+        #   The number of credits consumed by this request.
+        #
+        #   @return [Integer]
+        required :credits_consumed, Integer
+
+        # @!attribute credits_remaining
+        #   The number of credits remaining for your organization after this request.
+        #
+        #   @return [Integer]
+        required :credits_remaining, Integer
+
+        # @!method initialize(credits_consumed:, 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.
+        #
+        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #
+        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+      end
     end
   end
 end

data/lib/context_dev/models/web_web_scrape_sitemap_response.rb

@@ -28,7 +28,17 @@ module ContextDev
       #   @return [Array<String>]
       required :urls, ContextDev::Internal::Type::ArrayOf[String]
 
-      # @!method initialize(domain:, meta:, success:, urls:)
+      # @!attribute key_metadata
+      #   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.
+      #
+      #   @return [ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata }
+
+      # @!method initialize(domain:, meta:, success:, urls:, key_metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::WebWebScrapeSitemapResponse} for more details.
+      #
       #   @param domain [String] The normalized domain that was crawled
       #
       #   @param meta [ContextDev::Models::WebWebScrapeSitemapResponse::Meta] Metadata about the sitemap crawl operation
@@ -36,6 +46,8 @@ module ContextDev
       #   @param success [Boolean, ContextDev::Models::WebWebScrapeSitemapResponse::Success] Indicates success
       #
       #   @param urls [Array<String>] Array of discovered page URLs from the sitemap (max 500)
+      #
+      #   @param key_metadata [ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
 
       # @see ContextDev::Models::WebWebScrapeSitemapResponse#meta
       class Meta < ContextDev::Internal::Type::BaseModel
@@ -86,6 +98,29 @@ module ContextDev
         # @!method self.values
         #   @return [Array<Boolean>]
       end
+
+      # @see ContextDev::Models::WebWebScrapeSitemapResponse#key_metadata
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute credits_consumed
+        #   The number of credits consumed by this request.
+        #
+        #   @return [Integer]
+        required :credits_consumed, Integer
+
+        # @!attribute credits_remaining
+        #   The number of credits remaining for your organization after this request.
+        #
+        #   @return [Integer]
+        required :credits_remaining, Integer
+
+        # @!method initialize(credits_consumed:, 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.
+        #
+        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #
+        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+      end
     end
   end
 end

data/lib/context_dev/resources/web.rb

@@ -9,7 +9,7 @@ module ContextDev
       # Crawl a website, use the provided JSON Schema and instructions to prioritize
       # relevant internal links, and extract structured data from the selected pages.
       #
-      # @overload extract(schema:, url:, fact_check: nil, follow_subdomains: nil, include_frames: nil, instructions: nil, max_age_ms: nil, pdf: nil, stop_after_ms: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {})
+      # @overload extract(schema:, url:, fact_check: nil, follow_subdomains: nil, include_frames: nil, instructions: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, stop_after_ms: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {})
       #
       # @param schema [Hash{Symbol=>Object}] JSON Schema for the returned data object. TypeScript Zod users can pass a JSON S
       #
@@ -25,6 +25,10 @@ module ContextDev
       #
       # @param max_age_ms [Integer] Return cached scrape results if a prior scrape for the same parameters is younge
       #
+      # @param max_depth [Integer] Optional maximum link depth from the starting URL (0 = only the starting page).
+      #
+      # @param max_pages [Integer] Maximum number of pages to analyze for extraction. Hard cap: 50. Defaults to 5.
+      #
       # @param pdf [ContextDev::Models::WebExtractParams::Pdf]
       #
       # @param stop_after_ms [Integer] Soft time budget for the crawl in milliseconds. Min: 10000 (10s). Max: 110000 (1

data/lib/context_dev/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ContextDev
-  VERSION = "1.31.0"
+  VERSION = "1.32.0"
 end

data/rbi/context_dev/models/ai_ai_query_response.rbi

@@ -38,6 +38,21 @@ module ContextDev
       sig { params(domain: String).void }
       attr_writer :domain
 
+      # 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::AIAIQueryResponse::KeyMetadata))
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::AIAIQueryResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       # Status of the response, e.g., 'ok'
       sig { returns(T.nilable(String)) }
       attr_reader :status
@@ -59,6 +74,8 @@ module ContextDev
               ContextDev::Models::AIAIQueryResponse::DataExtracted::OrHash
             ],
           domain: String,
+          key_metadata:
+            ContextDev::Models::AIAIQueryResponse::KeyMetadata::OrHash,
           status: String,
           urls_analyzed: T::Array[String]
         ).returns(T.attached_class)
@@ -68,6 +85,9 @@ module ContextDev
         data_extracted: nil,
         # The domain that was analyzed
         domain: nil,
+        # 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,
         # Status of the response, e.g., 'ok'
         status: nil,
         # List of URLs that were analyzed
@@ -81,6 +101,7 @@ module ContextDev
             data_extracted:
               T::Array[ContextDev::Models::AIAIQueryResponse::DataExtracted],
             domain: String,
+            key_metadata: ContextDev::Models::AIAIQueryResponse::KeyMetadata,
             status: String,
             urls_analyzed: T::Array[String]
           }
@@ -200,6 +221,47 @@ module ContextDev
             )
         end
       end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::AIAIQueryResponse::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/ai_extract_product_response.rbi

@@ -18,6 +18,23 @@ module ContextDev
       sig { params(is_product_page: T::Boolean).void }
       attr_writer :is_product_page
 
+      # 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::AIExtractProductResponse::KeyMetadata)
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::AIExtractProductResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       # The detected ecommerce platform, or null if not a product page
       sig do
         returns(
@@ -49,6 +66,8 @@ module ContextDev
       sig do
         params(
           is_product_page: T::Boolean,
+          key_metadata:
+            ContextDev::Models::AIExtractProductResponse::KeyMetadata::OrHash,
           platform:
             T.nilable(
               ContextDev::Models::AIExtractProductResponse::Platform::OrSymbol
@@ -62,6 +81,9 @@ module ContextDev
       def self.new(
         # Whether the given URL is a product detail page
         is_product_page: nil,
+        # 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,
         # The detected ecommerce platform, or null if not a product page
         platform: nil,
         # The extracted product data, or null if not a product page
@@ -73,6 +95,8 @@ module ContextDev
         override.returns(
           {
             is_product_page: T::Boolean,
+            key_metadata:
+              ContextDev::Models::AIExtractProductResponse::KeyMetadata,
             platform:
               T.nilable(
                 ContextDev::Models::AIExtractProductResponse::Platform::TaggedSymbol
@@ -85,6 +109,47 @@ module ContextDev
       def to_hash
       end
 
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::AIExtractProductResponse::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
+
       # The detected ecommerce platform, or null if not a product page
       module Platform
         extend ContextDev::Internal::Type::Enum

data/rbi/context_dev/models/ai_extract_products_response.rbi

@@ -11,6 +11,23 @@ module ContextDev
           )
         end
 
+      # 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::AIExtractProductsResponse::KeyMetadata)
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::AIExtractProductsResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
       # Array of products extracted from the website
       sig do
         returns(
@@ -33,6 +50,8 @@ module ContextDev
 
       sig do
         params(
+          key_metadata:
+            ContextDev::Models::AIExtractProductsResponse::KeyMetadata::OrHash,
           products:
             T::Array[
               ContextDev::Models::AIExtractProductsResponse::Product::OrHash
@@ -40,6 +59,9 @@ module ContextDev
         ).returns(T.attached_class)
       end
       def self.new(
+        # 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,
         # Array of products extracted from the website
         products: nil
       )
@@ -48,6 +70,8 @@ module ContextDev
       sig do
         override.returns(
           {
+            key_metadata:
+              ContextDev::Models::AIExtractProductsResponse::KeyMetadata,
             products:
               T::Array[ContextDev::Models::AIExtractProductsResponse::Product]
           }
@@ -56,6 +80,47 @@ module ContextDev
       def to_hash
       end
 
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::AIExtractProductsResponse::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
+
       class Product < ContextDev::Internal::Type::BaseModel
         OrHash =
           T.type_alias do