context.dev 2.20.0 → 2.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e77aec25d51b70c0df1a55ba12b10fad65b5366d49e720e6efefabf6c3a23711
-  data.tar.gz: '03190fde06fe98e9fb590ebbf09d0871f47cbfe824ea48158e0ee5b62aa36dd1'
+  metadata.gz: 00b5d7dcb52a04ff3be4b212cbf64f01fa8728ea160adebf5cedc9f2c98b1680
+  data.tar.gz: 492420d10233d6bce72fca4f6ee94a4600892cedaa4e833658c30776480da726
 SHA512:
-  metadata.gz: f037514e5a499f5632b49fcec6d219dbcf14950e58d0178861f9583ebf303e71ec7f8baac7db9934c4e74d49df45f3bd46f51a5235b51acc80dcb808b0e1a8d5
-  data.tar.gz: c44695655f09ef6b9d2aee15b39c7e1522e05f69d46b201aaaa1621d82001e16f25749976b9f1a8b662440bbb2cf24bfd598f6cac50b1d436bdf810d48b0d915
+  metadata.gz: 7327c49a078d92775d9446f89c314bf72ccdad01f510321a305238a4f151751e03135ce864a4bc78085605c1c6432edf1b5f311441940cff4b960b5834acf80b
+  data.tar.gz: c6496a4bc18352abf4d13cc52f321982c79d14ab1d0652eafa7e44be273ede98b2a1f2f1f9721f155b0cc540c9f38c6db16b6f2f5e1a94e9e82781ffb8330d9c

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [2.21.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.20.0...v2.21.0) (2026-09-27)
+
+
+### Features
+
+* **feedback:** add agent feedback endpoint ([#1322](https://github.com/context-dot-dev/context-ruby-sdk/issues/1322)) ([f3a9dce](https://github.com/context-dot-dev/context-ruby-sdk/commit/f3a9dce10e0f8a20977d0133e387fe20a9e11d18))
+* **highlights:** preserve Markdown structure in scrape excerpts ([#1236](https://github.com/context-dot-dev/context-ruby-sdk/issues/1236)) ([d3c383a](https://github.com/context-dot-dev/context-ruby-sdk/commit/d3c383a7ccfcea00a01c9c85955d62e871227ceb))
+* **scrape:** enable highlights with zero data retention ([#1246](https://github.com/context-dot-dev/context-ruby-sdk/issues/1246)) ([487a289](https://github.com/context-dot-dev/context-ruby-sdk/commit/487a2897d19d15d5164d0e69c2700f511b223216))
+
+
+### Bug Fixes
+
+* **openapi:** document exclusive news filters ([#1265](https://github.com/context-dot-dev/context-ruby-sdk/issues/1265)) ([5b7c79d](https://github.com/context-dot-dev/context-ruby-sdk/commit/5b7c79de83fd209760bfb5738670229024480206))
+* **scrape:** only flag partial success when a requested format succeeds ([#1325](https://github.com/context-dot-dev/context-ruby-sdk/issues/1325)) ([1120d93](https://github.com/context-dot-dev/context-ruby-sdk/commit/1120d9344525c6fc1ffb60403df75790ea6bbf1c))
+* **scrape:** preserve successful formats when other outputs fail ([#1263](https://github.com/context-dot-dev/context-ruby-sdk/issues/1263)) ([e2ccfa7](https://github.com/context-dot-dev/context-ruby-sdk/commit/e2ccfa7ea613221d3c6ad755aec93e01c58ca402))
+* **scrape:** retain highlight headings only when needed ([#1245](https://github.com/context-dot-dev/context-ruby-sdk/issues/1245)) ([492a305](https://github.com/context-dot-dev/context-ruby-sdk/commit/492a3058c77fd4d2edad2be9007c010e1745cfc9))
+
 ## [2.20.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.19.0...v2.20.0) (2026-09-23)
 
 

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "context.dev", "~> 2.20.0"
+gem "context.dev", "~> 2.21.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/context_dev/client.rb

@@ -59,6 +59,11 @@ module ContextDev
     # @return [ContextDev::Resources::Logs]
     attr_reader :logs
 
+    # Report bugs, docs mismatches, and friction with any Context.dev API. Submissions
+    # cost no credits and use a separate rate limit.
+    # @return [ContextDev::Resources::Feedback]
+    attr_reader :feedback
+
     # @api private
     #
     # @return [Hash{String=>String}]
@@ -131,6 +136,7 @@ module ContextDev
       @people = ContextDev::Resources::People.new(client: self)
       @news = ContextDev::Resources::News.new(client: self)
       @logs = ContextDev::Resources::Logs.new(client: self)
+      @feedback = ContextDev::Resources::Feedback.new(client: self)
     end
   end
 end

data/lib/context_dev/models/feedback_submit_params.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Feedback#submit
+    class FeedbackSubmitParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      # @!attribute category
+      #   Kind of issue.
+      #
+      #   @return [Symbol, ContextDev::Models::FeedbackSubmitParams::Category]
+      required :category, enum: -> { ContextDev::FeedbackSubmitParams::Category }
+
+      # @!attribute note
+      #   What went wrong and what you expected instead.
+      #
+      #   @return [String]
+      required :note, String
+
+      # @!attribute request_id
+      #   The request_id of the API call the feedback is about, from its response body or
+      #   X-Request-Id header.
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!attribute tags
+      #   Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      #
+      #   @return [Array<String>, nil]
+      optional :tags, ContextDev::Internal::Type::ArrayOf[String]
+
+      # @!attribute url
+      #   The page the feedback is about, such as one page of a crawl or a docs page.
+      #
+      #   @return [String, nil]
+      optional :url, String
+
+      # @!method initialize(category:, note:, request_id: nil, tags: nil, url: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::FeedbackSubmitParams} for more details.
+      #
+      #   @param category [Symbol, ContextDev::Models::FeedbackSubmitParams::Category] Kind of issue.
+      #
+      #   @param note [String] What went wrong and what you expected instead.
+      #
+      #   @param request_id [String] The request_id of the API call the feedback is about, from its response body or
+      #
+      #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      #
+      #   @param url [String] The page the feedback is about, such as one page of a crawl or a docs page.
+      #
+      #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+
+      # Kind of issue.
+      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
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/context_dev/models/feedback_submit_response.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::Feedback#submit
+    class FeedbackSubmitResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute already_submitted
+      #   True when feedback for this request_id was already recorded; the original
+      #   feedback_id is returned.
+      #
+      #   @return [Boolean]
+      required :already_submitted, ContextDev::Internal::Type::Boolean
+
+      # @!attribute feedback_id
+      #   ID of the stored feedback.
+      #
+      #   @return [String]
+      required :feedback_id, String
+
+      # @!attribute request_id
+      #   Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #   it when contacting support about a failed request.
+      #
+      #   @return [String]
+      required :request_id, String
+
+      # @!attribute key_metadata
+      #   Credit usage, included whenever a valid API key is provided.
+      #
+      #   @return [ContextDev::Models::FeedbackSubmitResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::FeedbackSubmitResponse::KeyMetadata }
+
+      # @!method initialize(already_submitted:, feedback_id:, request_id:, key_metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::FeedbackSubmitResponse} for more details.
+      #
+      #   @param already_submitted [Boolean] True when feedback for this request_id was already recorded; the original feedba
+      #
+      #   @param feedback_id [String] ID of the stored feedback.
+      #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
+      #   @param key_metadata [ContextDev::Models::FeedbackSubmitResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+
+      # @see ContextDev::Models::FeedbackSubmitResponse#key_metadata
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute credits_consumed
+        #   Credits used by this request.
+        #
+        #   @return [Integer]
+        required :credits_consumed, Integer
+
+        # @!attribute credits_remaining
+        #   Credits remaining for your organization.
+        #
+        #   @return [Integer]
+        required :credits_remaining, Integer
+
+        # @!method initialize(credits_consumed:, credits_remaining:)
+        #   Credit usage, included whenever a valid API key is provided.
+        #
+        #   @param credits_consumed [Integer] Credits used by this request.
+        #
+        #   @param credits_remaining [Integer] Credits remaining for your organization.
+      end
+    end
+  end
+end

data/lib/context_dev/models/news_search_params.rb

@@ -20,7 +20,9 @@ module ContextDev
       optional :cursor, String, nil?: true
 
       # @!attribute filter_by
-      #   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.
       #
       #   @return [ContextDev::Models::NewsSearchParams::FilterBy, nil]
       optional :filter_by, -> { ContextDev::NewsSearchParams::FilterBy }, api_name: :filterBy
@@ -44,11 +46,14 @@ module ContextDev
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
 
       # @!method initialize(search_by:, cursor: nil, filter_by: nil, limit: nil, sort_by: nil, tags: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::NewsSearchParams} for more details.
+      #
       #   @param search_by [ContextDev::Models::NewsSearchParams::SearchBy] What to search for.
       #
       #   @param cursor [String, nil] Opaque next_cursor from the previous response, or null for the first page.
       #
-      #   @param filter_by [ContextDev::Models::NewsSearchParams::FilterBy] Optional result filters.
+      #   @param filter_by [ContextDev::Models::NewsSearchParams::FilterBy] Optional result filters. Use at most one of sourceDomain, sourceCountry, article
       #
       #   @param limit [Integer] Maximum results to return. Defaults to 10.
       #
@@ -314,7 +319,7 @@ module ContextDev
                  api_name: :articleType
 
         # @!attribute date
-        #   Published-at window in epoch milliseconds.
+        #   Published-at window in epoch milliseconds. from must be before or equal to to.
         #
         #   @return [ContextDev::Models::NewsSearchParams::FilterBy::Date, nil]
         optional :date, -> { ContextDev::NewsSearchParams::FilterBy::Date }
@@ -336,13 +341,15 @@ module ContextDev
         optional :source_domain, ContextDev::Internal::Type::ArrayOf[String], api_name: :sourceDomain
 
         # @!method initialize(article_language: nil, article_type: nil, date: nil, source_country: nil, source_domain: 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.
         #
         #   @param article_language [Array<Symbol, ContextDev::Models::NewsSearchParams::FilterBy::ArticleLanguage>] Article languages to include. Up to 3.
         #
         #   @param article_type [Array<Symbol, ContextDev::Models::NewsSearchParams::FilterBy::ArticleType>] Article types to include. Up to 3.
         #
-        #   @param date [ContextDev::Models::NewsSearchParams::FilterBy::Date] Published-at window in epoch milliseconds.
+        #   @param date [ContextDev::Models::NewsSearchParams::FilterBy::Date] Published-at window in epoch milliseconds. from must be before or equal to to.
         #
         #   @param source_country [Array<Symbol, ContextDev::Models::NewsSearchParams::FilterBy::SourceCountry>] Publisher countries to include, as lowercase ISO 3166-1 alpha-2 codes. Up to 3.
         #
@@ -396,7 +403,7 @@ module ContextDev
           optional :to, Integer
 
           # @!method initialize(from: nil, to: nil)
-          #   Published-at window in epoch milliseconds.
+          #   Published-at window in epoch milliseconds. from must be before or equal to to.
           #
           #   @param from [Integer] Inclusive start of the published-at window, in epoch milliseconds.
           #

data/lib/context_dev/models/web_scrape_params.rb

@@ -89,20 +89,23 @@ 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
 
       # @!attribute zdr
       #   Zero data retention. Bypasses caches and uploads; excludes request/response
-      #   content and tags from logs. Must be enabled for your organization. Not available
-      #   with the highlights output.
+      #   content and tags from logs. Must be enabled for your organization.
       #
       #   @return [Symbol, ContextDev::Models::WebScrapeParams::Zdr, nil]
       optional :zdr, enum: -> { ContextDev::WebScrapeParams::Zdr }
@@ -149,9 +152,9 @@ module ContextDev
         optional :bytes, ContextDev::Internal::Type::Boolean
 
         # @!attribute highlights
-        #   Plain-text passages from the page that are most relevant to
-        #   highlightsParams.query, each prefixed with its section heading. Adds 3 credits.
-        #   Not available with zdr enabled.
+        #   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
@@ -169,10 +172,8 @@ module ContextDev
         optional :images, ContextDev::Internal::Type::Boolean
 
         # @!attribute json
-        #   Page data extracted by an LLM from the page Markdown into jsonParams.schema;
-        #   values carried only in attributes or CSS classes need formats.parse instead.
-        #   Adds four credits when the page has text to extract; when shared content filters
-        #   leave no text the result is an empty object and only the base price applies.
+        #   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
@@ -190,7 +191,8 @@ module ContextDev
         optional :parse, ContextDev::Internal::Type::Boolean
 
         # @!attribute product
-        #   Structured product data for product detail pages. Adds one credit.
+        #   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
@@ -209,19 +211,19 @@ module ContextDev
         #
         #   @param bytes [Boolean] The original HTTP response body.
         #
-        #   @param highlights [Boolean] Plain-text passages from the page that are most relevant to highlightsParams.que
+        #   @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 by an LLM from the page Markdown into jsonParams.schema; val
+        #   @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] Structured product data for product detail pages. Adds one credit.
+        #   @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
@@ -467,9 +469,10 @@ module ContextDev
       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 returns a verdict. If the fallback
-        #   fails, returns a partial response with the deterministic result and no fallback
-        #   charge. Request deadlines and client disconnects still apply.
+        #   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
@@ -989,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).
         #
@@ -1019,8 +1026,7 @@ module ContextDev
       end
 
       # Zero data retention. Bypasses caches and uploads; excludes request/response
-      # content and tags from logs. Must be enabled for your organization. Not available
-      # with the highlights output.
+      # content and tags from logs. Must be enabled for your organization.
       module Zdr
         extend ContextDev::Internal::Type::Enum