context.dev 2.8.0 → 2.10.0

data/rbi/context_dev/models/web_web_scrape_html_params.rbi

@@ -67,27 +67,10 @@ module ContextDev
       attr_writer :headers
 
       # When true, iframes are rendered inline into the returned HTML.
-      sig do
-        returns(
-          T.nilable(
-            T.any(
-              T::Boolean,
-              ContextDev::WebWebScrapeHTMLParams::IncludeFrames::OrSymbol
-            )
-          )
-        )
-      end
+      sig { returns(T.nilable(T::Boolean)) }
       attr_reader :include_frames
 
-      sig do
-        params(
-          include_frames:
-            T.any(
-              T::Boolean,
-              ContextDev::WebWebScrapeHTMLParams::IncludeFrames::OrSymbol
-            )
-        ).void
-      end
+      sig { params(include_frames: T::Boolean).void }
       attr_writer :include_frames
 
       # CSS selectors. When provided, only matching subtrees (and their descendants) are
@@ -113,27 +96,10 @@ module ContextDev
       # When true, waits briefly for CSS and transition animations to settle before
       # extracting HTML. Defaults to false. This adds a bit of latency in exchange for
       # more stable output on animated pages.
-      sig do
-        returns(
-          T.nilable(
-            T.any(
-              T::Boolean,
-              ContextDev::WebWebScrapeHTMLParams::SettleAnimations::OrSymbol
-            )
-          )
-        )
-      end
+      sig { returns(T.nilable(T::Boolean)) }
       attr_reader :settle_animations
 
-      sig do
-        params(
-          settle_animations:
-            T.any(
-              T::Boolean,
-              ContextDev::WebWebScrapeHTMLParams::SettleAnimations::OrSymbol
-            )
-        ).void
-      end
+      sig { params(settle_animations: T::Boolean).void }
       attr_writer :settle_animations
 
       # Optional comma-separated caller-defined tags for tracking this request. Tags are
@@ -156,27 +122,10 @@ module ContextDev
 
       # When true, return only the page's main content in the HTML response, excluding
       # headers, footers, sidebars, and navigation when detectable.
-      sig do
-        returns(
-          T.nilable(
-            T.any(
-              T::Boolean,
-              ContextDev::WebWebScrapeHTMLParams::UseMainContentOnly::OrSymbol
-            )
-          )
-        )
-      end
+      sig { returns(T.nilable(T::Boolean)) }
       attr_reader :use_main_content_only
 
-      sig do
-        params(
-          use_main_content_only:
-            T.any(
-              T::Boolean,
-              ContextDev::WebWebScrapeHTMLParams::UseMainContentOnly::OrSymbol
-            )
-        ).void
-      end
+      sig { params(use_main_content_only: T::Boolean).void }
       attr_writer :use_main_content_only
 
       # Optional browser wait time in milliseconds after initial page load. Min: 0. Max:
@@ -213,26 +162,14 @@ module ContextDev
           country: ContextDev::WebWebScrapeHTMLParams::Country::OrSymbol,
           exclude_selectors: T.nilable(T::Array[String]),
           headers: T::Hash[Symbol, String],
-          include_frames:
-            T.any(
-              T::Boolean,
-              ContextDev::WebWebScrapeHTMLParams::IncludeFrames::OrSymbol
-            ),
+          include_frames: T::Boolean,
           include_selectors: T.nilable(T::Array[String]),
           max_age_ms: T.nilable(Integer),
           pdf: ContextDev::WebWebScrapeHTMLParams::Pdf::OrHash,
-          settle_animations:
-            T.any(
-              T::Boolean,
-              ContextDev::WebWebScrapeHTMLParams::SettleAnimations::OrSymbol
-            ),
+          settle_animations: T::Boolean,
           tags: T::Array[String],
           timeout_ms: Integer,
