context.dev 2.19.0 → 2.21.0

data/rbi/context_dev/models/web_scrape_params.rbi

@@ -22,6 +22,18 @@ module ContextDev
       sig { returns(String) }
       attr_accessor :url
 
+      # Highlight options. Requires formats.highlights: true.
+      sig { returns(T.nilable(ContextDev::WebScrapeParams::HighlightsParams)) }
+      attr_reader :highlights_params
+
+      sig do
+        params(
+          highlights_params:
+            ContextDev::WebScrapeParams::HighlightsParams::OrHash
+        ).void
+      end
+      attr_writer :highlights_params
+
       # Image options. Requires formats.images: true.
       sig { returns(T.nilable(ContextDev::WebScrapeParams::ImageParams)) }
       attr_reader :image_params
@@ -33,6 +45,17 @@ module ContextDev
       end
       attr_writer :image_params
 
+      # Required when formats.json is true.
+      sig { returns(T.nilable(ContextDev::WebScrapeParams::JsonParams)) }
+      attr_reader :json_params
+
+      sig do
+        params(
+          json_params: ContextDev::WebScrapeParams::JsonParams::OrHash
+        ).void
+      end
+      attr_writer :json_params
+
       # Markdown options. Requires formats.markdown: true.
       sig { returns(T.nilable(ContextDev::WebScrapeParams::MarkdownParams)) }
       attr_reader :markdown_params
@@ -65,6 +88,17 @@ module ContextDev
       end
       attr_writer :parse_params
 
+      # Product options. Requires formats.product: true.
+      sig { returns(T.nilable(ContextDev::WebScrapeParams::ProductParams)) }
+      attr_reader :product_params
+
+      sig do
+        params(
+          product_params: ContextDev::WebScrapeParams::ProductParams::OrHash
+        ).void
+      end
+      attr_writer :product_params
+
       # Screenshot options. Requires formats.screenshot: true.
       sig { returns(T.nilable(ContextDev::WebScrapeParams::ScreenshotParams)) }
       attr_reader :screenshot_params
@@ -97,12 +131,16 @@ module ContextDev
       attr_writer :tags
 
       # Total deadline, including navigation, actions, waiting, and all outputs.
-      # Defaults to 60000 milliseconds with behavior fail. Use return-partial to capture
-      # the current page state and return captured images if image processing cannot
-      # finish before the deadline; these responses set isPartial and are not cached.
-      # Every requested format must still be available. Fixed waits must fit before a
-      # response reserve of up to 5000 milliseconds (at most one quarter of the timeout)
-      # when using return-partial.
+      # Defaults to 60000 milliseconds with behavior fail. Individual outputs have
+      # internal deadlines that reserve time to return completed outputs; timed-out
+      # outputs have success: false and data: null under either behavior. The overall
+      # request deadline remains enforced: fail returns an error if that deadline is
+      # reached. Use return-partial to allow the current page state and available
+      # outputs when the page is still loading. Partial responses set isPartial. Failed
+      # retrievals and incomplete captures are not cached; valid captured pieces may be
+      # cached independently. Fixed waits must fit before a response reserve of up to
+      # 5000 milliseconds (at most one quarter of the timeout) when using
+      # return-partial.
       sig { returns(T.nilable(ContextDev::WebScrapeParams::TimeoutOpts)) }
       attr_reader :timeout_opts
 
