context.dev 2.19.0 → 2.21.0

data/rbi/context_dev/models.rbi

@@ -21,6 +21,8 @@ module ContextDev
 
   Failure = ContextDev::Models::Failure
 
+  FeedbackSubmitParams = ContextDev::Models::FeedbackSubmitParams
+
   IndustryRetrieveNaicsParams = ContextDev::Models::IndustryRetrieveNaicsParams
 
   IndustryRetrieveSicParams = ContextDev::Models::IndustryRetrieveSicParams

data/rbi/context_dev/resources/feedback.rbi

@@ -0,0 +1,42 @@
+# typed: strong
+
+module ContextDev
+  module Resources
+    # Report bugs, docs mismatches, and friction with any Context.dev API. Submissions
+    # cost no credits and use a separate rate limit.
+    class Feedback
+      # Report a problem with a Context.dev API call, docs page, SDK, or CLI. Include
+      # request_id, url, or both.
+      sig do
+        params(
+          category: ContextDev::FeedbackSubmitParams::Category::OrSymbol,
+          note: String,
+          request_id: String,
+          tags: T::Array[String],
+          url: String,
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(ContextDev::Models::FeedbackSubmitResponse)
+      end
+      def submit(
+        # Kind of issue.
+        category:,
+        # What went wrong and what you expected instead.
+        note:,
+        # The request_id of the API call the feedback is about, from its response body or
+        # X-Request-Id header.
+        request_id: nil,
+        # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+        tags: nil,
+        # The page the feedback is about, such as one page of a crawl or a docs page.
+        url: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: ContextDev::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/context_dev/resources/news.rbi

@@ -6,9 +6,10 @@ module ContextDev
     class News
       # Searches live and historical company news for one company, identified in
       # searchBy by name, domain, ticker (optionally disambiguated by exchange), or
-      # ISIN. Results can be filtered by publisher domain, publisher country, article
-      # language, article type, and published-at date, and include stable story IDs,
-      # source metadata, verified entity relevance, and cursor pagination.
+      # ISIN. Results can be filtered by one of publisher domain, publisher country,
+      # article language, or article type, optionally combined with a published-at date
+      # range, and include stable story IDs, source metadata, verified entity relevance,
+      # and cursor pagination.
       sig do
         params(
           search_by: ContextDev::NewsSearchParams::SearchBy::OrHash,
@@ -25,7 +26,9 @@ module ContextDev
         search_by:,
         # Opaque next_cursor from the previous response, or null for the first page.
         cursor: nil,
-        # Optional result filters.
+        # Optional result filters. Use at most one of sourceDomain, sourceCountry,
+        # articleLanguage, or articleType. A date range may accompany that category;
+        # date.from must not exceed date.to.
         filter_by: nil,
         # Maximum results to return. Defaults to 10.
         limit: nil,

data/rbi/context_dev/resources/web.rbi

@@ -201,20 +201,36 @@ module ContextDev
 
       # Reuse cached outputs independently and capture missing formats in one page
       # visit. Each cache key includes only the settings that affect that output. HTML
-      # is shared with Markdown and parsed fields. Cached outputs can come from
-      # different visits within maxAgeMs; use 0 for a fresh capture. HTML-only requests
-      # use the existing fast acquisition path. One credit per request, including cache
-      # hits, or two with browser actions; PDF OCR adds one credit per recovered page on
-      # fresh extraction. Original response bytes and screenshots are limited to 20 MiB
-      # each, screenshots to 40 megapixels, and the combined browser capture to 60 MiB.
+      # is shared with Markdown, parsed fields, product data, highlights, and JSON
+      # extraction. Cached outputs can come from different visits within maxAgeMs; use 0
+      # for a fresh capture. HTML-only requests use the existing fast acquisition path.
+      # Highlights return Markdown excerpts most relevant to highlightsParams.query.
+      # Requests with at least one successful output cost one base credit, including
+      # cache hits, or two with browser actions. All-failed responses are unbilled
+      # except missing pages, which retain the base price and the one-credit product
+      # charge when product was requested. Highlights add 3 credits when passages are
+      # returned. JSON extraction runs an LLM over nonempty page Markdown and adds four
+      # credits only when its result is returned successfully. PDF OCR adds one credit
+      # per recovered page on fresh extraction. Product adds one credit when its
+      # successful result is returned, plus six if that result used the specialized
+      # model. Original response bytes and screenshots are limited to 20 MiB each,
+      # screenshots to 40 megapixels, and the combined response to 60 MiB. An oversized
+      # output has success: false and data: null. If the combined response exceeds its
+      # limit, the largest outputs are marked failed until the remaining outputs fit.
+      # Valid captured pieces may still be cached when omitted to meet the response size
+      # limit.
       sig do
         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,
@@ -229,8 +245,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
@@ -240,6 +260,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
@@ -248,12 +270,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.

data/sig/context_dev/client.rbs

@@ -32,6 +32,8 @@ module ContextDev
 
     attr_reader logs: ContextDev::Resources::Logs
 
+    attr_reader feedback: ContextDev::Resources::Feedback
+
     private def auth_headers: -> ::Hash[String, String]
 
     def initialize: (

data/sig/context_dev/models/feedback_submit_params.rbs

@@ -0,0 +1,73 @@
+module ContextDev
+  module Models
+    type feedback_submit_params =
+      {
+        category: ContextDev::Models::FeedbackSubmitParams::category,
+        note: String,
+        request_id: String,
+        tags: ::Array[String],
+        url: String
+      }
+      & ContextDev::Internal::Type::request_parameters
+
+    class FeedbackSubmitParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      attr_accessor category: ContextDev::Models::FeedbackSubmitParams::category
+
+      attr_accessor note: String
+
+      attr_reader request_id: String?
+
+      def request_id=: (String) -> String
+
+      attr_reader tags: ::Array[String]?
+
+      def tags=: (::Array[String]) -> ::Array[String]
+
+      attr_reader url: String?
+
+      def url=: (String) -> String
+
+      def initialize: (
+        category: ContextDev::Models::FeedbackSubmitParams::category,
+        note: String,
+        ?request_id: String,
+        ?tags: ::Array[String],
+        ?url: String,
+        ?request_options: ContextDev::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        category: ContextDev::Models::FeedbackSubmitParams::category,
+        note: String,
+        request_id: String,
+        tags: ::Array[String],
+        url: String,
+        request_options: ContextDev::RequestOptions
+      }
+
+      type category =
+        :bug
+        | :docs_mismatch
+        | :friction
+        | :feature_gap
+        | :quality_degradation
+        | :other
+
+      module Category
+        extend ContextDev::Internal::Type::Enum
+
+        BUG: :bug
+        DOCS_MISMATCH: :docs_mismatch
+        FRICTION: :friction
+        FEATURE_GAP: :feature_gap
+        QUALITY_DEGRADATION: :quality_degradation
+        OTHER: :other
+
+        def self?.values: -> ::Array[ContextDev::Models::FeedbackSubmitParams::category]
+      end
+    end
+  end
+end

data/sig/context_dev/models/feedback_submit_response.rbs

@@ -0,0 +1,58 @@
+module ContextDev
+  module Models
+    type feedback_submit_response =
+      {
+        already_submitted: bool,
+        feedback_id: String,
+        request_id: String,
+        key_metadata: ContextDev::Models::FeedbackSubmitResponse::KeyMetadata
+      }
+
+    class FeedbackSubmitResponse < ContextDev::Internal::Type::BaseModel
+      attr_accessor already_submitted: bool
+
+      attr_accessor feedback_id: String
+
+      attr_accessor request_id: String
+
+      attr_reader key_metadata: ContextDev::Models::FeedbackSubmitResponse::KeyMetadata?
+
+      def key_metadata=: (
+        ContextDev::Models::FeedbackSubmitResponse::KeyMetadata
+      ) -> ContextDev::Models::FeedbackSubmitResponse::KeyMetadata
+
+      def initialize: (
+        already_submitted: bool,
+        feedback_id: String,
+        request_id: String,
+        ?key_metadata: ContextDev::Models::FeedbackSubmitResponse::KeyMetadata
+      ) -> void
+
+      def to_hash: -> {
+        already_submitted: bool,
+        feedback_id: String,
+        request_id: String,
+        key_metadata: ContextDev::Models::FeedbackSubmitResponse::KeyMetadata
+      }
+
+      type key_metadata =
+        { credits_consumed: Integer, credits_remaining: Integer }
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        attr_accessor credits_consumed: Integer
+
+        attr_accessor credits_remaining: Integer
+
+        def initialize: (
+          credits_consumed: Integer,
+          credits_remaining: Integer
+        ) -> void
+
+        def to_hash: -> {
+          credits_consumed: Integer,
+          credits_remaining: Integer
+        }
+      end
+    end
+  end
+end

data/sig/context_dev/models/web_scrape_params.rbs

@@ -4,10 +4,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: ::Array[String],
@@ -24,12 +27,24 @@ module ContextDev
 
       attr_accessor url: String
 
+      attr_reader highlights_params: ContextDev::WebScrapeParams::HighlightsParams?
+
+      def highlights_params=: (
+        ContextDev::WebScrapeParams::HighlightsParams
+      ) -> ContextDev::WebScrapeParams::HighlightsParams
+
       attr_reader image_params: ContextDev::WebScrapeParams::ImageParams?
 
       def image_params=: (
         ContextDev::WebScrapeParams::ImageParams
       ) -> ContextDev::WebScrapeParams::ImageParams
 
+      attr_reader json_params: ContextDev::WebScrapeParams::JsonParams?
+
+      def json_params=: (
+        ContextDev::WebScrapeParams::JsonParams
+      ) -> ContextDev::WebScrapeParams::JsonParams
+
       attr_reader markdown_params: ContextDev::WebScrapeParams::MarkdownParams?
 
       def markdown_params=: (
@@ -46,6 +61,12 @@ module ContextDev
         ContextDev::WebScrapeParams::ParseParams
       ) -> ContextDev::WebScrapeParams::ParseParams
 
+      attr_reader product_params: ContextDev::WebScrapeParams::ProductParams?
+
+      def product_params=: (
+        ContextDev::WebScrapeParams::ProductParams
+      ) -> ContextDev::WebScrapeParams::ProductParams
+
       attr_reader screenshot_params: ContextDev::WebScrapeParams::ScreenshotParams?
 
       def screenshot_params=: (
@@ -77,10 +98,13 @@ module ContextDev
       def initialize: (
         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: ::Array[String],
@@ -92,10 +116,13 @@ module ContextDev
       def to_hash: -> {
         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: ::Array[String],
@@ -107,10 +134,13 @@ module ContextDev
       type formats =
         {
           bytes: bool,
+          highlights: bool,
           html: bool,
           images: bool,
+          json: bool,
           markdown: bool,
           parse: bool,
+          product: bool,
           screenshot: bool
         }
 
@@ -119,6 +149,10 @@ module ContextDev
 
         def bytes=: (bool) -> bool
 
+        attr_reader highlights: bool?
+
+        def highlights=: (bool) -> bool
+
         attr_reader html: bool?
 
         def html=: (bool) -> bool
@@ -127,6 +161,10 @@ module ContextDev
 
         def images=: (bool) -> bool
 
+        attr_reader json: bool?
+
+        def json=: (bool) -> bool
+
         attr_reader markdown: bool?
 
         def markdown=: (bool) -> bool
@@ -135,29 +173,53 @@ module ContextDev
 
         def parse=: (bool) -> bool
 
+        attr_reader product: bool?
+
+        def product=: (bool) -> bool
+
         attr_reader screenshot: bool?
 
         def screenshot=: (bool) -> bool
 
         def initialize: (
           ?bytes: bool,
+          ?highlights: bool,
           ?html: bool,
           ?images: bool,
+          ?json: bool,
           ?markdown: bool,
           ?parse: bool,
+          ?product: bool,
           ?screenshot: bool
         ) -> void
 
         def to_hash: -> {
           bytes: bool,
+          highlights: bool,
           html: bool,
           images: bool,
+          json: bool,
           markdown: bool,
           parse: bool,
+          product: bool,
           screenshot: bool
         }
       end
 
+      type highlights_params = { query: String, max_characters: Integer }
+
+      class HighlightsParams < ContextDev::Internal::Type::BaseModel
+        attr_accessor query: String
+
+        attr_reader max_characters: Integer?
+
+        def max_characters=: (Integer) -> Integer
+
+        def initialize: (query: String, ?max_characters: Integer) -> void
+
+        def to_hash: -> { query: String, max_characters: Integer }
+      end
+
       type image_params =
         {
           dedupe: ContextDev::Models::WebScrapeParams::ImageParams::dedupe,
@@ -211,6 +273,23 @@ module ContextDev
         end
       end
 
+      type json_params = { schema: ::Hash[Symbol, top], instructions: String }
+
+      class JsonParams < ContextDev::Internal::Type::BaseModel
+        attr_accessor schema: ::Hash[Symbol, top]
+
+        attr_reader instructions: String?
+
+        def instructions=: (String) -> String
+
+        def initialize: (
+          schema: ::Hash[Symbol, top],
+          ?instructions: String
+        ) -> void
+
+        def to_hash: -> { schema: ::Hash[Symbol, top], instructions: String }
+      end
+
       type markdown_params =
         {
           include_images: bool,
@@ -340,6 +419,18 @@ module ContextDev
         end
       end
 
+      type product_params = { use_ai_fallback: bool }
+
+      class ProductParams < ContextDev::Internal::Type::BaseModel
+        attr_reader use_ai_fallback: bool?
+
+        def use_ai_fallback=: (bool) -> bool
+
+        def initialize: (?use_ai_fallback: bool) -> void
+
+        def to_hash: -> { use_ai_fallback: bool }
+      end
+
       type screenshot_params =
         {
           area: ContextDev::Models::WebScrapeParams::ScreenshotParams::area,