context.dev 2.8.0 → 2.9.0

data/lib/context_dev/models/web_web_scrape_md_params.rb

@@ -534,16 +534,17 @@ module ContextDev
         optional :end_, Integer, api_name: :end
 
         # @!attribute ocr
-        #   When true, detect and OCR images embedded in the selected PDF pages, inserting
-        #   recognized text at each image's position in page reading order while preserving
-        #   the PDF text layer. This is separate from automatic scanned-PDF OCR fallback.
+        #   When true, OCR the selected PDF pages that have no usable text layer (scans),
+        #   replacing each recovered page's text with the OCR result while pages with a real
+        #   text layer keep it. Billed at 1 credit per page OCR actually recovered, on top
+        #   of the base request cost. When false, no OCR runs.
         #
         #   @return [Boolean, Symbol, ContextDev::Models::WebWebScrapeMdParams::Pdf::Ocr, nil]
         optional :ocr, union: -> { ContextDev::WebWebScrapeMdParams::Pdf::Ocr }
 
         # @!attribute should_parse
         #   When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and
-        #   a 400 WEBSITE_ACCESS_ERROR is returned.
+        #   a 400 PDF_SKIPPED is returned.
         #
         #   @return [Boolean, Symbol, ContextDev::Models::WebWebScrapeMdParams::Pdf::ShouldParse, nil]
         optional :should_parse,
@@ -565,15 +566,16 @@ module ContextDev
         #
         #   @param end_ [Integer] Last 1-based PDF page to parse. When omitted, parsing ends at the last page. Mus
         #
-        #   @param ocr [Boolean, Symbol, ContextDev::Models::WebWebScrapeMdParams::Pdf::Ocr] When true, detect and OCR images embedded in the selected PDF pages, inserting r
+        #   @param ocr [Boolean, Symbol, ContextDev::Models::WebWebScrapeMdParams::Pdf::Ocr] When true, OCR the selected PDF pages that have no usable text layer (scans), re
         #
         #   @param should_parse [Boolean, Symbol, ContextDev::Models::WebWebScrapeMdParams::Pdf::ShouldParse] When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and
         #
         #   @param start [Integer] First 1-based PDF page to parse. When omitted, parsing starts at the first page.
 
-        # When true, detect and OCR images embedded in the selected PDF pages, inserting
-        # recognized text at each image's position in page reading order while preserving
-        # the PDF text layer. This is separate from automatic scanned-PDF OCR fallback.
+        # When true, OCR the selected PDF pages that have no usable text layer (scans),
+        # replacing each recovered page's text with the OCR result while pages with a real
+        # text layer keep it. Billed at 1 credit per page OCR actually recovered, on top
+        # of the base request cost. When false, no OCR runs.
         #
         # @see ContextDev::Models::WebWebScrapeMdParams::Pdf#ocr
         module Ocr
@@ -601,7 +603,7 @@ module ContextDev
         end
 
         # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and
-        # a 400 WEBSITE_ACCESS_ERROR is returned.
+        # a 400 PDF_SKIPPED is returned.
         #
         # @see ContextDev::Models::WebWebScrapeMdParams::Pdf#should_parse
         module ShouldParse

data/lib/context_dev/models/web_web_scrape_sitemap_params.rb

@@ -28,6 +28,14 @@ module ContextDev
       #   @return [Integer, nil]
       optional :max_links, Integer
 
+      # @!attribute search
+      #   Optional search phrase. When provided, the crawled sitemap is filtered to the
+      #   pages whose URLs are about that phrase, most relevant first, and the request
+      #   costs 2 credits instead of 1.
+      #
+      #   @return [String, nil]
+      optional :search, String
+
       # @!attribute sitemap_url
       #   Optional explicit sitemap URL. When provided, exactly this sitemap is crawled
       #   instead of discovering the domain's sitemaps.
@@ -67,7 +75,7 @@ module ContextDev
       #   @return [Symbol, ContextDev::Models::WebWebScrapeSitemapParams::Zdr, nil]
       optional :zdr, enum: -> { ContextDev::WebWebScrapeSitemapParams::Zdr }
 
-      # @!method initialize(domain:, headers: nil, max_links: nil, sitemap_url: nil, tags: nil, timeout_ms: nil, url_regex: nil, zdr: nil, request_options: {})
+      # @!method initialize(domain:, headers: nil, max_links: nil, search: nil, sitemap_url: nil, tags: nil, timeout_ms: nil, url_regex: nil, zdr: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebWebScrapeSitemapParams} for more details.
       #
