context.dev 2.19.0 → 2.21.0

data/lib/context_dev/models/web_scrape_params.rb

@@ -19,12 +19,26 @@ module ContextDev
       #   @return [String]
       required :url, String
 
+      # @!attribute highlights_params
+      #   Highlight options. Requires formats.highlights: true.
+      #
+      #   @return [ContextDev::Models::WebScrapeParams::HighlightsParams, nil]
+      optional :highlights_params,
+               -> { ContextDev::WebScrapeParams::HighlightsParams },
+               api_name: :highlightsParams
+
       # @!attribute image_params
       #   Image options. Requires formats.images: true.
       #
       #   @return [ContextDev::Models::WebScrapeParams::ImageParams, nil]
       optional :image_params, -> { ContextDev::WebScrapeParams::ImageParams }, api_name: :imageParams
 
+      # @!attribute json_params
+      #   Required when formats.json is true.
+      #
+      #   @return [ContextDev::Models::WebScrapeParams::JsonParams, nil]
+      optional :json_params, -> { ContextDev::WebScrapeParams::JsonParams }, api_name: :jsonParams
+
       # @!attribute markdown_params
       #   Markdown options. Requires formats.markdown: true.
       #
@@ -46,6 +60,12 @@ module ContextDev
       #   @return [ContextDev::Models::WebScrapeParams::ParseParams, nil]
       optional :parse_params, -> { ContextDev::WebScrapeParams::ParseParams }, api_name: :parseParams
 
+      # @!attribute product_params
+      #   Product options. Requires formats.product: true.
+      #
+      #   @return [ContextDev::Models::WebScrapeParams::ProductParams, nil]
+      optional :product_params, -> { ContextDev::WebScrapeParams::ProductParams }, api_name: :productParams
+
       # @!attribute screenshot_params
       #   Screenshot options. Requires formats.screenshot: true.
       #
@@ -69,12 +89,16 @@ module ContextDev
 
       # @!attribute timeout_opts
       #   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.
       #
       #   @return [ContextDev::Models::WebScrapeParams::TimeoutOpts, nil]
       optional :timeout_opts, -> { ContextDev::WebScrapeParams::TimeoutOpts }, api_name: :timeoutOpts
@@ -86,7 +110,7 @@ module ContextDev
       #   @return [Symbol, ContextDev::Models::WebScrapeParams::Zdr, nil]
       optional :zdr, enum: -> { ContextDev::WebScrapeParams::Zdr }
 
-      # @!method initialize(formats:, url:, image_params: nil, markdown_params: nil, max_age_ms: nil, parse_params: nil, screenshot_params: nil, shared_params: nil, tags: nil, timeout_opts: nil, zdr: nil, request_options: {})
+      # @!method initialize(formats:, url:, highlights_params: nil, image_params: nil, json_params: nil, markdown_params: nil, max_age_ms: nil, parse_params: nil, product_params: nil, screenshot_params: nil, shared_params: nil, tags: nil, timeout_opts: nil, zdr: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebScrapeParams} for more details.
       #
@@ -94,14 +118,20 @@ module ContextDev
       #
       #   @param url [String] The URL to scrape.
       #
+      #   @param highlights_params [ContextDev::Models::WebScrapeParams::HighlightsParams] Highlight options. Requires formats.highlights: true.
+      #
       #   @param image_params [ContextDev::Models::WebScrapeParams::ImageParams] Image options. Requires formats.images: true.
       #
+      #   @param json_params [ContextDev::Models::WebScrapeParams::JsonParams] Required when formats.json is true.
+      #
       #   @param markdown_params [ContextDev::Models::WebScrapeParams::MarkdownParams] Markdown options. Requires formats.markdown: true.
       #
       #   @param max_age_ms [Integer] Maximum age of each cached output. Defaults to 1 day; 0 fetches fresh and update
       #
       #   @param parse_params [ContextDev::Models::WebScrapeParams::ParseParams] Required when formats.parse is true.
       #
+      #   @param product_params [ContextDev::Models::WebScrapeParams::ProductParams] Product options. Requires formats.product: true.
+      #
       #   @param screenshot_params [ContextDev::Models::WebScrapeParams::ScreenshotParams] Screenshot options. Requires formats.screenshot: true.
       #
       #   @param shared_params [ContextDev::Models::WebScrapeParams::SharedParams] Shared browser and content settings. Content filters leave screenshots and origi
@@ -121,6 +151,14 @@ module ContextDev
         #   @return [Boolean, nil]
         optional :bytes, ContextDev::Internal::Type::Boolean
 
+        # @!attribute highlights
+        #   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.
+        #
+        #   @return [Boolean, nil]
+        optional :highlights, ContextDev::Internal::Type::Boolean
+
         # @!attribute html
         #   Rendered HTML.
         #
@@ -133,6 +171,13 @@ module ContextDev
         #   @return [Boolean, nil]
         optional :images, ContextDev::Internal::Type::Boolean
 