@@ -125,10 +163,14 @@ module ContextDev
         params(
           formats: ContextDev::WebScrapeParams::Formats::OrHash,
           url: String,
+          highlights_params:
+            ContextDev::WebScrapeParams::HighlightsParams::OrHash,
           image_params: ContextDev::WebScrapeParams::ImageParams::OrHash,
+          json_params: ContextDev::WebScrapeParams::JsonParams::OrHash,
           markdown_params: ContextDev::WebScrapeParams::MarkdownParams::OrHash,
           max_age_ms: Integer,
           parse_params: ContextDev::WebScrapeParams::ParseParams::OrHash,
+          product_params: ContextDev::WebScrapeParams::ProductParams::OrHash,
           screenshot_params:
             ContextDev::WebScrapeParams::ScreenshotParams::OrHash,
           shared_params: ContextDev::WebScrapeParams::SharedParams::OrHash,
@@ -143,8 +185,12 @@ module ContextDev
         formats:,
         # The URL to scrape.
         url:,
+        # Highlight options. Requires formats.highlights: true.
+        highlights_params: nil,
         # Image options. Requires formats.images: true.
         image_params: nil,
+        # Required when formats.json is true.
+        json_params: nil,
         # Markdown options. Requires formats.markdown: true.
         markdown_params: nil,
         # Maximum age of each cached output. Defaults to 1 day; 0 fetches fresh and
@@ -154,6 +200,8 @@ module ContextDev
         max_age_ms: nil,
         # Required when formats.parse is true.
         parse_params: nil,
+        # Product options. Requires formats.product: true.
+        product_params: nil,
         # Screenshot options. Requires formats.screenshot: true.
         screenshot_params: nil,
         # Shared browser and content settings. Content filters leave screenshots and
@@ -162,12 +210,16 @@ module ContextDev
         # Labels for tracking request usage. Not retained when zdr is enabled.
         tags: nil,
         # Total deadline, including navigation, actions, waiting, and all outputs.
-        # Defaults to 60000 milliseconds with behavior fail. Use return-partial to capture
-        # the current page state and return captured images if image processing cannot
-        # finish before the deadline; these responses set isPartial and are not cached.
-        # Every requested format must still be available. Fixed waits must fit before a
-        # response reserve of up to 5000 milliseconds (at most one quarter of the timeout)
-        # when using return-partial.
+        # Defaults to 60000 milliseconds with behavior fail. Individual outputs have
+        # internal deadlines that reserve time to return completed outputs; timed-out
+        # outputs have success: false and data: null under either behavior. The overall
+        # request deadline remains enforced: fail returns an error if that deadline is
+        # reached. Use return-partial to allow the current page state and available
+        # outputs when the page is still loading. Partial responses set isPartial. Failed
+        # retrievals and incomplete captures are not cached; valid captured pieces may be
+        # cached independently. Fixed waits must fit before a response reserve of up to
+        # 5000 milliseconds (at most one quarter of the timeout) when using
+        # return-partial.
         timeout_opts: nil,
         # Zero data retention. Bypasses caches and uploads; excludes request/response
         # content and tags from logs. Must be enabled for your organization.
@@ -181,10 +233,13 @@ module ContextDev
           {
             formats: ContextDev::WebScrapeParams::Formats,
             url: String,
+            highlights_params: ContextDev::WebScrapeParams::HighlightsParams,
             image_params: ContextDev::WebScrapeParams::ImageParams,
+            json_params: ContextDev::WebScrapeParams::JsonParams,
             markdown_params: ContextDev::WebScrapeParams::MarkdownParams,
             max_age_ms: Integer,
             parse_params: ContextDev::WebScrapeParams::ParseParams,
+            product_params: ContextDev::WebScrapeParams::ProductParams,
             screenshot_params: ContextDev::WebScrapeParams::ScreenshotParams,
             shared_params: ContextDev::WebScrapeParams::SharedParams,
             tags: T::Array[String],
@@ -213,6 +268,15 @@ module ContextDev
         sig { params(bytes: T::Boolean).void }
         attr_writer :bytes
 
+        # Relevant Markdown excerpts for your question or topic, preserving code, lists,
+        # and tables, with headings included when needed for context. Adds 3 credits when
+        # passages are returned.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :highlights
+
+        sig { params(highlights: T::Boolean).void }
+        attr_writer :highlights
+
         # Rendered HTML.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :html
@@ -227,6 +291,14 @@ module ContextDev
         sig { params(images: T::Boolean).void }
         attr_writer :images
 
+        # Page data extracted using your schema. Adds 4 credits when extraction succeeds
+        # and its result is returned.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :json
+
+        sig { params(json: T::Boolean).void }
+        attr_writer :json
+
         # Page content as Markdown.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :markdown
@@ -241,6 +313,14 @@ module ContextDev
         sig { params(parse: T::Boolean).void }
         attr_writer :parse
 
+        # Product details such as name, price, and availability. Adds 1 credit when its
+        # successful result is returned or the target page is missing.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :product
+
+        sig { params(product: T::Boolean).void }
+        attr_writer :product
+
         # An inline image of the page.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :screenshot
@@ -252,24 +332,37 @@ module ContextDev
         sig do
           params(
             bytes: T::Boolean,
+            highlights: T::Boolean,
             html: T::Boolean,
             images: T::Boolean,
+            json: T::Boolean,
             markdown: T::Boolean,
             parse: T::Boolean,
+            product: T::Boolean,
             screenshot: T::Boolean
           ).returns(T.attached_class)
         end
         def self.new(
           # The original HTTP response body.
           bytes: nil,
+          # Relevant Markdown excerpts for your question or topic, preserving code, lists,
+          # and tables, with headings included when needed for context. Adds 3 credits when
+          # passages are returned.
+          highlights: nil,
           # Rendered HTML.
           html: nil,
           # Images found on the page.
           images: nil,
+          # Page data extracted using your schema. Adds 4 credits when extraction succeeds
+          # and its result is returned.
+          json: nil,
           # Page content as Markdown.
           markdown: nil,
           # Fields selected by parseParams.rules.
           parse: nil,
+          # Product details such as name, price, and availability. Adds 1 credit when its
+          # successful result is returned or the target page is missing.
+          product: nil,
           # An inline image of the page.
           screenshot: nil
         )
@@ -279,10 +372,13 @@ module ContextDev
           override.returns(
             {
               bytes: T::Boolean,
+              highlights: T::Boolean,
               html: T::Boolean,
               images: T::Boolean,
+              json: T::Boolean,
               markdown: T::Boolean,
               parse: T::Boolean,
+              product: T::Boolean,
               screenshot: T::Boolean
             }
           )
@@ -291,6 +387,45 @@ module ContextDev
         end
       end
 
+      class HighlightsParams < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::WebScrapeParams::HighlightsParams,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # The question or topic to find passages for.
+        sig { returns(String) }
+        attr_accessor :query
+
+        # Maximum combined length of the returned passages, in characters.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :max_characters
+
+        sig { params(max_characters: Integer).void }
+        attr_writer :max_characters
+
+        # Highlight options. Requires formats.highlights: true.
+        sig do
+          params(query: String, max_characters: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The question or topic to find passages for.
+          query:,
+          # Maximum combined length of the returned passages, in characters.
+          max_characters: nil
+        )
+        end
+
+        sig { override.returns({ query: String, max_characters: Integer }) }
+        def to_hash
+        end
+      end
+
       class ImageParams < ContextDev::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -445,6 +580,60 @@ module ContextDev
         end
       end
 
+      class JsonParams < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::WebScrapeParams::JsonParams,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # JSON Schema for the returned object. Must describe a top-level object; at most
+        # 50 KB serialized. Optional fields the page does not state are omitted, or null
+        # when their type allows null, while required non-nullable fields always receive a
+        # best-effort value, so prefer nullable or optional fields for data a page may
+        # omit. Zod users can pass the output of z.toJSONSchema().
+        sig { returns(T::Hash[Symbol, T.anything]) }
+        attr_accessor :schema
+
+        # Optional guidance on which facts to prioritize or how to interpret schema
+        # fields.
+        sig { returns(T.nilable(String)) }
+        attr_reader :instructions
+
+        sig { params(instructions: String).void }
+        attr_writer :instructions
+
+        # Required when formats.json is true.
+        sig do
+          params(
+            schema: T::Hash[Symbol, T.anything],
+            instructions: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # JSON Schema for the returned object. Must describe a top-level object; at most
+          # 50 KB serialized. Optional fields the page does not state are omitted, or null
+          # when their type allows null, while required non-nullable fields always receive a
+          # best-effort value, so prefer nullable or optional fields for data a page may
+          # omit. Zod users can pass the output of z.toJSONSchema().
+          schema:,
+          # Optional guidance on which facts to prioritize or how to interpret schema
+          # fields.
+          instructions: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { schema: T::Hash[Symbol, T.anything], instructions: String }
+          )
+        end
+        def to_hash
+        end
+      end
+
       class MarkdownParams < ContextDev::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -798,6 +987,43 @@ module ContextDev
         end
       end
 
+      class ProductParams < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::WebScrapeParams::ProductParams,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Extract the product with a specialized model when the page has no structured
+        # product data. Adds six credits when the model verdict is returned successfully.
+        # If the fallback fails, the product output has success: false and data: null with
+        # no fallback charge; other outputs remain available. Request deadlines and client
+        # disconnects still apply.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :use_ai_fallback
+
+        sig { params(use_ai_fallback: T::Boolean).void }
+        attr_writer :use_ai_fallback
+
+        # Product options. Requires formats.product: true.
+        sig { params(use_ai_fallback: T::Boolean).returns(T.attached_class) }
+        def self.new(
+          # Extract the product with a specialized model when the page has no structured
+          # product data. Adds six credits when the model verdict is returned successfully.
+          # If the fallback fails, the product output has success: false and data: null with
+          # no fallback charge; other outputs remain available. Request deadlines and client
+          # disconnects still apply.
+          use_ai_fallback: nil
+        )
+        end
+
+        sig { override.returns({ use_ai_fallback: T::Boolean }) }
+        def to_hash
+        end
+      end
+
       class ScreenshotParams < ContextDev::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -1899,12 +2125,16 @@ module ContextDev
         attr_writer :behavior
 
         # Total deadline, including navigation, actions, waiting, and all outputs.
-        # Defaults to 60000 milliseconds with behavior fail. Use return-partial to capture
-        # the current page state and return captured images if image processing cannot
-        # finish before the deadline; these responses set isPartial and are not cached.
-        # Every requested format must still be available. Fixed waits must fit before a
-        # response reserve of up to 5000 milliseconds (at most one quarter of the timeout)
-        # when using return-partial.
+        # Defaults to 60000 milliseconds with behavior fail. Individual outputs have
+        # internal deadlines that reserve time to return completed outputs; timed-out
+        # outputs have success: false and data: null under either behavior. The overall
+        # request deadline remains enforced: fail returns an error if that deadline is
+        # reached. Use return-partial to allow the current page state and available
+        # outputs when the page is still loading. Partial responses set isPartial. Failed
+        # retrievals and incomplete captures are not cached; valid captured pieces may be
+        # cached independently. Fixed waits must fit before a response reserve of up to
+        # 5000 milliseconds (at most one quarter of the timeout) when using
+        # return-partial.
         sig do
           params(
             milliseconds: Integer,