@@ -77,6 +85,8 @@ module ContextDev
       #
       #   @param max_links [Integer] Maximum number of links to return from the sitemap crawl. Defaults to 10,000. Mi
       #
+      #   @param search [String] Optional search phrase. When provided, the crawled sitemap is filtered to the pa
+      #
       #   @param sitemap_url [String] Optional explicit sitemap URL. When provided, exactly this sitemap is crawled in
       #
       #   @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are

data/lib/context_dev/models/web_web_scrape_sitemap_response.rb

@@ -23,7 +23,8 @@ module ContextDev
       required :success, enum: -> { ContextDev::Models::WebWebScrapeSitemapResponse::Success }
 
       # @!attribute urls
-      #   Array of discovered page URLs from the sitemap (max 500)
+      #   Discovered page URLs from the sitemap, up to `maxLinks`. When `search` is set
+      #   these are only the matching pages, most relevant first.
       #
       #   @return [Array<String>]
       required :urls, ContextDev::Internal::Type::ArrayOf[String]
@@ -45,7 +46,7 @@ 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 urls [Array<String>] Discovered page URLs from the sitemap, up to `maxLinks`. When `search` is set th
       #
       #   @param key_metadata [ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
 

data/lib/context_dev/models.rb

@@ -45,6 +45,8 @@ module ContextDev
 
   BatchCancelParams = ContextDev::Models::BatchCancelParams
 
+  BatchDeleteParams = ContextDev::Models::BatchDeleteParams
+
   BatchGetResultsParams = ContextDev::Models::BatchGetResultsParams
 
   BatchListParams = ContextDev::Models::BatchListParams
@@ -99,6 +101,8 @@ module ContextDev
 
   ParseHandleParams = ContextDev::Models::ParseHandleParams
 
+  PersonEnrichParams = ContextDev::Models::PersonEnrichParams
+
   UtilityPrefetchParams = ContextDev::Models::UtilityPrefetchParams
 
   WebExtractCompetitorsParams = ContextDev::Models::WebExtractCompetitorsParams

data/lib/context_dev/resources/batch.rb

@@ -2,6 +2,7 @@
 
 module ContextDev
   module Resources
+    # Scrape many pages or crawl a site asynchronously.
     class Batch
       # Check progress, and get download links once the batch finishes.
       #
@@ -60,6 +61,27 @@ module ContextDev
         )
       end
 
+      # Permanently delete a finished batch and its stored results. Active batches must
+      # settle first.
+      #
+      # @overload delete(batch_id, request_options: {})
+      #
+      # @param batch_id [String] ID of the batch to retrieve or cancel.
+      #
+      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ContextDev::Models::BatchDeleteResponse]
+      #
+      # @see ContextDev::Models::BatchDeleteParams
+      def delete(batch_id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["batch/%1$s", batch_id],
+          model: ContextDev::Models::BatchDeleteResponse,
+          options: params[:request_options]
+        )
+      end
+
       # Stop a batch from starting new pages. In-progress pages finish, and unused
       # credits are refunded.
       #
@@ -115,15 +137,17 @@ module ContextDev
       # Some parameter documentations has been truncated, see
       # {ContextDev::Models::BatchSubmitParams} for more details.
       #
-      # Retrieve and normalize a person profile from identifiers.
+      # Scrape 25K URLs or crawl large websites asynchronously.
+      #
+      # @overload submit(input:, tags: nil, webhook_url: nil, idempotency_key: nil, request_options: {})
       #
-      # @overload submit(identifiers:, tags: nil, timeout_ms: nil, request_options: {})
+      # @param input [ContextDev::Models::BatchSubmitParams::Input::Scrape, ContextDev::Models::BatchSubmitParams::Input::Crawl] Body param: Choose a URL list or a site crawl.
       #
-      # @param identifiers [ContextDev::Models::BatchSubmitParams::Identifiers] Known identifiers for the person. At least one identifier is required.
+      # @param tags [Array<String>] Body param: Tags stored on the batch. Filter the batch list by them later.
       #
-      # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      # @param webhook_url [String] Body param: URL notified when the batch finishes.
       #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      # @param idempotency_key [String] Header param: Any string unique to this submission. Retries with the same key re
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -132,10 +156,12 @@ module ContextDev
       # @see ContextDev::Models::BatchSubmitParams
       def submit(params)
         parsed, options = ContextDev::BatchSubmitParams.dump_request(params)
