context.dev 2.16.0 → 2.17.1

data/rbi/context_dev/models/ai_extract_product_params.rbi

@@ -34,21 +34,27 @@ 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::AIExtractProductParams::TimeoutOpts))
+      end
+      attr_reader :timeout_opts
 
-      sig { params(timeout_ms: Integer).void }
-      attr_writer :timeout_ms
+      sig do
+        params(
+          timeout_opts: ContextDev::AIExtractProductParams::TimeoutOpts::OrHash
+        ).void
+      end
+      attr_writer :timeout_opts
 
       sig do
         params(
           url: String,
           max_age_ms: Integer,
           tags: T::Array[String],
-          timeout_ms: Integer,
+          timeout_opts: ContextDev::AIExtractProductParams::TimeoutOpts::OrHash,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -61,10 +67,10 @@ module ContextDev
         max_age_ms: 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,
         request_options: {}
       )
       end
@@ -75,13 +81,119 @@ module ContextDev
             url: String,
             max_age_ms: Integer,
             tags: T::Array[String],
-            timeout_ms: Integer,
+            timeout_opts: ContextDev::AIExtractProductParams::TimeoutOpts,
             request_options: ContextDev::RequestOptions
           }
         )
       end
       def to_hash
       end
+
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::AIExtractProductParams::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::AIExtractProductParams::TimeoutOpts::Behavior::OrSymbol
+            )
+          )
+        end
+        attr_reader :behavior
+
+        sig do
+          params(
+            behavior:
+              ContextDev::AIExtractProductParams::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::AIExtractProductParams::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::AIExtractProductParams::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::AIExtractProductParams::TimeoutOpts::Behavior
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FAIL =
+            T.let(
+              :fail,
+              ContextDev::AIExtractProductParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+          RETURN_PARTIAL =
+            T.let(
+              :"return-partial",
+              ContextDev::AIExtractProductParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::AIExtractProductParams::TimeoutOpts::Behavior::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
     end
   end
 end

data/rbi/context_dev/models/ai_extract_product_response.rbi

@@ -55,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(
@@ -91,6 +99,7 @@ module ContextDev
           is_product_page: T::Boolean,
           key_metadata:
             ContextDev::Models::AIExtractProductResponse::KeyMetadata::OrHash,
+          partial: T::Boolean,
           platform:
             T.nilable(
               ContextDev::Models::AIExtractProductResponse::Platform::OrSymbol
@@ -113,6 +122,9 @@ module ContextDev
         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
@@ -129,6 +141,7 @@ module ContextDev
             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

@@ -48,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(
@@ -75,6 +84,7 @@ module ContextDev
           request_id: String,
           key_metadata:
             ContextDev::Models::AIExtractProductsResponse::KeyMetadata::OrHash,
+          partial: T::Boolean,
           products:
             T::Array[
               ContextDev::Models::AIExtractProductsResponse::Product::OrHash
@@ -91,6 +101,10 @@ module ContextDev
         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
       )
@@ -104,6 +118,7 @@ module ContextDev
             request_id: String,
             key_metadata:
               ContextDev::Models::AIExtractProductsResponse::KeyMetadata,
+            partial: T::Boolean,
             products:
               T::Array[ContextDev::Models::AIExtractProductsResponse::Product]
           }