-          use_main_content_only:
-            T.any(
-              T::Boolean,
-              ContextDev::WebWebScrapeHTMLParams::UseMainContentOnly::OrSymbol
-            ),
+          use_main_content_only: T::Boolean,
           wait_for_ms: T.nilable(Integer),
           zdr: ContextDev::WebWebScrapeHTMLParams::Zdr::OrSymbol,
           request_options: ContextDev::RequestOptions::OrHash
@@ -312,26 +249,14 @@ module ContextDev
             country: ContextDev::WebWebScrapeHTMLParams::Country::OrSymbol,
             exclude_selectors: T.nilable(T::Array[String]),
             headers: T::Hash[Symbol, String],
-            include_frames:
-              T.any(
-                T::Boolean,
-                ContextDev::WebWebScrapeHTMLParams::IncludeFrames::OrSymbol
-              ),
+            include_frames: T::Boolean,
             include_selectors: T.nilable(T::Array[String]),
             max_age_ms: T.nilable(Integer),
             pdf: ContextDev::WebWebScrapeHTMLParams::Pdf,
-            settle_animations:
-              T.any(
-                T::Boolean,
-                ContextDev::WebWebScrapeHTMLParams::SettleAnimations::OrSymbol
-              ),
+            settle_animations: T::Boolean,
             tags: T::Array[String],
             timeout_ms: Integer,
-            use_main_content_only:
-              T.any(
-                T::Boolean,
-                ContextDev::WebWebScrapeHTMLParams::UseMainContentOnly::OrSymbol
-              ),
+            use_main_content_only: T::Boolean,
             wait_for_ms: T.nilable(Integer),
             zdr: ContextDev::WebWebScrapeHTMLParams::Zdr::OrSymbol,
             request_options: ContextDev::RequestOptions
@@ -844,46 +769,6 @@ module ContextDev
         end
       end
 
-      # When true, iframes are rendered inline into the returned HTML.
-      module IncludeFrames
-        extend ContextDev::Internal::Type::Union
-
-        Variants =
-          T.type_alias do
-            T.any(
-              T::Boolean,
-              ContextDev::WebWebScrapeHTMLParams::IncludeFrames::TaggedSymbol
-            )
-          end
-
-        sig do
-          override.returns(
-            T::Array[
-              ContextDev::WebWebScrapeHTMLParams::IncludeFrames::Variants
-            ]
-          )
-        end
-        def self.variants
-        end
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, ContextDev::WebWebScrapeHTMLParams::IncludeFrames)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        TRUE =
-          T.let(
-            :true,
-            ContextDev::WebWebScrapeHTMLParams::IncludeFrames::TaggedSymbol
-          )
-        FALSE =
-          T.let(
-            :false,
-            ContextDev::WebWebScrapeHTMLParams::IncludeFrames::TaggedSymbol
-          )
-      end
-
       class Pdf < ContextDev::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -901,55 +786,22 @@ module ContextDev
         sig { params(end_: Integer).void }
         attr_writer :end_
 
-        # 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.
-        sig do
-          returns(
-            T.nilable(
-              T.any(
-                T::Boolean,
-                ContextDev::WebWebScrapeHTMLParams::Pdf::Ocr::OrSymbol
-              )
-            )
-          )
-        end
+        # 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.
+        sig { returns(T.nilable(T::Boolean)) }
         attr_reader :ocr
 
-        sig do
-          params(
-            ocr:
-              T.any(
-                T::Boolean,
-                ContextDev::WebWebScrapeHTMLParams::Pdf::Ocr::OrSymbol
-              )
-          ).void
-        end
+        sig { params(ocr: T::Boolean).void }
         attr_writer :ocr
 
         # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and
-        # a 400 WEBSITE_ACCESS_ERROR is returned.
-        sig do
-          returns(
-            T.nilable(
-              T.any(
-                T::Boolean,
-                ContextDev::WebWebScrapeHTMLParams::Pdf::ShouldParse::OrSymbol
-              )
-            )
-          )
-        end
+        # a 400 PDF_SKIPPED is returned.
+        sig { returns(T.nilable(T::Boolean)) }
         attr_reader :should_parse
 
