context.dev 2.15.0 → 2.17.0

data/rbi/context_dev/models/ai_extract_product_response.rbi

@@ -27,6 +27,11 @@ module ContextDev
       end
       attr_writer :cache_metadata
 
+      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      # it when contacting support about a failed request.
+      sig { returns(String) }
+      attr_accessor :request_id
+
       # Whether the given URL is a product detail page
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :is_product_page
@@ -50,6 +55,14 @@ module ContextDev
       end
       attr_writer :key_metadata
 
+      # True when the timeout ended processing and this response contains only usable
+      # results completed so far. Unfinished results are omitted.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :partial
+
+      sig { params(partial: T::Boolean).void }
+      attr_writer :partial
+
       # The detected ecommerce platform, or null if not a product page
       sig do
         returns(
@@ -82,9 +95,11 @@ module ContextDev
         params(
           cache_metadata:
             ContextDev::Models::AIExtractProductResponse::CacheMetadata::OrHash,
+          request_id: String,
           is_product_page: T::Boolean,
           key_metadata:
             ContextDev::Models::AIExtractProductResponse::KeyMetadata::OrHash,
+          partial: T::Boolean,
           platform:
             T.nilable(
               ContextDev::Models::AIExtractProductResponse::Platform::OrSymbol
@@ -100,10 +115,16 @@ module ContextDev
         # cache-controlled fetch contributing to the output was a hit; age_ms is the
         # oldest contributing hit.
         cache_metadata:,
+        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        # it when contacting support about a failed request.
+        request_id:,
         # Whether the given URL is a product detail page
         is_product_page: nil,
         # Credit usage, included whenever a valid API key is provided.
         key_metadata: nil,
+        # True when the timeout ended processing and this response contains only usable
+        # results completed so far. Unfinished results are omitted.
+        partial: nil,
         # The detected ecommerce platform, or null if not a product page
         platform: nil,
         # The extracted product data, or null if not a product page
@@ -116,9 +137,11 @@ module ContextDev
           {
             cache_metadata:
               ContextDev::Models::AIExtractProductResponse::CacheMetadata,
+            request_id: String,
             is_product_page: T::Boolean,
             key_metadata:
               ContextDev::Models::AIExtractProductResponse::KeyMetadata,
+            partial: T::Boolean,
             platform:
               T.nilable(
                 ContextDev::Models::AIExtractProductResponse::Platform::TaggedSymbol

data/rbi/context_dev/models/ai_extract_products_params.rbi

@@ -99,14 +99,25 @@ module ContextDev
           sig { params(tags: T::Array[String]).void }
           attr_writer :tags
 
-          # 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).
-          sig { returns(T.nilable(Integer)) }
-          attr_reader :timeout_ms
+          # Optional request deadline and behavior on timeout. For GET requests, use
+          # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+          # timeoutOpts object.
+          sig do
+            returns(
+              T.nilable(
+                ContextDev::AIExtractProductsParams::Body::ByDomain::TimeoutOpts
+              )
+            )
+          end
+          attr_reader :timeout_opts
 
-          sig { params(timeout_ms: Integer).void }
-          attr_writer :timeout_ms
+          sig do
+            params(
+              timeout_opts:
+                ContextDev::AIExtractProductsParams::Body::ByDomain::TimeoutOpts::OrHash
+            ).void
+          end
+          attr_writer :timeout_opts
 
           sig do
             params(
@@ -114,7 +125,8 @@ module ContextDev
               max_age_ms: Integer,
               max_products: Integer,
               tags: T::Array[String],
-              timeout_ms: Integer
+              timeout_opts:
+                ContextDev::AIExtractProductsParams::Body::ByDomain::TimeoutOpts::OrHash
             ).returns(T.attached_class)
           end
           def self.new(
@@ -128,10 +140,10 @@ module ContextDev
             max_products: nil,
             # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
             tags: nil,
-            # 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).
-            timeout_ms: nil
+            # Optional request deadline and behavior on timeout. For GET requests, use
+            # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+            # timeoutOpts object.
+            timeout_opts: nil
           )
           end
 
@@ -142,12 +154,119 @@ module ContextDev
                 max_age_ms: Integer,
                 max_products: Integer,
                 tags: T::Array[String],
-                timeout_ms: Integer
+                timeout_opts:
+                  ContextDev::AIExtractProductsParams::Body::ByDomain::TimeoutOpts
               }
             )
           end
           def to_hash
           end
+
+          class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  ContextDev::AIExtractProductsParams::Body::ByDomain::TimeoutOpts,
+                  ContextDev::Internal::AnyHash
+                )
+              end
+
+            # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+            sig { returns(Integer) }
+            attr_accessor :milliseconds
+
+            # 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.
+            sig do
+              returns(
+                T.nilable(
+                  ContextDev::AIExtractProductsParams::Body::ByDomain::TimeoutOpts::Behavior::OrSymbol
+                )
+              )
+            end
+            attr_reader :behavior
+
+            sig do
+              params(
+                behavior:
+                  ContextDev::AIExtractProductsParams::Body::ByDomain::TimeoutOpts::Behavior::OrSymbol
+              ).void
+            end
+            attr_writer :behavior
+
+            # Optional request deadline and behavior on timeout. For GET requests, use
+            # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+            # timeoutOpts object.
+            sig do
+              params(
+                milliseconds: Integer,
+                behavior:
+                  ContextDev::AIExtractProductsParams::Body::ByDomain::TimeoutOpts::Behavior::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+              milliseconds:,
+              # 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.
+              behavior: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  milliseconds: Integer,
+                  behavior:
+                    ContextDev::AIExtractProductsParams::Body::ByDomain::TimeoutOpts::Behavior::OrSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # 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.
+            module Behavior
+              extend ContextDev::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    ContextDev::AIExtractProductsParams::Body::ByDomain::TimeoutOpts::Behavior
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              FAIL =
+                T.let(
+                  :fail,
+                  ContextDev::AIExtractProductsParams::Body::ByDomain::TimeoutOpts::Behavior::TaggedSymbol
+                )
+              RETURN_PARTIAL =
+                T.let(
+                  :"return-partial",
+                  ContextDev::AIExtractProductsParams::Body::ByDomain::TimeoutOpts::Behavior::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    ContextDev::AIExtractProductsParams::Body::ByDomain::TimeoutOpts::Behavior::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
         end
 
         class ByDirectURL < ContextDev::Internal::Type::BaseModel
@@ -187,14 +306,25 @@ module ContextDev
           sig { params(tags: T::Array[String]).void }
           attr_writer :tags
 
-          # 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).
-          sig { returns(T.nilable(Integer)) }
-          attr_reader :timeout_ms
+          # Optional request deadline and behavior on timeout. For GET requests, use
+          # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+          # timeoutOpts object.
+          sig do
+            returns(
+              T.nilable(
+                ContextDev::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts
+              )
+            )
+          end
+          attr_reader :timeout_opts
 
-          sig { params(timeout_ms: Integer).void }
-          attr_writer :timeout_ms
+          sig do
+            params(
+              timeout_opts:
+                ContextDev::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts::OrHash
+            ).void
+          end
+          attr_writer :timeout_opts
 
           sig do
             params(
@@ -202,7 +332,8 @@ module ContextDev
               max_age_ms: Integer,
               max_products: Integer,
               tags: T::Array[String],
-              timeout_ms: Integer
+              timeout_opts:
+                ContextDev::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts::OrHash
             ).returns(T.attached_class)
           end
           def self.new(
@@ -217,10 +348,10 @@ module ContextDev
             max_products: nil,
             # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
             tags: nil,
-            # 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).
-            timeout_ms: nil
+            # Optional request deadline and behavior on timeout. For GET requests, use
+            # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+            # timeoutOpts object.
+            timeout_opts: nil
           )
           end
 
@@ -231,12 +362,119 @@ module ContextDev
                 max_age_ms: Integer,
                 max_products: Integer,
                 tags: T::Array[String],
-                timeout_ms: Integer
+                timeout_opts:
+                  ContextDev::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts
               }
             )
           end
           def to_hash
           end
+
+          class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  ContextDev::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts,
+                  ContextDev::Internal::AnyHash
+                )
+              end
+
+            # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+            sig { returns(Integer) }
+            attr_accessor :milliseconds
+
+            # 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.
+            sig do
+              returns(
+                T.nilable(
+                  ContextDev::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts::Behavior::OrSymbol
+                )
+              )
+            end
+            attr_reader :behavior
+
+            sig do
+              params(
+                behavior:
+                  ContextDev::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts::Behavior::OrSymbol
+              ).void
+            end
+            attr_writer :behavior
+
+            # Optional request deadline and behavior on timeout. For GET requests, use
+            # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+            # timeoutOpts object.
+            sig do
+              params(
+                milliseconds: Integer,
+                behavior:
+                  ContextDev::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts::Behavior::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+              milliseconds:,
+              # 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.
+              behavior: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  milliseconds: Integer,
+                  behavior:
+                    ContextDev::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts::Behavior::OrSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # 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.
+            module Behavior
+              extend ContextDev::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    ContextDev::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts::Behavior
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              FAIL =
+                T.let(
+                  :fail,
+                  ContextDev::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts::Behavior::TaggedSymbol
+                )
+              RETURN_PARTIAL =
+                T.let(
+                  :"return-partial",
+                  ContextDev::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts::Behavior::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    ContextDev::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts::Behavior::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
         end
 
         sig do

data/rbi/context_dev/models/ai_extract_products_response.rbi

@@ -27,6 +27,11 @@ module ContextDev
       end
       attr_writer :cache_metadata
 
+      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      # it when contacting support about a failed request.
+      sig { returns(String) }
+      attr_accessor :request_id
+
       # Credit usage, included whenever a valid API key is provided.
       sig do
         returns(
@@ -43,6 +48,15 @@ module ContextDev
       end
       attr_writer :key_metadata
 
+      # True when timeoutOpts.behavior=return-partial returned the usable results
+      # collected before the deadline. Partial collections are not cached as complete
+      # results.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :partial
+
+      sig { params(partial: T::Boolean).void }
+      attr_writer :partial
+
       # Array of products extracted from the website
       sig do
         returns(
@@ -67,8 +81,10 @@ module ContextDev
         params(
           cache_metadata:
             ContextDev::Models::AIExtractProductsResponse::CacheMetadata::OrHash,
+          request_id: String,
           key_metadata:
             ContextDev::Models::AIExtractProductsResponse::KeyMetadata::OrHash,
+          partial: T::Boolean,
           products:
             T::Array[
               ContextDev::Models::AIExtractProductsResponse::Product::OrHash
@@ -80,8 +96,15 @@ module ContextDev
         # cache-controlled fetch contributing to the output was a hit; age_ms is the
         # oldest contributing hit.
         cache_metadata:,
+        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        # it when contacting support about a failed request.
+        request_id:,
         # Credit usage, included whenever a valid API key is provided.
         key_metadata: nil,
+        # True when timeoutOpts.behavior=return-partial returned the usable results
+        # collected before the deadline. Partial collections are not cached as complete
+        # results.
+        partial: nil,
         # Array of products extracted from the website
         products: nil
       )
@@ -92,8 +115,10 @@ module ContextDev
           {
             cache_metadata:
               ContextDev::Models::AIExtractProductsResponse::CacheMetadata,
+            request_id: String,
             key_metadata:
               ContextDev::Models::AIExtractProductsResponse::KeyMetadata,
+            partial: T::Boolean,
             products:
               T::Array[ContextDev::Models::AIExtractProductsResponse::Product]
           }

data/rbi/context_dev/models/batch_cancel_response.rbi

@@ -68,6 +68,11 @@ module ContextDev
       end
       attr_writer :progress
 
+      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      # it when contacting support about a failed request.
+      sig { returns(String) }
+      attr_accessor :request_id
+
       # Always `cancelling`. Work already in flight finishes; the batch reaches
       # `cancelled` shortly after.
       sig do
@@ -114,6 +119,7 @@ module ContextDev
           mode: ContextDev::Models::BatchCancelResponse::Mode::OrSymbol,
           page_errors: T::Array[ContextDev::PageErrorCount::OrHash],
           progress: ContextDev::Models::BatchCancelResponse::Progress::OrHash,
+          request_id: String,
           status: ContextDev::Models::BatchCancelResponse::Status::OrSymbol,
           tags: T::Array[String],
           timing: ContextDev::Models::BatchCancelResponse::Timing::OrHash,
@@ -139,6 +145,9 @@ module ContextDev
         page_errors:,
         # How far the batch got before cancellation.
         progress:,
+        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        # it when contacting support about a failed request.
+        request_id:,
         # Always `cancelling`. Work already in flight finishes; the batch reaches
         # `cancelled` shortly after.
         status:,
@@ -163,6 +172,7 @@ module ContextDev
             mode: ContextDev::Models::BatchCancelResponse::Mode::TaggedSymbol,
             page_errors: T::Array[ContextDev::PageErrorCount],
             progress: ContextDev::Models::BatchCancelResponse::Progress,
+            request_id: String,
             status:
               ContextDev::Models::BatchCancelResponse::Status::TaggedSymbol,
             tags: T::Array[String],

data/rbi/context_dev/models/batch_delete_response.rbi

@@ -11,6 +11,11 @@ module ContextDev
           )
         end
 
+      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      # it when contacting support about a failed request.
+      sig { returns(String) }
+      attr_accessor :request_id
+
       # ID of the deleted batch.
       sig { returns(T.nilable(String)) }
       attr_reader :id
@@ -41,6 +46,7 @@ module ContextDev
 
       sig do
         params(
+          request_id: String,
           id: String,
           deleted: T::Boolean,
           key_metadata:
@@ -48,6 +54,9 @@ module ContextDev
         ).returns(T.attached_class)
       end
       def self.new(
+        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        # it when contacting support about a failed request.
+        request_id:,
         # ID of the deleted batch.
         id: nil,
         # Always true on success.
@@ -60,6 +69,7 @@ module ContextDev
       sig do
         override.returns(
           {
+            request_id: String,
             id: String,
             deleted: T::Boolean,
             key_metadata: ContextDev::Models::BatchDeleteResponse::KeyMetadata

data/rbi/context_dev/models/batch_get_results_response.rbi

@@ -11,6 +11,11 @@ module ContextDev
           )
         end
 
+      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      # it when contacting support about a failed request.
+      sig { returns(String) }
+      attr_accessor :request_id
+
       # Result records on this page.
       sig do
         returns(
@@ -65,6 +70,7 @@ module ContextDev
 
       sig do
         params(
+          request_id: String,
           data:
             T::Array[
               T.any(
@@ -79,6 +85,9 @@ module ContextDev
         ).returns(T.attached_class)
       end
       def self.new(
+        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        # it when contacting support about a failed request.
+        request_id:,
         # Result records on this page.
         data: nil,
         # Whether another page is available.
@@ -93,6 +102,7 @@ module ContextDev
       sig do
         override.returns(
           {
+            request_id: String,
             data:
               T::Array[
                 ContextDev::Models::BatchGetResultsResponse::Data::Variants

data/rbi/context_dev/models/batch_list_response.rbi

@@ -11,6 +11,11 @@ module ContextDev
           )
         end
 
+      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      # it when contacting support about a failed request.
+      sig { returns(String) }
+      attr_accessor :request_id
+
       # Batches on this page.
       sig do
         returns(
@@ -53,6 +58,7 @@ module ContextDev
 
       sig do
         params(
+          request_id: String,
           data: T::Array[ContextDev::Models::BatchListResponse::Data::OrHash],
           has_more: T::Boolean,
           key_metadata:
@@ -61,6 +67,9 @@ module ContextDev
         ).returns(T.attached_class)
       end
       def self.new(
+        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        # it when contacting support about a failed request.
+        request_id:,
         # Batches on this page.
         data: nil,
         # Whether another page is available.
@@ -75,6 +84,7 @@ module ContextDev
       sig do
         override.returns(
           {
+            request_id: String,
             data: T::Array[ContextDev::Models::BatchListResponse::Data],
             has_more: T::Boolean,
             key_metadata: ContextDev::Models::BatchListResponse::KeyMetadata,

data/rbi/context_dev/models/batch_retrieve_response.rbi

@@ -84,6 +84,11 @@ module ContextDev
       end
       attr_writer :progress
 
+      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      # it when contacting support about a failed request.
+      sig { returns(String) }
+      attr_accessor :request_id
+
       # Download links, available once the batch reaches a final status and null before
       # then. GET /batch/{batch_id}/results serves the same records as paginated JSON.
       sig do
@@ -159,6 +164,7 @@ module ContextDev
           mode: ContextDev::Models::BatchRetrieveResponse::Mode::OrSymbol,
           page_errors: T::Array[ContextDev::PageErrorCount::OrHash],
           progress: ContextDev::Models::BatchRetrieveResponse::Progress::OrHash,
+          request_id: String,
           results:
             T.nilable(
               ContextDev::Models::BatchRetrieveResponse::Results::OrHash
@@ -196,6 +202,9 @@ module ContextDev
         page_errors:,
         # Pages attempted so far. Use `status` to check completion.
         progress:,
+        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        # it when contacting support about a failed request.
+        request_id:,
         # Download links, available once the batch reaches a final status and null before
         # then. GET /batch/{batch_id}/results serves the same records as paginated JSON.
         results:,
@@ -226,6 +235,7 @@ module ContextDev
             mode: ContextDev::Models::BatchRetrieveResponse::Mode::TaggedSymbol,
             page_errors: T::Array[ContextDev::PageErrorCount],
             progress: ContextDev::Models::BatchRetrieveResponse::Progress,
+            request_id: String,
             results:
               T.nilable(ContextDev::Models::BatchRetrieveResponse::Results),
             status: