context.dev 2.4.0 → 2.5.0

data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi

@@ -35,6 +35,23 @@ module ContextDev
       sig { params(max_links: Integer).void }
       attr_writer :max_links
 
+      # Optional explicit sitemap URL. When provided, exactly this sitemap is crawled
+      # instead of discovering the domain's sitemaps.
+      sig { returns(T.nilable(String)) }
+      attr_reader :sitemap_url
+
+      sig { params(sitemap_url: String).void }
+      attr_writer :sitemap_url
+
+      # Optional comma-separated caller-defined tags for tracking this request. Tags are
+      # recorded on the request's usage log and can be used to filter usage on the
+      # dashboard usage page. Up to 20 tags, each 1-50 characters.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :tags
+
+      sig { params(tags: T::Array[String]).void }
+      attr_writer :tags
+
       # Optional timeout in milliseconds for the request. If the request takes longer
       # than this value, it will be aborted with a 408 status code. Maximum allowed
       # value is 300000ms (5 minutes).
@@ -52,13 +69,30 @@ module ContextDev
       sig { params(url_regex: String).void }
       attr_writer :url_regex
 
+      # Set to enabled to bypass shared caches and omit request and response content
+      # from retained usage logs. Requires zero data retention to be enabled for your
+      # organization (contact support@context.dev), otherwise the request fails with
+      # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
+      sig do
+        returns(T.nilable(ContextDev::WebWebScrapeSitemapParams::Zdr::OrSymbol))
+      end
+      attr_reader :zdr
+
+      sig do
+        params(zdr: ContextDev::WebWebScrapeSitemapParams::Zdr::OrSymbol).void
+      end
+      attr_writer :zdr
+
       sig do
         params(
           domain: String,
           headers: T::Hash[Symbol, String],
           max_links: Integer,
+          sitemap_url: String,
+          tags: T::Array[String],
           timeout_ms: Integer,
           url_regex: String,
+          zdr: ContextDev::WebWebScrapeSitemapParams::Zdr::OrSymbol,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -72,6 +106,13 @@ module ContextDev
         # Maximum number of links to return from the sitemap crawl. Defaults to 10,000.
         # Minimum is 1, maximum is 100,000.
         max_links: nil,
+        # Optional explicit sitemap URL. When provided, exactly this sitemap is crawled
+        # instead of discovering the domain's sitemaps.
+        sitemap_url: nil,
+        # Optional comma-separated caller-defined tags for tracking this request. Tags are
+        # recorded on the request's usage log and can be used to filter usage on the
+        # dashboard usage page. Up to 20 tags, each 1-50 characters.
+        tags: nil,
         # Optional timeout in milliseconds for the request. If the request takes longer
         # than this value, it will be aborted with a 408 status code. Maximum allowed
         # value is 300000ms (5 minutes).
@@ -79,6 +120,11 @@ module ContextDev
         # Optional RE2-compatible regex pattern. Only URLs matching this pattern are
         # returned and counted against maxLinks.
         url_regex: 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
+        # organization (contact support@context.dev), otherwise the request fails with
+        # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
+        zdr: nil,
         request_options: {}
       )
       end
@@ -89,14 +135,50 @@ module ContextDev
             domain: String,
             headers: T::Hash[Symbol, String],
             max_links: Integer,
+            sitemap_url: String,
+            tags: T::Array[String],
             timeout_ms: Integer,
             url_regex: String,
+            zdr: ContextDev::WebWebScrapeSitemapParams::Zdr::OrSymbol,
             request_options: ContextDev::RequestOptions
           }
         )
       end
       def to_hash
       end
+
+      # Set to enabled to bypass shared caches and omit request and response content
+      # from retained usage logs. Requires zero data retention to be enabled for your
+      # organization (contact support@context.dev), otherwise the request fails with
+      # ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
+      module Zdr
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ContextDev::WebWebScrapeSitemapParams::Zdr)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ENABLED =
+          T.let(
+            :enabled,
+            ContextDev::WebWebScrapeSitemapParams::Zdr::TaggedSymbol
+          )
+        DISABLED =
+          T.let(
+            :disabled,
+            ContextDev::WebWebScrapeSitemapParams::Zdr::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[ContextDev::WebWebScrapeSitemapParams::Zdr::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/context_dev/models.rbi

@@ -18,6 +18,10 @@ module ContextDev
 
   MonitorDeleteParams = ContextDev::Models::MonitorDeleteParams
 
+  MonitorGetCreditUsageParams = ContextDev::Models::MonitorGetCreditUsageParams
+
+  MonitorGetLimitsParams = ContextDev::Models::MonitorGetLimitsParams
+
   MonitorListAccountChangesParams =
     ContextDev::Models::MonitorListAccountChangesParams
 

data/rbi/context_dev/resources/ai.rbi

@@ -9,6 +9,7 @@ module ContextDev
         params(
           url: String,
           max_age_ms: Integer,
+          tags: T::Array[String],
           timeout_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(ContextDev::Models::AIExtractProductResponse)
@@ -20,6 +21,8 @@ module ContextDev
         # younger than this many milliseconds. Defaults to 7 days (604800000 ms) when
         # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
         max_age_ms: nil,
+        # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+        tags: nil,
         # Optional timeout in milliseconds for the request. If the request takes longer
         # than this value, it will be aborted with a 408 status code. Maximum allowed
         # value is 300000ms (5 minutes).

data/rbi/context_dev/resources/brand.rbi

@@ -35,7 +35,9 @@ module ContextDev
       sig do
         params(
           domain: String,
-          max_age_ms: Integer,
+          max_age_ms: T.nilable(Integer),
+          tags: T::Array[String],
+          theme: ContextDev::BrandRetrieveSimplifiedParams::Theme::OrSymbol,
           timeout_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(ContextDev::Models::BrandRetrieveSimplifiedResponse)
@@ -48,6 +50,12 @@ module ContextDev
         # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
         # year.
         max_age_ms: nil,
+        # Optional comma-separated caller-defined tags for tracking this request. Tags are
+        # recorded on the request's usage log and can be used to filter usage on the
+        # dashboard usage page. Up to 20 tags, each 1-50 characters.
+        tags: nil,
+        # Optional theme preference used when selecting brand assets.
+        theme: nil,
         # Optional timeout in milliseconds for the request. If the request takes longer
         # than this value, it will be aborted with a 408 status code. Maximum allowed
         # value is 300000ms (5 minutes).

data/rbi/context_dev/resources/industry.rbi

@@ -9,6 +9,7 @@ module ContextDev
           input: String,
           max_results: Integer,
           min_results: Integer,
+          tags: T::Array[String],
           timeout_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(ContextDev::Models::IndustryRetrieveNaicsResponse)
@@ -23,6 +24,10 @@ module ContextDev
         max_results: nil,
         # Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
         min_results: nil,
+        # Optional comma-separated caller-defined tags for tracking this request. Tags are
+        # recorded on the request's usage log and can be used to filter usage on the
+        # dashboard usage page. Up to 20 tags, each 1-50 characters.
+        tags: nil,
         # Optional timeout in milliseconds for the request. If the request takes longer
         # than this value, it will be aborted with a 408 status code. Maximum allowed
         # value is 300000ms (5 minutes).
@@ -39,6 +44,7 @@ module ContextDev
           input: String,
           max_results: Integer,
           min_results: Integer,
+          tags: T::Array[String],
           timeout_ms: Integer,
           type: ContextDev::IndustryRetrieveSicParams::Type::OrSymbol,
           request_options: ContextDev::RequestOptions::OrHash
@@ -53,6 +59,10 @@ module ContextDev
         max_results: nil,
         # Minimum number of SIC codes to return. Must be at least 1. Defaults to 1.
         min_results: nil,
+        # Optional comma-separated caller-defined tags for tracking this request. Tags are
+        # recorded on the request's usage log and can be used to filter usage on the
+        # dashboard usage page. Up to 20 tags, each 1-50 characters.
+        tags: nil,
         # Optional timeout in milliseconds for the request. If the request takes longer
         # than this value, it will be aborted with a 408 status code. Maximum allowed
         # value is 300000ms (5 minutes).

data/rbi/context_dev/resources/monitors.rbi

@@ -45,6 +45,7 @@ module ContextDev
         # described by `target` and `change_detection`.
         mode: nil,
         # User-defined tags for grouping and filtering monitors and their changes.
+        # Duplicates are removed.
         tags: nil,
         webhook: nil,
         request_options: {}
@@ -97,6 +98,7 @@ module ContextDev
         schedule: nil,
         status: nil,
         # User-defined tags for grouping and filtering monitors and their changes.
+        # Duplicates are removed.
         tags: nil,
         # Discriminated union describing what the monitor watches.
         target: nil,
@@ -117,18 +119,23 @@ module ContextDev
           limit: Integer,
           q: String,
           search_by:
-            T::Array[ContextDev::MonitorListParams::SearchBy::OrSymbol],
+            T.nilable(
+              T::Array[ContextDev::MonitorListParams::SearchBy::OrSymbol]
+            ),
           search_type: ContextDev::MonitorListParams::SearchType::OrSymbol,
           status: ContextDev::MonitorListParams::Status::OrSymbol,
           tag: String,
-          tags: T::Array[String],
+          tags: T.nilable(T::Array[String]),
           target_type: ContextDev::MonitorListParams::TargetType::OrSymbol,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(ContextDev::Models::MonitorListResponse)
       end
       def list(
+        # Filter by change detection type.
         change_detection_type: nil,
+        # Opaque pagination cursor from a previous response.
         cursor: nil,
+        # Maximum number of items to return per page (1-100). Defaults to 25.
         limit: nil,
         # Free-text search term, matched against the fields named in `search_by`.
         q: nil,
@@ -138,16 +145,13 @@ module ContextDev
         # `prefix` for as-you-type prefix matching (default), `exact` for full-token
         # matching.
         search_type: nil,
-        # Monitor lifecycle status. `failed` means the most recent run failed (see the
-        # monitor's `last_error`); failed monitors keep running on schedule and flip back
-        # to `active` on the next successful run. Monitors are auto-`paused` after
-        # repeated consecutive failures or insufficient-credit skips; resume by PATCHing
-        # status to `active`.
+        # Filter monitors by lifecycle status.
         status: nil,
         # Filter to items that have this tag.
         tag: nil,
         # Comma-separated list of tags to filter by (matches monitors having any of them).
         tags: nil,
+        # Filter by target type.
         target_type: nil,
         request_options: {}
       )
@@ -163,6 +167,33 @@ module ContextDev
       def delete(monitor_id, request_options: {})
       end
 
+      # Returns credits charged per monitor over an optional [since, until] window,
+      # newest spenders first.
+      sig do
+        params(
+          since: Time,
+          until_: Time,
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(ContextDev::Models::MonitorGetCreditUsageResponse)
+      end
+      def get_credit_usage(
+        # Only include items at or after this ISO 8601 timestamp.
+        since: nil,
+        # Only include items before this ISO 8601 timestamp.
+        until_: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns how many monitors the account has and the maximum it allows.
+      sig do
+        params(request_options: ContextDev::RequestOptions::OrHash).returns(
+          ContextDev::Models::MonitorGetLimitsResponse
+        )
+      end
+      def get_limits(request_options: {})
+      end
+
       # Returns an account-wide feed of detected changes across monitors.
       sig do
         params(
@@ -180,14 +211,21 @@ module ContextDev
         ).returns(ContextDev::Models::MonitorListAccountChangesResponse)
       end
       def list_account_changes(
+        # Filter by change detection type.
         change_detection_type: nil,
+        # Opaque pagination cursor from a previous response.
         cursor: nil,
+        # Maximum number of items to return per page (1-100). Defaults to 25.
         limit: nil,
+        # Filter changes to a single monitor.
         monitor_id: nil,
+        # Only include items at or after this ISO 8601 timestamp.
         since: nil,
         # Filter to items that have this tag.
         tag: nil,
+        # Filter by target type.
         target_type: nil,
+        # Only include items before this ISO 8601 timestamp.
         until_: nil,
         request_options: {}
       )
@@ -203,10 +241,11 @@ module ContextDev
         ).returns(ContextDev::Models::MonitorListAccountRunsResponse)
       end
       def list_account_runs(
+        # Opaque pagination cursor from a previous response.
         cursor: nil,
+        # Maximum number of items to return per page (1-100). Defaults to 25.
         limit: nil,
-        # Lifecycle status of a run. `skipped` runs never executed — see `skip_reason`
-        # (insufficient credits, monitor paused, or superseded by a concurrent run).
+        # Filter runs by lifecycle status.
         status: nil,
         request_options: {}
       )
@@ -226,11 +265,15 @@ module ContextDev
       end
       def list_changes(
         monitor_id,
+        # Opaque pagination cursor from a previous response.
         cursor: nil,
+        # Maximum number of items to return per page (1-100). Defaults to 25.
         limit: nil,
+        # Only include items at or after this ISO 8601 timestamp.
         since: nil,
         # Filter to items that have this tag.
         tag: nil,
+        # Only include items before this ISO 8601 timestamp.
         until_: nil,
         request_options: {}
       )
@@ -248,10 +291,11 @@ module ContextDev
       end
       def list_runs(
         monitor_id,
+        # Opaque pagination cursor from a previous response.
         cursor: nil,
+        # Maximum number of items to return per page (1-100). Defaults to 25.
         limit: nil,
-        # Lifecycle status of a run. `skipped` runs never executed — see `skip_reason`
-        # (insufficient credits, monitor paused, or superseded by a concurrent run).
+        # Filter runs by lifecycle status.
         status: nil,
         request_options: {}
       )

data/rbi/context_dev/resources/parse.rbi

@@ -4,47 +4,74 @@ module ContextDev
   module Resources
     class Parse
       # Converts raw text, source code, web/data, PDF, Microsoft Office, and image bytes
-      # into LLM-usable Markdown. The base request costs 1 credit. When OCR runs
-      # (requires ocr=true), the entire call costs 5 credits; ocr=true requests where no
-      # OCR ends up running still cost 1 credit.
+      # into LLM-usable Markdown.
       sig do
         params(
           body: ContextDev::Internal::FileInput,
+          client: String,
           extension: ContextDev::ParseHandleParams::Extension::OrSymbol,
-          include_images: T::Boolean,
-          include_links: T::Boolean,
-          ocr: T::Boolean,
+          include_images:
+            T.any(
+              T::Boolean,
+              ContextDev::ParseHandleParams::IncludeImages::OrSymbol
+            ),
+          include_links:
+            T.any(
+              T::Boolean,
+              ContextDev::ParseHandleParams::IncludeLinks::OrSymbol
+            ),
+          ocr: T.any(T::Boolean, ContextDev::ParseHandleParams::Ocr::OrSymbol),
           pdf: ContextDev::ParseHandleParams::Pdf::OrHash,
-          shorten_base64_images: T::Boolean,
-          use_main_content_only: T::Boolean,
+          shorten_base64_images:
+            T.any(
+              T::Boolean,
+              ContextDev::ParseHandleParams::ShortenBase64Images::OrSymbol
+            ),
+          tags: T::Array[String],
+          use_main_content_only:
+            T.any(
+              T::Boolean,
+              ContextDev::ParseHandleParams::UseMainContentOnly::OrSymbol
+            ),
+          zdr: ContextDev::ParseHandleParams::Zdr::OrSymbol,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(ContextDev::Models::ParseHandleResponse)
       end
       def handle(
         # Body param
         body:,
-        # Query param: Optional file extension hint. Case-insensitive; a leading dot is
-        # accepted (e.g. ".pdf").
+        # Query param: Optional client identifier used for usage attribution.
+        client: nil,
+        # Query param: Optional file extension hint, such as pdf, docx, xlsx, pptx, html,
+        # json, csv, md, py, rtf, jpg, png, or txt.
         extension: nil,
         # Query param: Include image references in Markdown output
         include_images: nil,
         # Query param: Preserve hyperlinks in Markdown output
         include_links: nil,
-        # Query param: Gates all OCR. When true, PDFs get embedded-image OCR (recognized
-        # text inserted at each image's position in page reading order, preserving the
-        # text layer; pdf.start/pdf.end limit the page range), scanned PDFs with no text
-        # layer get full-document OCR, and raster images get their visible text
-        # transcribed. When false, no OCR runs: scanned PDFs may yield no content and
-        # images return only format/dimension metadata. Calls where OCR actually runs cost
-        # 5 credits instead of 1.
+        # Query param: When true for PDF inputs, detect and OCR images embedded in the
+        # selected pages, inserting recognized text at each image's position in page
+        # reading order while preserving the PDF text layer. pdf.start/pdf.end limit the
+        # inclusive page range. When false, all OCR is disabled, including the automatic
+        # scanned-PDF fallback.
         ocr: nil,
-        # Query param: PDF page-range controls. Use start/end to limit parsing (and OCR
-        # when ocr=true) to an inclusive 1-based page range.
+        # Query param: PDF page-range options as a JSON object, e.g. {"start": 2, "end":
+        # 5}.
         pdf: nil,
         # Query param: Shorten base64-encoded image data in the Markdown output
         shorten_base64_images: nil,
+        # Query param: Optional comma-separated caller-defined tags for tracking this
+        # request. Tags are recorded on the request's usage log and can be used to filter
+        # usage on the dashboard usage page. Up to 20 tags, each 1-50 characters.
+        tags: nil,
         # Query param: Extract only the main content from HTML-like inputs
         use_main_content_only: nil,
+        # Query param: Set to enabled to bypass shared caches and omit request and
+        # response content from retained usage logs. Requires zero data retention to be
+        # enabled for your organization (contact support@context.dev), otherwise the
+        # request fails with ZDR_NOT_ENABLED. Successful ZDR responses include
+        # X-Context-ZDR: true.
+        zdr: nil,
         request_options: {}
       )
       end

data/rbi/context_dev/resources/utility.rbi

@@ -15,6 +15,7 @@ module ContextDev
               ContextDev::UtilityPrefetchParams::Identifier::UtilityPrefetchEmailIdentifier::OrHash
             ),
           type: ContextDev::UtilityPrefetchParams::Type::OrSymbol,
+          tags: T::Array[String],
           timeout_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(ContextDev::Models::UtilityPrefetchResponse)
@@ -24,6 +25,8 @@ module ContextDev
         identifier:,
         # What to prefetch. Currently only 'brand' is supported.
         type:,
+        # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+        tags: nil,
         # Optional timeout in milliseconds for the request. If the request takes longer
         # than this value, it will be aborted with a 408 status code. Maximum allowed
         # value is 300000ms (5 minutes).