+        # @!attribute json
+        #   Page data extracted using your schema. Adds 4 credits when extraction succeeds
+        #   and its result is returned.
+        #
+        #   @return [Boolean, nil]
+        optional :json, ContextDev::Internal::Type::Boolean
+
         # @!attribute markdown
         #   Page content as Markdown.
         #
@@ -145,28 +190,65 @@ module ContextDev
         #   @return [Boolean, nil]
         optional :parse, ContextDev::Internal::Type::Boolean
 
+        # @!attribute product
+        #   Product details such as name, price, and availability. Adds 1 credit when its
+        #   successful result is returned or the target page is missing.
+        #
+        #   @return [Boolean, nil]
+        optional :product, ContextDev::Internal::Type::Boolean
+
         # @!attribute screenshot
         #   An inline image of the page.
         #
         #   @return [Boolean, nil]
         optional :screenshot, ContextDev::Internal::Type::Boolean
 
-        # @!method initialize(bytes: nil, html: nil, images: nil, markdown: nil, parse: nil, screenshot: nil)
+        # @!method initialize(bytes: nil, highlights: nil, html: nil, images: nil, json: nil, markdown: nil, parse: nil, product: nil, screenshot: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::WebScrapeParams::Formats} for more details.
+        #
         #   Outputs to return. Enable at least one; omitted formats are false.
         #
         #   @param bytes [Boolean] The original HTTP response body.
         #
+        #   @param highlights [Boolean] Relevant Markdown excerpts for your question or topic, preserving code, lists, a
+        #
         #   @param html [Boolean] Rendered HTML.
         #
         #   @param images [Boolean] Images found on the page.
         #
+        #   @param json [Boolean] Page data extracted using your schema. Adds 4 credits when extraction succeeds a
+        #
         #   @param markdown [Boolean] Page content as Markdown.
         #
         #   @param parse [Boolean] Fields selected by parseParams.rules.
         #
+        #   @param product [Boolean] Product details such as name, price, and availability. Adds 1 credit when its su
+        #
         #   @param screenshot [Boolean] An inline image of the page.
       end
 
+      class HighlightsParams < ContextDev::Internal::Type::BaseModel
+        # @!attribute query
+        #   The question or topic to find passages for.
+        #
+        #   @return [String]
+        required :query, String
+
+        # @!attribute max_characters
+        #   Maximum combined length of the returned passages, in characters.
+        #
+        #   @return [Integer, nil]
+        optional :max_characters, Integer, api_name: :maxCharacters
+
+        # @!method initialize(query:, max_characters: nil)
+        #   Highlight options. Requires formats.highlights: true.
+        #
+        #   @param query [String] The question or topic to find passages for.
+        #
+        #   @param max_characters [Integer] Maximum combined length of the returned passages, in characters.
+      end
+
       class ImageParams < ContextDev::Internal::Type::BaseModel
         # @!attribute dedupe
         #   For visual duplicates, keep the largest image.
@@ -218,6 +300,35 @@ module ContextDev
         end
       end
 
+      class JsonParams < ContextDev::Internal::Type::BaseModel
+        # @!attribute schema
+        #   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().
+        #
+        #   @return [Hash{Symbol=>Object}]
+        required :schema, ContextDev::Internal::Type::HashOf[ContextDev::Internal::Type::Unknown]
+
+        # @!attribute instructions
+        #   Optional guidance on which facts to prioritize or how to interpret schema
+        #   fields.
+        #
+        #   @return [String, nil]
+        optional :instructions, String
+
+        # @!method initialize(schema:, instructions: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::WebScrapeParams::JsonParams} for more details.
+        #
+        #   Required when formats.json is true.
+        #
+        #   @param schema [Hash{Symbol=>Object}] JSON Schema for the returned object. Must describe a top-level object; at most 5
+        #
+        #   @param instructions [String] Optional guidance on which facts to prioritize or how to interpret schema fields
+      end
+
       class MarkdownParams < ContextDev::Internal::Type::BaseModel
         # @!attribute include_images
         #
@@ -355,6 +466,26 @@ module ContextDev
         end
       end
 
+      class ProductParams < ContextDev::Internal::Type::BaseModel
+        # @!attribute use_ai_fallback
+        #   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.
+        #
+        #   @return [Boolean, nil]
+        optional :use_ai_fallback, ContextDev::Internal::Type::Boolean, api_name: :useAIFallback
+
+        # @!method initialize(use_ai_fallback: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::WebScrapeParams::ProductParams} for more details.
+        #
+        #   Product options. Requires formats.product: true.
+        #
+        #   @param use_ai_fallback [Boolean] Extract the product with a specialized model when the page has no structured pro
+      end
+
       class ScreenshotParams < ContextDev::Internal::Type::BaseModel
         # @!attribute area
         #   Viewport, full page, one visible element, or a rectangle. Maximum 40 megapixels.
@@ -861,12 +992,16 @@ module ContextDev
         #   {ContextDev::Models::WebScrapeParams::TimeoutOpts} for more details.
         #
         #   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.
         #
         #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
         #