context.dev 2.21.0 → 2.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00b5d7dcb52a04ff3be4b212cbf64f01fa8728ea160adebf5cedc9f2c98b1680
-  data.tar.gz: 492420d10233d6bce72fca4f6ee94a4600892cedaa4e833658c30776480da726
+  metadata.gz: 7ccb5b760add7b469b5b7c31e28f5fbbeed36d43da665b4621200a7d4480a031
+  data.tar.gz: a12d36d177df270279744f67f3c5842fa9816e0f31c2928c8f8336098df00d67
 SHA512:
-  metadata.gz: 7327c49a078d92775d9446f89c314bf72ccdad01f510321a305238a4f151751e03135ce864a4bc78085605c1c6432edf1b5f311441940cff4b960b5834acf80b
-  data.tar.gz: c6496a4bc18352abf4d13cc52f321982c79d14ab1d0652eafa7e44be273ede98b2a1f2f1f9721f155b0cc540c9f38c6db16b6f2f5e1a94e9e82781ffb8330d9c
+  metadata.gz: e3540a099629f125ed338f5d9db1c07220915c28b1d2991fdf2f45db5785bbd107bcc98c773eed02f738753b58fcd5bde43f28b1da1ff02cc02459b9e9bf9098
+  data.tar.gz: 23ff10f563f2ea4862bd4aa410aaf22d87209d94135c66d33f781d0d249fc03fda088612b0becad5d38ec2653b4bf6307498e4bd4101be01060d67d70139ab32

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## [2.22.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.21.0...v2.22.0) (2026-09-29)
+
+
+### Features
+
+* **answers:** route people and company research with faster answers ([#1336](https://github.com/context-dot-dev/context-ruby-sdk/issues/1336)) ([a391639](https://github.com/context-dot-dev/context-ruby-sdk/commit/a391639719b983da237217d25c10a841168bfc3d))
+* **api:** explain failed scrape outputs and fix agent-reported bugs ([#1360](https://github.com/context-dot-dev/context-ruby-sdk/issues/1360)) ([ca8bb9c](https://github.com/context-dot-dev/context-ruby-sdk/commit/ca8bb9c07d4844beb966ac3516581f2b320f2229))
+* **monitors:** support browser actions on page monitors ([#1365](https://github.com/context-dot-dev/context-ruby-sdk/issues/1365)) ([f795df1](https://github.com/context-dot-dev/context-ruby-sdk/commit/f795df1b70558bf6f3918aeaf2828774d367b62f))
+* **scrape:** default cache age to three days and allow one year ([#1339](https://github.com/context-dot-dev/context-ruby-sdk/issues/1339)) ([57d1e7d](https://github.com/context-dot-dev/context-ruby-sdk/commit/57d1e7d65f1adba78550c90722ef8776004d74b4))
+* **search:** add highlights to web search and bill page reads per 10 results ([#1387](https://github.com/context-dot-dev/context-ruby-sdk/issues/1387)) ([d3e33c2](https://github.com/context-dot-dev/context-ruby-sdk/commit/d3e33c2ff01fb25075f0e09f0ae309bfd69bfcb9))
+* **web-search:** extend page cache defaults ([#1408](https://github.com/context-dot-dev/context-ruby-sdk/issues/1408)) ([62bd789](https://github.com/context-dot-dev/context-ruby-sdk/commit/62bd7898d985adc40ae772158bd50284914ff72c))
+
+
+### Bug Fixes
+
+* **api:** document search domain limits and clarify scrape parameter errors ([#1388](https://github.com/context-dot-dev/context-ruby-sdk/issues/1388)) ([5bfd7fb](https://github.com/context-dot-dev/context-ruby-sdk/commit/5bfd7fb18f0f44fafd56881d7e12e704bde51d54))
+* **scrape:** resolve extracted URLs from source references ([#1333](https://github.com/context-dot-dev/context-ruby-sdk/issues/1333)) ([b7799a5](https://github.com/context-dot-dev/context-ruby-sdk/commit/b7799a5c6a21376c84b01c695af4d2eaa9756392))
+
+
+### Documentation
+
+* **openapi:** complete concise API reference metadata ([#1329](https://github.com/context-dot-dev/context-ruby-sdk/issues/1329)) ([ea59edb](https://github.com/context-dot-dev/context-ruby-sdk/commit/ea59edbdea84a1169b050fb42336585166446249))
+* **scrape:** rename endpoint to Scrape Anything ([#1341](https://github.com/context-dot-dev/context-ruby-sdk/issues/1341)) ([ace5048](https://github.com/context-dot-dev/context-ruby-sdk/commit/ace5048aed8b62d3c2b4f3af2a3ae082adc2a682))
+
 ## [2.21.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.20.0...v2.21.0) (2026-09-27)
 
 

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.21.0"
+gem "context.dev", "~> 2.22.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/context_dev/client.rb

@@ -33,10 +33,7 @@ module ContextDev
     # @return [ContextDev::Resources::Utility]
     attr_reader :utility
 
-    # Monitor pages, sitemaps, and extracted website data for exact or semantic
-    # changes. Webhook payloads are documented by the
-    # MonitorsChangeDetectedWebhookPayload and MonitorsRunCompletedWebhookPayload
-    # schemas.
+    # Watch websites for exact or meaningful changes.
     # @return [ContextDev::Resources::Monitors]
     attr_reader :monitors
 
@@ -50,17 +47,15 @@ module ContextDev
     # @return [ContextDev::Resources::People]
     attr_reader :people
 
-    # Search live first-party RSS and free historical news data by company identity.
+    # Search live and historical news about a company.
     # @return [ContextDev::Resources::News]
     attr_reader :news
 
-    # Read your organization's API request logs to debug failed calls. These endpoints
-    # cost no credits and use a separate rate limit.
+    # Read your organization's API request logs.
     # @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.
+    # Report API issues and documentation mismatches.
     # @return [ContextDev::Resources::Feedback]
     attr_reader :feedback
 

data/lib/context_dev/models/batch_cancel_params.rb

@@ -8,13 +8,13 @@ module ContextDev
       include ContextDev::Internal::Type::RequestParameters
 
       # @!attribute batch_id
-      #   ID of the batch to retrieve or cancel.
+      #   Batch ID.
       #
       #   @return [String]
       required :batch_id, String
 
       # @!method initialize(batch_id:, request_options: {})
-      #   @param batch_id [String] ID of the batch to retrieve or cancel.
+      #   @param batch_id [String] Batch ID.
       #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/context_dev/models/batch_cancel_response.rb

@@ -11,8 +11,7 @@ module ContextDev
       required :id, String
 
       # @!attribute crawl
-      #   The crawl controls as submitted, so the limits requested can be compared against
-      #   what the crawl reached.
+      #   Crawl settings as submitted.
       #
       #   @return [ContextDev::Models::CrawlControls, nil]
       required :crawl, -> { ContextDev::CrawlControls }, nil?: true
@@ -30,7 +29,7 @@ module ContextDev
       required :format_, enum: -> { ContextDev::Models::BatchCancelResponse::Format }, api_name: :format
 
       # @!attribute input
-      #   What submission took in, and what it charged for.
+      #   What the submission accepted.
       #
       #   @return [ContextDev::Models::Intake]
       required :input, -> { ContextDev::Intake }
@@ -54,8 +53,8 @@ module ContextDev
       required :progress, -> { ContextDev::Models::BatchCancelResponse::Progress }
 
       # @!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.
+      #   Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+      #   support.
       #
       #   @return [String]
       required :request_id, String
@@ -74,7 +73,7 @@ module ContextDev
       required :tags, ContextDev::Internal::Type::ArrayOf[String]
 
       # @!attribute timing
-      #   There is no finish time yet — the batch is still winding down.
+      #   Batch timestamps.
       #
       #   @return [ContextDev::Models::BatchCancelResponse::Timing]
       required :timing, -> { ContextDev::Models::BatchCancelResponse::Timing }
@@ -91,13 +90,13 @@ module ContextDev
       #
       #   @param id [String] Batch ID.
       #
-      #   @param crawl [ContextDev::Models::CrawlControls, nil] The crawl controls as submitted, so the limits requested can be compared against
+      #   @param crawl [ContextDev::Models::CrawlControls, nil] Crawl settings as submitted.
       #
       #   @param credits [ContextDev::Models::BatchCancelResponse::Credits] What this batch cost so far.
       #
       #   @param format_ [Symbol, ContextDev::Models::BatchCancelResponse::Format] What each page is returned as.
       #
-      #   @param input [ContextDev::Models::Intake] What submission took in, and what it charged for.
+      #   @param input [ContextDev::Models::Intake] What the submission accepted.
       #
       #   @param mode [Symbol, ContextDev::Models::BatchCancelResponse::Mode] How pages were selected.
       #
@@ -105,32 +104,28 @@ module ContextDev
       #
       #   @param progress [ContextDev::Models::BatchCancelResponse::Progress] How far the batch got before cancellation.
       #
-      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #   @param request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
       #
       #   @param status [Symbol, ContextDev::Models::BatchCancelResponse::Status] Always `cancelling`. Work already in flight finishes; the batch reaches `cancell
       #
       #   @param tags [Array<String>] Tags stored on the batch at submission.
       #
-      #   @param timing [ContextDev::Models::BatchCancelResponse::Timing] There is no finish time yet — the batch is still winding down.
+      #   @param timing [ContextDev::Models::BatchCancelResponse::Timing] Batch timestamps.
       #
       #   @param key_metadata [ContextDev::Models::BatchCancelResponse::KeyMetadata] API key usage for this request.
 
       # @see ContextDev::Models::BatchCancelResponse#credits
       class Credits < ContextDev::Internal::Type::BaseModel
         # @!attribute reserved
-        #   Credits debited at submission. The unspent remainder is refunded once the batch
-        #   settles — read `credits.refunded` from GET /batch/{batch_id} then.
+        #   Credits held at submission; unused credits are refunded when the batch settles.
         #
         #   @return [Integer]
         required :reserved, Integer
 
         # @!method initialize(reserved:)
-        #   Some parameter documentations has been truncated, see
-        #   {ContextDev::Models::BatchCancelResponse::Credits} for more details.
-        #
         #   What this batch cost so far.
         #
-        #   @param reserved [Integer] Credits debited at submission. The unspent remainder is refunded once the batch
+        #   @param reserved [Integer] Credits held at submission; unused credits are refunded when the batch settles.
       end
 
       # What each page is returned as.
@@ -168,7 +163,7 @@ module ContextDev
         required :failed, Integer
 
         # @!attribute pending
-        #   Reserved pages that will now be skipped, and refunded when the batch settles.
+        #   Pages that will be skipped.
         #
         #   @return [Integer]
         required :pending, Integer
@@ -184,7 +179,7 @@ module ContextDev
         #
         #   @param failed [Integer] Pages that could not be scraped before the request landed.
         #
-        #   @param pending [Integer] Reserved pages that will now be skipped, and refunded when the batch settles.
+        #   @param pending [Integer] Pages that will be skipped.
         #
         #   @param succeeded [Integer] Pages scraped successfully before the request landed.
       end
@@ -217,7 +212,7 @@ module ContextDev
         required :started_at, String, nil?: true
 
         # @!method initialize(created_at:, started_at:)
-        #   There is no finish time yet — the batch is still winding down.
+        #   Batch timestamps.
         #
         #   @param created_at [String] When the batch was created.
         #
@@ -227,7 +222,7 @@ module ContextDev
       # @see ContextDev::Models::BatchCancelResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   Credits used by this request.
+        #   Credits charged for this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
@@ -241,7 +236,7 @@ module ContextDev
         # @!method initialize(credits_consumed:, credits_remaining:)
         #   API key usage for this request.
         #
-        #   @param credits_consumed [Integer] Credits used by this request.
+        #   @param credits_consumed [Integer] Credits charged for this request.
         #
         #   @param credits_remaining [Integer] Credits remaining for your organization.
       end

data/lib/context_dev/models/batch_delete_params.rb

@@ -8,13 +8,13 @@ module ContextDev
       include ContextDev::Internal::Type::RequestParameters
 
       # @!attribute batch_id
-      #   ID of the batch to retrieve or cancel.
+      #   Batch ID.
       #
       #   @return [String]
       required :batch_id, String
 
       # @!method initialize(batch_id:, request_options: {})
-      #   @param batch_id [String] ID of the batch to retrieve or cancel.
+      #   @param batch_id [String] Batch ID.
       #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/context_dev/models/batch_delete_response.rb

@@ -5,8 +5,8 @@ module ContextDev
     # @see ContextDev::Resources::Batch#delete
     class BatchDeleteResponse < ContextDev::Internal::Type::BaseModel
       # @!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.
+      #   Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+      #   support.
       #
       #   @return [String]
       required :request_id, String
@@ -24,7 +24,7 @@ module ContextDev
       optional :deleted, ContextDev::Internal::Type::Boolean
 
       # @!attribute key_metadata
-      #   Credit usage, included whenever a valid API key is provided.
+      #   Credits this request used and your remaining balance.
       #
       #   @return [ContextDev::Models::BatchDeleteResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::BatchDeleteResponse::KeyMetadata }
@@ -33,18 +33,18 @@ module ContextDev
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BatchDeleteResponse} for more details.
       #
-      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #   @param request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
       #
       #   @param id [String] ID of the deleted batch.
       #
       #   @param deleted [Boolean] Always true on success.
       #
-      #   @param key_metadata [ContextDev::Models::BatchDeleteResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+      #   @param key_metadata [ContextDev::Models::BatchDeleteResponse::KeyMetadata] Credits this request used and your remaining balance.
 
       # @see ContextDev::Models::BatchDeleteResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   Credits used by this request.
+        #   Credits charged for this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
@@ -56,9 +56,9 @@ module ContextDev
         required :credits_remaining, Integer
 
         # @!method initialize(credits_consumed:, credits_remaining:)
-        #   Credit usage, included whenever a valid API key is provided.
+        #   Credits this request used and your remaining balance.
         #
-        #   @param credits_consumed [Integer] Credits used by this request.
+        #   @param credits_consumed [Integer] Credits charged for this request.
         #
         #   @param credits_remaining [Integer] Credits remaining for your organization.
       end

data/lib/context_dev/models/batch_get_results_params.rb

@@ -8,7 +8,7 @@ module ContextDev
       include ContextDev::Internal::Type::RequestParameters
 
       # @!attribute batch_id
-      #   ID of the batch to retrieve or cancel.
+      #   Batch ID.
       #
       #   @return [String]
       required :batch_id, String
@@ -30,7 +30,7 @@ module ContextDev
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BatchGetResultsParams} for more details.
       #
-      #   @param batch_id [String] ID of the batch to retrieve or cancel.
+      #   @param batch_id [String] Batch ID.
       #
       #   @param cursor [String] next_cursor from the previous page.
       #

data/lib/context_dev/models/batch_get_results_response.rb

@@ -5,8 +5,8 @@ module ContextDev
     # @see ContextDev::Resources::Batch#get_results
     class BatchGetResultsResponse < ContextDev::Internal::Type::BaseModel
       # @!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.
+      #   Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+      #   support.
       #
       #   @return [String]
       required :request_id, String
@@ -25,7 +25,7 @@ module ContextDev
       optional :has_more, ContextDev::Internal::Type::Boolean
 
       # @!attribute key_metadata
-      #   Credit usage, included whenever a valid API key is provided.
+      #   Credits this request used and your remaining balance.
       #
       #   @return [ContextDev::Models::BatchGetResultsResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::BatchGetResultsResponse::KeyMetadata }
@@ -40,13 +40,13 @@ module ContextDev
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BatchGetResultsResponse} for more details.
       #
-      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #   @param request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
       #
       #   @param data [Array<ContextDev::Models::BatchGetResultsResponse::Data::Ok, ContextDev::Models::BatchGetResultsResponse::Data::Error>] Result records on this page.
       #
       #   @param has_more [Boolean] Whether another page is available.
       #
-      #   @param key_metadata [ContextDev::Models::BatchGetResultsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+      #   @param key_metadata [ContextDev::Models::BatchGetResultsResponse::KeyMetadata] Credits this request used and your remaining balance.
       #
       #   @param next_cursor [String, nil] Cursor for the next page.
 
@@ -64,9 +64,7 @@ module ContextDev
 
         class Ok < ContextDev::Internal::Type::BaseModel
           # @!attribute cache_metadata
-          #   Cache outcome for this response. Composite responses are hits only when every
-          #   cache-controlled fetch contributing to the output was a hit; age_ms is the
-          #   oldest contributing hit.
+          #   Whether this response came from cache.
           #
           #   @return [ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata]
           required :cache_metadata, -> { ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata }
@@ -109,7 +107,7 @@ module ContextDev
           optional :html, String
 
           # @!attribute item_id
-          #   Caller-supplied identifier echoed from submission.
+          #   Your `itemId` from submission.
           #
           #   @return [String, nil]
           optional :item_id, String, api_name: :itemId
@@ -127,8 +125,7 @@ module ContextDev
           optional :meta, ContextDev::Internal::Type::HashOf[ContextDev::Internal::Type::Unknown]
 
           # @!attribute ocr_pages
-          #   PDF pages of this document recovered by OCR (pdf.ocr=true). Each recovered page
-          #   bills 1 credit on top of the page base credit; absent when no OCR ran.
+          #   Number of PDF pages recovered by OCR. Omitted when OCR did not run.
           #
           #   @return [Integer, nil]
           optional :ocr_pages, Integer
@@ -139,7 +136,7 @@ module ContextDev
           #
           #   A page the batch fetched successfully.
           #
-          #   @param cache_metadata [ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
+          #   @param cache_metadata [ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata] Whether this response came from cache.
           #
           #   @param final_url [String] URL the content was read from, after redirects.
           #
@@ -151,13 +148,13 @@ module ContextDev
           #
           #   @param html [String] Page HTML. Present on html batches, and on markdown batches submitted with `opti
           #
-          #   @param item_id [String] Caller-supplied identifier echoed from submission.
+          #   @param item_id [String] Your `itemId` from submission.
           #
           #   @param markdown [String] Page content as Markdown. Present on markdown batches.
           #
           #   @param meta [Hash{Symbol=>Object}] Caller-supplied metadata echoed from submission.
           #
-          #   @param ocr_pages [Integer] PDF pages of this document recovered by OCR (pdf.ocr=true). Each recovered page
+          #   @param ocr_pages [Integer] Number of PDF pages recovered by OCR. Omitted when OCR did not run.
           #
           #   @param status [Symbol, :ok] The page was scraped.
 
@@ -182,9 +179,7 @@ module ContextDev
             #   {ContextDev::Models::BatchGetResultsResponse::Data::Ok::CacheMetadata} for more
             #   details.
             #
-            #   Cache outcome for this response. Composite responses are hits only when every
-            #   cache-controlled fetch contributing to the output was a hit; age_ms is the
-            #   oldest contributing hit.
+            #   Whether this response came from cache.
             #
             #   @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
             #
@@ -510,7 +505,7 @@ module ContextDev
           required :url, String
 
           # @!attribute item_id
-          #   Caller-supplied identifier echoed from submission.
+          #   Your `itemId` from submission.
           #
           #   @return [String, nil]
           optional :item_id, String, api_name: :itemId
@@ -530,7 +525,7 @@ module ContextDev
           #
           #   @param url [String] URL as submitted, or as discovered by the crawl.
           #
-          #   @param item_id [String] Caller-supplied identifier echoed from submission.
+          #   @param item_id [String] Your `itemId` from submission.
           #
           #   @param meta [Hash{Symbol=>Object}] Caller-supplied metadata echoed from submission.
           #
@@ -544,7 +539,7 @@ module ContextDev
       # @see ContextDev::Models::BatchGetResultsResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   Credits used by this request.
+        #   Credits charged for this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
@@ -556,9 +551,9 @@ module ContextDev
         required :credits_remaining, Integer
 
         # @!method initialize(credits_consumed:, credits_remaining:)
-        #   Credit usage, included whenever a valid API key is provided.
+        #   Credits this request used and your remaining balance.
         #
-        #   @param credits_consumed [Integer] Credits used by this request.
+        #   @param credits_consumed [Integer] Credits charged for this request.
         #
         #   @param credits_remaining [Integer] Credits remaining for your organization.
       end