-        sig do
-          params(
-            should_parse:
-              T.any(
-                T::Boolean,
-                ContextDev::WebWebScrapeHTMLParams::Pdf::ShouldParse::OrSymbol
-              )
-          ).void
-        end
+        sig { params(should_parse: T::Boolean).void }
         attr_writer :should_parse
 
         # First 1-based PDF page to parse. When omitted, parsing starts at the first page.
@@ -964,16 +816,8 @@ module ContextDev
         sig do
           params(
             end_: Integer,
-            ocr:
-              T.any(
-                T::Boolean,
-                ContextDev::WebWebScrapeHTMLParams::Pdf::Ocr::OrSymbol
-              ),
-            should_parse:
-              T.any(
-                T::Boolean,
-                ContextDev::WebWebScrapeHTMLParams::Pdf::ShouldParse::OrSymbol
-              ),
+            ocr: T::Boolean,
+            should_parse: T::Boolean,
             start: Integer
           ).returns(T.attached_class)
         end
@@ -981,12 +825,13 @@ module ContextDev
           # Last 1-based PDF page to parse. When omitted, parsing ends at the last page.
           # Must be greater than or equal to start when both are provided.
           end_: nil,
-          # 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.
           ocr: nil,
           # 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.
           should_parse: nil,
           # First 1-based PDF page to parse. When omitted, parsing starts at the first page.
           start: nil
@@ -997,192 +842,14 @@ module ContextDev
           override.returns(
             {
               end_: Integer,
-              ocr:
-                T.any(
-                  T::Boolean,
-                  ContextDev::WebWebScrapeHTMLParams::Pdf::Ocr::OrSymbol
-                ),
-              should_parse:
-                T.any(
-                  T::Boolean,
-                  ContextDev::WebWebScrapeHTMLParams::Pdf::ShouldParse::OrSymbol
-                ),
+              ocr: T::Boolean,
+              should_parse: T::Boolean,
               start: Integer
             }
           )
         end
         def to_hash
         end
