context.dev 2.16.0 → 2.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f386d4f27c72c64c88946d5e8dbc98bb1cd4f5de22f6400219eb7996954c68df
-  data.tar.gz: 062cb685ad8d8469e9e4f81e42d809533d98b0b68c009c57b285a77578023fdb
+  metadata.gz: 18b47383d0fc922af7bc818a48819c4d702950b89c51f28b6e373b3b6468108b
+  data.tar.gz: e0f57cfa02d05a6b3d6b24956798e52fe21841280ac164b7c53d8980b246ec37
 SHA512:
-  metadata.gz: ec3879167f8c90f9c79ea728be1f927ff23c089ca6103255c7ea64294adfa117a616e9a83f72439a72ee710ca2fa0b66a8fa44e5eac649ceda206f04bb324cd4
-  data.tar.gz: 2a2945c6da42e4ec238ecbb23dec1803bf65b2c857c864152e6919c66d35b981aa5b6696848d29b0d541e1810bec79ab19a7462a4ef6c58e70df5c4f9d355f42
+  metadata.gz: 50a79881ad62bece93534a540bd06b18e3618687b81c8f817d95929339769766d7260da3bdb7409be4d42957c5d57818dceafc07fa3495b510d8dfde70af014a
+  data.tar.gz: 6a22ac07b5bebf800443f990c556f1864a41872f5ca08381716702b1cd61a470d22da90a4350dc745e357a1c21959f13bc156d585984ae0b4d7d98124d34cc06

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## [2.17.1](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.17.0...v2.17.1) (2026-09-15)
+
+
+### Bug Fixes
+
+* **api:** guarantee search descriptions and align response types ([#1089](https://github.com/context-dot-dev/context-ruby-sdk/issues/1089)) ([7ee03fc](https://github.com/context-dot-dev/context-ruby-sdk/commit/7ee03fc233d3e975f01fd3d290defb48a6e6ad56))
+
+## [2.17.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.16.0...v2.17.0) (2026-09-15)
+
+
+### Features
+
+* **answers:** add live web research with fast and ultra modes ([#954](https://github.com/context-dot-dev/context-ruby-sdk/issues/954)) ([838e943](https://github.com/context-dot-dev/context-ruby-sdk/commit/838e943b1fe34aeaf6f804ff534c22f62b4900fe))
+* **api-keys:** enforce scoped API key permissions ([#1038](https://github.com/context-dot-dev/context-ruby-sdk/issues/1038)) ([7f87431](https://github.com/context-dot-dev/context-ruby-sdk/commit/7f874312c42b5c12020d71251f8bfc6eaa8ab2aa))
+* **api:** unify timeout configuration and return partial results ([#1030](https://github.com/context-dot-dev/context-ruby-sdk/issues/1030)) ([7c0fa1f](https://github.com/context-dot-dev/context-ruby-sdk/commit/7c0fa1f308fc51885405c065aef2fd4ab8fe5725))
+* **monitors:** add page selector filters ([#1037](https://github.com/context-dot-dev/context-ruby-sdk/issues/1037)) ([1f3a748](https://github.com/context-dot-dev/context-ruby-sdk/commit/1f3a74858133f69ea52c3a189f9ed8c80b80c0c6))
+* **web:** add raw bytes scraping endpoint ([#1081](https://github.com/context-dot-dev/context-ruby-sdk/issues/1081)) ([e4b2347](https://github.com/context-dot-dev/context-ruby-sdk/commit/e4b23477deab52f1822eb2e3e2bbbca6b9cf9c07))
+
+
+### Bug Fixes
+
+* **api:** honour maxAgeMs=0 on brand retrieve, styleguide and fonts endpoints ([#998](https://github.com/context-dot-dev/context-ruby-sdk/issues/998)) ([78491ef](https://github.com/context-dot-dev/context-ruby-sdk/commit/78491ef8e43ab49074d011ce8c10e3cda5cb27db))
+* **webhooks:** format Slack webhook notifications ([#1045](https://github.com/context-dot-dev/context-ruby-sdk/issues/1045)) ([4bd0df1](https://github.com/context-dot-dev/context-ruby-sdk/commit/4bd0df1c614713a46e366ca1320942fa777452fc))
+
 ## [2.16.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.15.0...v2.16.0) (2026-09-11)
 
 

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

data/lib/context_dev/models/ai_extract_product_params.rb

@@ -27,15 +27,15 @@ module ContextDev
       #   @return [Array<String>, nil]
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
 
-      # @!attribute timeout_ms
-      #   Optional timeout in milliseconds for the request. If the request takes longer
-      #   than this value, it will be aborted with a 408 status code. Maximum allowed
-      #   value is 300000ms (5 minutes).
+      # @!attribute timeout_opts
+      #   Optional request deadline and behavior on timeout. For GET requests, use
+      #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+      #   timeoutOpts object.
       #
-      #   @return [Integer, nil]
-      optional :timeout_ms, Integer, api_name: :timeoutMS
+      #   @return [ContextDev::Models::AIExtractProductParams::TimeoutOpts, nil]
+      optional :timeout_opts, -> { ContextDev::AIExtractProductParams::TimeoutOpts }, api_name: :timeoutOpts
 
-      # @!method initialize(url:, max_age_ms: nil, tags: nil, timeout_ms: nil, request_options: {})
+      # @!method initialize(url:, max_age_ms: nil, tags: nil, timeout_opts: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::AIExtractProductParams} for more details.
       #
@@ -45,9 +45,54 @@ module ContextDev
       #
       #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
       #
-      #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #   @param timeout_opts [ContextDev::Models::AIExtractProductParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        # @!attribute milliseconds
+        #   Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #
+        #   @return [Integer]
+        required :milliseconds, Integer
+
+        # @!attribute behavior
+        #   What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+        #   credits. "return-partial" returns usable results collected so far; if none are
+        #   available, the request still fails without charging credits. Partial results are
+        #   not cached as complete results.
+        #
+        #   @return [Symbol, ContextDev::Models::AIExtractProductParams::TimeoutOpts::Behavior, nil]
+        optional :behavior, enum: -> { ContextDev::AIExtractProductParams::TimeoutOpts::Behavior }
+
+        # @!method initialize(milliseconds:, behavior: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::AIExtractProductParams::TimeoutOpts} for more details.
+        #
+        #   Optional request deadline and behavior on timeout. For GET requests, use
+        #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+        #   timeoutOpts object.
+        #
+        #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #
+        #   @param behavior [Symbol, ContextDev::Models::AIExtractProductParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+
+        # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+        # credits. "return-partial" returns usable results collected so far; if none are
+        # available, the request still fails without charging credits. Partial results are
+        # not cached as complete results.
+        #
+        # @see ContextDev::Models::AIExtractProductParams::TimeoutOpts#behavior
+        module Behavior
+          extend ContextDev::Internal::Type::Enum
+
+          FAIL = :fail
+          RETURN_PARTIAL = :"return-partial"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
     end
   end
 end

data/lib/context_dev/models/ai_extract_product_response.rb

@@ -31,6 +31,13 @@ module ContextDev
       #   @return [ContextDev::Models::AIExtractProductResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::AIExtractProductResponse::KeyMetadata }
 
+      # @!attribute partial
+      #   True when the timeout ended processing and this response contains only usable
+      #   results completed so far. Unfinished results are omitted.
+      #
+      #   @return [Boolean, nil]
+      optional :partial, ContextDev::Internal::Type::Boolean
+
       # @!attribute platform
       #   The detected ecommerce platform, or null if not a product page
       #
@@ -43,7 +50,7 @@ module ContextDev
       #   @return [ContextDev::Models::AIExtractProductResponse::Product, nil]
       optional :product, -> { ContextDev::Models::AIExtractProductResponse::Product }, nil?: true
 
-      # @!method initialize(cache_metadata:, request_id:, is_product_page: nil, key_metadata: nil, platform: nil, product: nil)
+      # @!method initialize(cache_metadata:, request_id:, is_product_page: nil, key_metadata: nil, partial: nil, platform: nil, product: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::AIExtractProductResponse} for more details.
       #
@@ -55,6 +62,8 @@ module ContextDev
       #
       #   @param key_metadata [ContextDev::Models::AIExtractProductResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
       #
+      #   @param partial [Boolean] True when the timeout ended processing and this response contains only usable re
+      #
       #   @param platform [Symbol, ContextDev::Models::AIExtractProductResponse::Platform, nil] The detected ecommerce platform, or null if not a product page
       #
       #   @param product [ContextDev::Models::AIExtractProductResponse::Product, nil] The extracted product data, or null if not a product page

data/lib/context_dev/models/ai_extract_products_params.rb

@@ -50,15 +50,17 @@ module ContextDev
           #   @return [Array<String>, nil]
           optional :tags, ContextDev::Internal::Type::ArrayOf[String]
 
-          # @!attribute timeout_ms
-          #   Optional timeout in milliseconds for the request. If the request takes longer
-          #   than this value, it will be aborted with a 408 status code. Maximum allowed
-          #   value is 300000ms (5 minutes).
+          # @!attribute timeout_opts
+          #   Optional request deadline and behavior on timeout. For GET requests, use
+          #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+          #   timeoutOpts object.
           #
-          #   @return [Integer, nil]
-          optional :timeout_ms, Integer, api_name: :timeoutMS
+          #   @return [ContextDev::Models::AIExtractProductsParams::Body::ByDomain::TimeoutOpts, nil]
+          optional :timeout_opts,
+                   -> { ContextDev::AIExtractProductsParams::Body::ByDomain::TimeoutOpts },
+                   api_name: :timeoutOpts
 
-          # @!method initialize(domain:, max_age_ms: nil, max_products: nil, tags: nil, timeout_ms: nil)
+          # @!method initialize(domain:, max_age_ms: nil, max_products: nil, tags: nil, timeout_opts: nil)
           #   Some parameter documentations has been truncated, see
           #   {ContextDev::Models::AIExtractProductsParams::Body::ByDomain} for more details.
           #
@@ -70,7 +72,55 @@ module ContextDev
           #
           #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
           #
-          #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+          #   @param timeout_opts [ContextDev::Models::AIExtractProductsParams::Body::ByDomain::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
+
+          # @see ContextDev::Models::AIExtractProductsParams::Body::ByDomain#timeout_opts
+          class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+            # @!attribute milliseconds
+            #   Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+            #
+            #   @return [Integer]
+            required :milliseconds, Integer
+
+            # @!attribute behavior
+            #   What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+            #   credits. "return-partial" returns usable results collected so far; if none are
+            #   available, the request still fails without charging credits. Partial results are
+            #   not cached as complete results.
+            #
+            #   @return [Symbol, ContextDev::Models::AIExtractProductsParams::Body::ByDomain::TimeoutOpts::Behavior, nil]
+            optional :behavior,
+                     enum: -> { ContextDev::AIExtractProductsParams::Body::ByDomain::TimeoutOpts::Behavior }
+
+            # @!method initialize(milliseconds:, behavior: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {ContextDev::Models::AIExtractProductsParams::Body::ByDomain::TimeoutOpts} for
+            #   more details.
+            #
+            #   Optional request deadline and behavior on timeout. For GET requests, use
+            #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+            #   timeoutOpts object.
+            #
+            #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+            #
+            #   @param behavior [Symbol, ContextDev::Models::AIExtractProductsParams::Body::ByDomain::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+
+            # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+            # credits. "return-partial" returns usable results collected so far; if none are
+            # available, the request still fails without charging credits. Partial results are
+            # not cached as complete results.
+            #
+            # @see ContextDev::Models::AIExtractProductsParams::Body::ByDomain::TimeoutOpts#behavior
+            module Behavior
+              extend ContextDev::Internal::Type::Enum
+
+              FAIL = :fail
+              RETURN_PARTIAL = :"return-partial"
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
         end
 
         class ByDirectURL < ContextDev::Internal::Type::BaseModel
@@ -101,15 +151,17 @@ module ContextDev
           #   @return [Array<String>, nil]
           optional :tags, ContextDev::Internal::Type::ArrayOf[String]
 
-          # @!attribute timeout_ms
-          #   Optional timeout in milliseconds for the request. If the request takes longer
-          #   than this value, it will be aborted with a 408 status code. Maximum allowed
-          #   value is 300000ms (5 minutes).
+          # @!attribute timeout_opts
+          #   Optional request deadline and behavior on timeout. For GET requests, use
+          #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+          #   timeoutOpts object.
           #
-          #   @return [Integer, nil]
-          optional :timeout_ms, Integer, api_name: :timeoutMS
+          #   @return [ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts, nil]
+          optional :timeout_opts,
+                   -> { ContextDev::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts },
+                   api_name: :timeoutOpts
 
-          # @!method initialize(direct_url:, max_age_ms: nil, max_products: nil, tags: nil, timeout_ms: nil)
+          # @!method initialize(direct_url:, max_age_ms: nil, max_products: nil, tags: nil, timeout_opts: nil)
           #   Some parameter documentations has been truncated, see
           #   {ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL} for more
           #   details.
@@ -122,7 +174,55 @@ module ContextDev
           #
           #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
           #
-          #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+          #   @param timeout_opts [ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
+
+          # @see ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL#timeout_opts
+          class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+            # @!attribute milliseconds
+            #   Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+            #
+            #   @return [Integer]
+            required :milliseconds, Integer
+
+            # @!attribute behavior
+            #   What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+            #   credits. "return-partial" returns usable results collected so far; if none are
+            #   available, the request still fails without charging credits. Partial results are
+            #   not cached as complete results.
+            #
+            #   @return [Symbol, ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts::Behavior, nil]
+            optional :behavior,
+                     enum: -> { ContextDev::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts::Behavior }
+
+            # @!method initialize(milliseconds:, behavior: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts}
+            #   for more details.
+            #
+            #   Optional request deadline and behavior on timeout. For GET requests, use
+            #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+            #   timeoutOpts object.
+            #
+            #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+            #
+            #   @param behavior [Symbol, ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+
+            # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+            # credits. "return-partial" returns usable results collected so far; if none are
+            # available, the request still fails without charging credits. Partial results are
+            # not cached as complete results.
+            #
+            # @see ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts#behavior
+            module Behavior
+              extend ContextDev::Internal::Type::Enum
+
+              FAIL = :fail
+              RETURN_PARTIAL = :"return-partial"
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
         end
 
         # @!method self.variants

data/lib/context_dev/models/ai_extract_products_response.rb

@@ -25,6 +25,14 @@ module ContextDev
       #   @return [ContextDev::Models::AIExtractProductsResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::AIExtractProductsResponse::KeyMetadata }
 
+      # @!attribute partial
+      #   True when timeoutOpts.behavior=return-partial returned the usable results
+      #   collected before the deadline. Partial collections are not cached as complete
+      #   results.
+      #
+      #   @return [Boolean, nil]
+      optional :partial, ContextDev::Internal::Type::Boolean
+
       # @!attribute products
       #   Array of products extracted from the website
       #
@@ -32,7 +40,7 @@ module ContextDev
       optional :products,
                -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::AIExtractProductsResponse::Product] }
 
-      # @!method initialize(cache_metadata:, request_id:, key_metadata: nil, products: nil)
+      # @!method initialize(cache_metadata:, request_id:, key_metadata: nil, partial: nil, products: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::AIExtractProductsResponse} for more details.
       #
@@ -42,6 +50,8 @@ module ContextDev
       #
       #   @param key_metadata [ContextDev::Models::AIExtractProductsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
       #
+      #   @param partial [Boolean] True when timeoutOpts.behavior=return-partial returned the usable results collec
+      #
       #   @param products [Array<ContextDev::Models::AIExtractProductsResponse::Product>] Array of products extracted from the website
 
       # @see ContextDev::Models::AIExtractProductsResponse#cache_metadata