+        header_params = {idempotency_key: "idempotency-key"}
         @client.request(
           method: :post,
-          path: "people/retrieve",
-          body: parsed,
+          path: "batch/submit",
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
           model: ContextDev::Models::BatchSubmitResponse,
           options: options
         )

data/lib/context_dev/resources/brand.rb

@@ -69,7 +69,8 @@ module ContextDev
       # {ContextDev::Models::BrandSearchParams} for more details.
       #
       # Search brands by name or domain and get back up to 10 lightweight matches
-      # (domain, name, logo), most popular first: by Tranco rank, then market cap for
+      # (domain, name, logo). Name matches rank ahead of domain matches; within each
+      # group the most popular brands come first: by Tranco rank, then market cap for
       # brands outside the Tranco list, with text relevance breaking ties. Matching is
       # prefix-based with no typo tolerance, so it is suited to autocomplete. Only
       # brands already in the Context.dev index are returned — use /brand/retrieve to

data/lib/context_dev/resources/parse.rb

@@ -21,7 +21,7 @@ module ContextDev
       #
       # @param include_links [Boolean, Symbol, ContextDev::Models::ParseHandleParams::IncludeLinks] Query param: Preserve hyperlinks in Markdown output
       #
-      # @param ocr [Boolean, Symbol, ContextDev::Models::ParseHandleParams::Ocr] Query param: When true for PDF inputs, detect and OCR images embedded in the sel
+      # @param ocr [Boolean, Symbol, ContextDev::Models::ParseHandleParams::Ocr] Query param: When true for PDF inputs, OCR the selected pages that have no usabl
       #
       # @param pdf [ContextDev::Models::ParseHandleParams::Pdf] Query param: PDF page-range options as a JSON object, e.g. {"start": 2, "end": 5
       #

data/lib/context_dev/resources/people.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Resources
+    class People
+      # Some parameter documentations has been truncated, see
+      # {ContextDev::Models::PersonEnrichParams} for more details.
+      #
+      # Finds and normalizes the best available person candidate from additive identity
+      # clues, then assigns an identity match score from 0 to 100. Available on all paid
+      # plans. Successful requests cost 20 credits. Disposable and free email addresses
+      # (like gmail.com, yahoo.com) will throw a 422 error.
+      #
+      # @overload enrich(company: nil, education: nil, email: nil, location: nil, name: nil, social_urls: nil, tags: nil, timeout_ms: nil, request_options: {})
+      #
+      # @param company [ContextDev::Models::PersonEnrichParams::Company]
+      #
+      # @param education [Array<ContextDev::Models::PersonEnrichParams::Education>]
+      #
+      # @param email [String]
+      #
+      # @param location [ContextDev::Models::PersonEnrichParams::Location]
+      #
+      # @param name [ContextDev::Models::PersonEnrichParams::Name]
+      #
+      # @param social_urls [Array<String>]
+      #
+      # @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      #
+      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #
+      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [ContextDev::Models::PersonEnrichResponse]
+      #
+      # @see ContextDev::Models::PersonEnrichParams
+      def enrich(params = {})
+        parsed, options = ContextDev::PersonEnrichParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "people/enrich",
+          body: parsed,
+          model: ContextDev::Models::PersonEnrichResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [ContextDev::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/context_dev/resources/web.rb

@@ -462,6 +462,18 @@ module ContextDev
       # responses from a recognized API key; use error_code to distinguish stable
       # failure categories.
       #
+      # ### YouTube
+      #
+      # YouTube URLs return the video or channel itself rather than the surrounding
+      # player and navigation chrome. A URL addressing a single video (`/watch`,
+      # `youtu.be`, `/shorts`, `/embed`, `/live`) returns its title, channel, duration,
+      # view count, keywords, full description, and the transcript when the video has
+      # captions that can be retrieved; videos without captions return everything except
+      # the transcript. A channel URL (`/channel/UC…`, `/@handle`, `/c/…`, `/user/…`)
+      # returns its name, handle, subscriber count, video count, and full description.
+      # When `includeImages=true`, video responses also include the thumbnail and
+      # channel responses include the avatar. Costs the same as any other scrape.
+      #
       # ### Billing & errors
       #
       # | HTTP status | Billed?                                   | Meaning                                                                                  |
@@ -471,6 +483,7 @@ module ContextDev
       # | 401 / 403   | No                                        | Invalid/disabled key, insufficient permissions, or credits exhausted; inspect error_code |
       # | 404         | No                                        | Target page returned or fingerprinted as not found                                       |
       # | 408         | No                                        | Request timed out                                                                        |
+      # | 413         | No                                        | Target content exceeds the maximum supported size (20 MB)                                |
       # | 415         | No                                        | Unsupported content type                                                                 |
       # | 429         | No                                        | Per-minute rate limit exceeded; honor Retry-After                                        |
       # | 500         | No                                        | Internal error                                                                           |
@@ -545,9 +558,13 @@ module ContextDev
       # Some parameter documentations has been truncated, see
       # {ContextDev::Models::WebWebScrapeSitemapParams} for more details.
       #
-      # Crawl an entire website's sitemap and return all discovered page URLs.
+      # 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.
       #
-      # @overload web_scrape_sitemap(domain:, headers: nil, max_links: nil, sitemap_url: nil, tags: nil, timeout_ms: nil, url_regex: nil, zdr: nil, request_options: {})
+      # @overload web_scrape_sitemap(domain:, headers: nil, max_links: nil, search: nil, sitemap_url: nil, tags: nil, timeout_ms: nil, url_regex: nil, zdr: nil, request_options: {})
       #
       # @param domain [String] Domain to build a sitemap for
       #
@@ -555,6 +572,8 @@ module ContextDev
       #
       # @param max_links [Integer] Maximum number of links to return from the sitemap crawl. Defaults to 10,000. Mi
       #
+      # @param search [String] Optional search phrase. When provided, the crawled sitemap is filtered to the pa
+      #
       # @param sitemap_url [String] Optional explicit sitemap URL. When provided, exactly this sitemap is crawled in
       #
       # @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are

data/lib/context_dev/version.rb

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

data/lib/context_dev.rb

@@ -58,6 +58,8 @@ require_relative "context_dev/models/ai_extract_products_params"
 require_relative "context_dev/models/ai_extract_products_response"
 require_relative "context_dev/models/batch_cancel_params"
 require_relative "context_dev/models/batch_cancel_response"
+require_relative "context_dev/models/batch_delete_params"
+require_relative "context_dev/models/batch_delete_response"
 require_relative "context_dev/models/batch_get_results_params"
 require_relative "context_dev/models/batch_get_results_response"
 require_relative "context_dev/models/batch_list_params"
@@ -108,6 +110,8 @@ require_relative "context_dev/models/monitor_update_response"
 require_relative "context_dev/models/page_error_count"
 require_relative "context_dev/models/parse_handle_params"
 require_relative "context_dev/models/parse_handle_response"
+require_relative "context_dev/models/person_enrich_params"
+require_relative "context_dev/models/person_enrich_response"
 require_relative "context_dev/models/utility_prefetch_params"
 require_relative "context_dev/models/utility_prefetch_response"
 require_relative "context_dev/models/web_extract_competitors_params"
@@ -140,5 +144,6 @@ require_relative "context_dev/resources/brand"
 require_relative "context_dev/resources/industry"
 require_relative "context_dev/resources/monitors"
 require_relative "context_dev/resources/parse"
+require_relative "context_dev/resources/people"
 require_relative "context_dev/resources/utility"
 require_relative "context_dev/resources/web"

data/rbi/context_dev/client.rbi

@@ -38,9 +38,13 @@ module ContextDev
     sig { returns(ContextDev::Resources::Monitors) }
     attr_reader :monitors
 
+    # Scrape many pages or crawl a site asynchronously.
     sig { returns(ContextDev::Resources::Batch) }
     attr_reader :batch
 
+    sig { returns(ContextDev::Resources::People) }
+    attr_reader :people
+
     # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_headers

data/rbi/context_dev/models/batch_delete_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class BatchDeleteParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(ContextDev::BatchDeleteParams, ContextDev::Internal::AnyHash)
+        end
+
+      # ID of the batch to retrieve or cancel.
+      sig { returns(String) }
+      attr_accessor :batch_id
+
+      sig do
+        params(
+          batch_id: String,
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # ID of the batch to retrieve or cancel.
+        batch_id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { batch_id: String, request_options: ContextDev::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/context_dev/models/batch_delete_response.rbi

@@ -0,0 +1,116 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class BatchDeleteResponse < ContextDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::Models::BatchDeleteResponse,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      # ID of the deleted batch.
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # Always true on success.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :deleted
+
+      sig { params(deleted: T::Boolean).void }
+      attr_writer :deleted
+
+      # 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::BatchDeleteResponse::KeyMetadata))
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::BatchDeleteResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
+      sig do
+        params(
+          id: String,
+          deleted: T::Boolean,
+          key_metadata:
+            ContextDev::Models::BatchDeleteResponse::KeyMetadata::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # ID of the deleted batch.
+        id: nil,
+        # Always true on success.
+        deleted: 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
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            deleted: T::Boolean,
+            key_metadata: ContextDev::Models::BatchDeleteResponse::KeyMetadata
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::BatchDeleteResponse::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/batch_get_results_response.rbi

@@ -190,6 +190,14 @@ module ContextDev
           sig { params(meta: T::Hash[Symbol, T.anything]).void }
           attr_writer :meta
 
+          # PDF pages of this document recovered by OCR (pdf.ocr=true). Each recovered page
+          # bills 1 credit on top of the page base credit; absent when no OCR ran.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :ocr_pages
+
+          sig { params(ocr_pages: Integer).void }
+          attr_writer :ocr_pages
+
           # A page the batch fetched successfully.
           sig do
             params(
@@ -202,6 +210,7 @@ module ContextDev
               item_id: String,
               markdown: String,
               meta: T::Hash[Symbol, T.anything],
+              ocr_pages: Integer,
               status: Symbol
             ).returns(T.attached_class)
           end
@@ -222,6 +231,9 @@ module ContextDev
             markdown: nil,
             # Caller-supplied metadata echoed from submission.
             meta: nil,
+            # PDF pages of this document recovered by OCR (pdf.ocr=true). Each recovered page
+            # bills 1 credit on top of the page base credit; absent when no OCR ran.
+            ocr_pages: nil,
             # The page was scraped.
             status: :ok
           )
@@ -239,7 +251,8 @@ module ContextDev
                 html: String,
                 item_id: String,
                 markdown: String,
-                meta: T::Hash[Symbol, T.anything]
+                meta: T::Hash[Symbol, T.anything],
+                ocr_pages: Integer
               }
             )
           end

data/rbi/context_dev/models/batch_list_response.rbi

@@ -304,11 +304,16 @@ module ContextDev
               )
             end
 