-
-        # 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.
-        module Ocr
-          extend ContextDev::Internal::Type::Union
-
-          Variants =
-            T.type_alias do
-              T.any(
-                T::Boolean,
-                ContextDev::WebWebScrapeHTMLParams::Pdf::Ocr::TaggedSymbol
-              )
-            end
-
-          sig do
-            override.returns(
-              T::Array[ContextDev::WebWebScrapeHTMLParams::Pdf::Ocr::Variants]
-            )
-          end
-          def self.variants
-          end
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(Symbol, ContextDev::WebWebScrapeHTMLParams::Pdf::Ocr)
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          TRUE =
-            T.let(
-              :true,
-              ContextDev::WebWebScrapeHTMLParams::Pdf::Ocr::TaggedSymbol
-            )
-          FALSE =
-            T.let(
-              :false,
-              ContextDev::WebWebScrapeHTMLParams::Pdf::Ocr::TaggedSymbol
-            )
-        end
-
-        # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and
-        # a 400 WEBSITE_ACCESS_ERROR is returned.
-        module ShouldParse
-          extend ContextDev::Internal::Type::Union
-
-          Variants =
-            T.type_alias do
-              T.any(
-                T::Boolean,
-                ContextDev::WebWebScrapeHTMLParams::Pdf::ShouldParse::TaggedSymbol
-              )
-            end
-
-          sig do
-            override.returns(
-              T::Array[
-                ContextDev::WebWebScrapeHTMLParams::Pdf::ShouldParse::Variants
-              ]
-            )
-          end
-          def self.variants
-          end
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                ContextDev::WebWebScrapeHTMLParams::Pdf::ShouldParse
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          TRUE =
-            T.let(
-              :true,
-              ContextDev::WebWebScrapeHTMLParams::Pdf::ShouldParse::TaggedSymbol
-            )
-          FALSE =
-            T.let(
-              :false,
-              ContextDev::WebWebScrapeHTMLParams::Pdf::ShouldParse::TaggedSymbol
-            )
-        end
-      end
-
-      # When true, waits briefly for CSS and transition animations to settle before
-      # extracting HTML. Defaults to false. This adds a bit of latency in exchange for
-      # more stable output on animated pages.
-      module SettleAnimations
-        extend ContextDev::Internal::Type::Union
-
-        Variants =
-          T.type_alias do
-            T.any(
-              T::Boolean,
-              ContextDev::WebWebScrapeHTMLParams::SettleAnimations::TaggedSymbol
-            )
-          end
-
-        sig do
-          override.returns(
-            T::Array[
-              ContextDev::WebWebScrapeHTMLParams::SettleAnimations::Variants
-            ]
-          )
-        end
-        def self.variants
-        end
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, ContextDev::WebWebScrapeHTMLParams::SettleAnimations)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        TRUE =
-          T.let(
-            :true,
-            ContextDev::WebWebScrapeHTMLParams::SettleAnimations::TaggedSymbol
-          )
-        FALSE =
-          T.let(
-            :false,
-            ContextDev::WebWebScrapeHTMLParams::SettleAnimations::TaggedSymbol
-          )
-      end
-
-      # When true, return only the page's main content in the HTML response, excluding
-      # headers, footers, sidebars, and navigation when detectable.
-      module UseMainContentOnly
-        extend ContextDev::Internal::Type::Union
-
-        Variants =
-          T.type_alias do
-            T.any(
-              T::Boolean,
-              ContextDev::WebWebScrapeHTMLParams::UseMainContentOnly::TaggedSymbol
-            )
-          end
-
-        sig do
-          override.returns(
-            T::Array[
-              ContextDev::WebWebScrapeHTMLParams::UseMainContentOnly::Variants
-            ]
-          )
-        end
-        def self.variants
-        end
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(
-              Symbol,
-              ContextDev::WebWebScrapeHTMLParams::UseMainContentOnly
-            )
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        TRUE =
-          T.let(
-            :true,
-            ContextDev::WebWebScrapeHTMLParams::UseMainContentOnly::TaggedSymbol
-          )
-        FALSE =
-          T.let(
-            :false,
-            ContextDev::WebWebScrapeHTMLParams::UseMainContentOnly::TaggedSymbol
-          )
       end
 
       # Set to enabled to bypass shared caches and omit request and response content

data/rbi/context_dev/models/web_web_scrape_html_response.rbi

@@ -259,6 +259,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::WebWebScrapeHTMLResponse::Metadata::Heading
+              ]
+            )
+          )
+        end
+        attr_reader :headings
+
+        sig do
+          params(
+            headings:
+              T::Array[
+                ContextDev::Models::WebWebScrapeHTMLResponse::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
@@ -388,6 +411,10 @@ module ContextDev
             canonical_url: String,
             description: String,
             favicon: String,
+            headings:
+              T::Array[
+                ContextDev::Models::WebWebScrapeHTMLResponse::Metadata::Heading::OrHash
+              ],
             image: String,
             json_ld: T::Array[T::Hash[Symbol, T.anything]],
             keywords: T::Array[String],
@@ -427,6 +454,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.
@@ -470,6 +500,10 @@ module ContextDev
               canonical_url: String,
               description: String,
               favicon: String,
+              headings:
+                T::Array[
+                  ContextDev::Models::WebWebScrapeHTMLResponse::Metadata::Heading
+                ],
               image: String,
               json_ld: T::Array[T::Hash[Symbol, T.anything]],
               keywords: T::Array[String],
@@ -580,6 +614,37 @@ module ContextDev
           end
         end
 
+        class Heading < ContextDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ContextDev::Models::WebWebScrapeHTMLResponse::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 { params(level: Integer, text: String).returns(T.attached_class) }
+          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