context.dev 2.8.0 → 2.10.0

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

@@ -162,7 +162,8 @@ module ContextDev
           sig { returns(String) }
           attr_accessor :url
 
-          # Raw page HTML. Present on html batches.
+          # Page HTML. Present on html batches, and on markdown batches submitted with
+          # `options.includeHTML`.
           sig { returns(T.nilable(String)) }
           attr_reader :html
 
@@ -190,6 +191,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 +211,7 @@ module ContextDev
               item_id: String,
               markdown: String,
               meta: T::Hash[Symbol, T.anything],
+              ocr_pages: Integer,
               status: Symbol
             ).returns(T.attached_class)
           end
@@ -214,7 +224,8 @@ module ContextDev
             metadata:,
             # URL as submitted, or as discovered by the crawl.
             url:,
-            # Raw page HTML. Present on html batches.
+            # Page HTML. Present on html batches, and on markdown batches submitted with
+            # `options.includeHTML`.
             html: nil,
             # Caller-supplied identifier echoed from submission.
             item_id: nil,
@@ -222,6 +233,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 +253,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
@@ -338,6 +353,29 @@ module ContextDev
             sig { params(favicon: String).void }
             attr_writer :favicon
 
+            # Page headings (h1–h6) in document order, extracted from the unfiltered document.
+            # Capped at the first 500 headings. Omitted when the page has none.
+            sig do
+              returns(
+                T.nilable(
+                  T::Array[
+                    ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::Heading
+                  ]
+                )
+              )
+            end
+            attr_reader :headings
+
+            sig do
+              params(
+                headings:
+                  T::Array[
+                    ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::Heading::OrHash
+                  ]
+              ).void
+            end
+            attr_writer :headings
+
             # Primary resolved preview image from Open Graph, Twitter, or image metadata.
             sig { returns(T.nilable(String)) }
             attr_reader :image
@@ -467,6 +505,10 @@ module ContextDev
                 canonical_url: String,
                 description: String,
                 favicon: String,
+                headings:
+                  T::Array[
+                    ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::Heading::OrHash
+                  ],
                 image: String,
                 json_ld: T::Array[T::Hash[Symbol, T.anything]],
                 keywords: T::Array[String],
@@ -506,6 +548,9 @@ module ContextDev
               description: nil,
               # Resolved favicon URL, when present.
               favicon: nil,
+              # Page headings (h1–h6) in document order, extracted from the unfiltered document.
+              # Capped at the first 500 headings. Omitted when the page has none.
+              headings: nil,
               # Primary resolved preview image from Open Graph, Twitter, or image metadata.
               image: nil,
               # JSON-LD structured data blocks parsed from the page.
@@ -549,6 +594,10 @@ module ContextDev
                   canonical_url: String,
                   description: String,
                   favicon: String,
+                  headings:
+                    T::Array[
+                      ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::Heading
+                    ],
                   image: String,
                   json_ld: T::Array[T::Hash[Symbol, T.anything]],
                   keywords: T::Array[String],
@@ -664,6 +713,39 @@ module ContextDev
               end
             end
 
+            class Heading < ContextDev::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    ContextDev::Models::BatchGetResultsResponse::Data::Ok::Metadata::Heading,
+                    ContextDev::Internal::AnyHash
+                  )
+                end
+
+              # Heading level, 1–6 (from h1–h6).
+              sig { returns(Integer) }
+              attr_accessor :level
+
+              # Heading text with whitespace collapsed, truncated to 1000 characters.
+              sig { returns(String) }
+              attr_accessor :text
+
+              sig do
+                params(level: Integer, text: String).returns(T.attached_class)
+              end
+              def self.new(
+                # Heading level, 1–6 (from h1–h6).
+                level:,
+                # Heading text with whitespace collapsed, truncated to 1000 characters.
+                text:
+              )
+              end
+
+              sig { override.returns({ level: Integer, text: String }) }
+              def to_hash
+              end
+            end
+
             module OpenGraph
               extend ContextDev::Internal::Type::Union
 

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

data/rbi/context_dev/models/batch_retrieve_response.rbi

@@ -238,11 +238,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) }
@@ -255,14 +260,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:,
@@ -274,7 +285,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