-          # `reserved` minus `refunded` — what the batch has cost so far. Equal to
-          # `reserved` until the batch settles.
+          # `reserved` minus `refunded` plus `ocr_charged` — what the batch has cost so far.
+          # Equal to `reserved` until the batch settles.
           sig { returns(Integer) }
           attr_accessor :net
 
+          # Credits charged for PDF pages recovered by OCR (pdf.ocr=true), 1 per recovered
+          # page, on top of `reserved`. Stays 0 until the batch settles.
+          sig { returns(Integer) }
+          attr_accessor :ocr_charged
+
           # Credits returned for pages that did not succeed. Stays 0 until the batch reaches
           # a final status, then settles in one movement.
           sig { returns(Integer) }
@@ -321,14 +326,20 @@ module ContextDev
 
           # What this batch has done to your credit balance.
           sig do
-            params(net: Integer, refunded: Integer, reserved: Integer).returns(
-              T.attached_class
-            )
+            params(
+              net: Integer,
+              ocr_charged: Integer,
+              refunded: Integer,
+              reserved: Integer
+            ).returns(T.attached_class)
           end
           def self.new(
-            # `reserved` minus `refunded` — what the batch has cost so far. Equal to
-            # `reserved` until the batch settles.
+            # `reserved` minus `refunded` plus `ocr_charged` — what the batch has cost so far.
+            # Equal to `reserved` until the batch settles.
             net:,
+            # Credits charged for PDF pages recovered by OCR (pdf.ocr=true), 1 per recovered
+            # page, on top of `reserved`. Stays 0 until the batch settles.
+            ocr_charged:,
             # Credits returned for pages that did not succeed. Stays 0 until the batch reaches
             # a final status, then settles in one movement.
             refunded:,
@@ -340,7 +351,12 @@ module ContextDev
 
           sig do
             override.returns(
-              { net: Integer, refunded: Integer, reserved: Integer }
+              {
+                net: Integer,
+                ocr_charged: Integer,
+                refunded: Integer,
+                reserved: Integer
+              }
             )
           end
           def to_hash