context.dev 2.16.0 → 2.17.1

data/rbi/context_dev/models/web_answers_params.rbi

@@ -0,0 +1,234 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class WebAnswersParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(ContextDev::WebAnswersParams, ContextDev::Internal::AnyHash)
+        end
+
+      # What to research and answer, in plain language. Naming a domain in the task (for
+      # example "pricing on context.dev") makes the agent read that site before it
+      # searches.
+      sig { returns(String) }
+      attr_accessor :task
+
+      # An example object with placeholder values (for example {"pricing_page_url": "",
+      # "plans": [{"name": "", "price": 0}]}). Object keys and value types are
+      # preserved; unknown values may be null. Empty arrays accept any JSON items.
+      # Defaults to {"result": ""}. Maximum 8 levels, 500 values, and 16000 characters.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_reader :json_format
+
+      sig { params(json_format: T::Hash[Symbol, T.anything]).void }
+      attr_writer :json_format
+
+      # Research level: fast uses a smaller model and research budget for 10 credits;
+      # ultra uses deeper reasoning and research for 100 credits. Defaults to ultra.
+      # Only successful requests consume credits.
+      sig { returns(T.nilable(ContextDev::WebAnswersParams::Mode::OrSymbol)) }
+      attr_reader :mode
+
+      sig { params(mode: ContextDev::WebAnswersParams::Mode::OrSymbol).void }
+      attr_writer :mode
+
+      # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :tags
+
+      sig { params(tags: T::Array[String]).void }
+      attr_writer :tags
+
+      # Optional request deadline and behavior on timeout. For GET requests, use
+      # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+      # timeoutOpts object.
+      sig { returns(T.nilable(ContextDev::WebAnswersParams::TimeoutOpts)) }
+      attr_reader :timeout_opts
+
+      sig do
+        params(
+          timeout_opts: ContextDev::WebAnswersParams::TimeoutOpts::OrHash
+        ).void
+      end
+      attr_writer :timeout_opts
+
+      sig do
+        params(
+          task: String,
+          json_format: T::Hash[Symbol, T.anything],
+          mode: ContextDev::WebAnswersParams::Mode::OrSymbol,
+          tags: T::Array[String],
+          timeout_opts: ContextDev::WebAnswersParams::TimeoutOpts::OrHash,
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # What to research and answer, in plain language. Naming a domain in the task (for
+        # example "pricing on context.dev") makes the agent read that site before it
+        # searches.
+        task:,
+        # An example object with placeholder values (for example {"pricing_page_url": "",
+        # "plans": [{"name": "", "price": 0}]}). Object keys and value types are
+        # preserved; unknown values may be null. Empty arrays accept any JSON items.
+        # Defaults to {"result": ""}. Maximum 8 levels, 500 values, and 16000 characters.
+        json_format: nil,
+        # Research level: fast uses a smaller model and research budget for 10 credits;
+        # ultra uses deeper reasoning and research for 100 credits. Defaults to ultra.
+        # Only successful requests consume credits.
+        mode: nil,
+        # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+        tags: 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
+
+      sig do
+        override.returns(
+          {
+            task: String,
+            json_format: T::Hash[Symbol, T.anything],
+            mode: ContextDev::WebAnswersParams::Mode::OrSymbol,
+            tags: T::Array[String],
+            timeout_opts: ContextDev::WebAnswersParams::TimeoutOpts,
+            request_options: ContextDev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Research level: fast uses a smaller model and research budget for 10 credits;
+      # ultra uses deeper reasoning and research for 100 credits. Defaults to ultra.
+      # Only successful requests consume credits.
+      module Mode
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, ContextDev::WebAnswersParams::Mode) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        FAST = T.let(:fast, ContextDev::WebAnswersParams::Mode::TaggedSymbol)
+        ULTRA = T.let(:ultra, ContextDev::WebAnswersParams::Mode::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[ContextDev::WebAnswersParams::Mode::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::WebAnswersParams::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::WebAnswersParams::TimeoutOpts::Behavior::OrSymbol
+            )
+          )
+        end
+        attr_reader :behavior
+
+        sig do
+          params(
+            behavior:
+              ContextDev::WebAnswersParams::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::WebAnswersParams::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::WebAnswersParams::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::WebAnswersParams::TimeoutOpts::Behavior)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FAIL =
+            T.let(
+              :fail,
+              ContextDev::WebAnswersParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+          RETURN_PARTIAL =
+            T.let(
+              :"return-partial",
+              ContextDev::WebAnswersParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::WebAnswersParams::TimeoutOpts::Behavior::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/context_dev/models/web_answers_response.rbi

@@ -0,0 +1,122 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class WebAnswersResponse < ContextDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::Models::WebAnswersResponse,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      # The answer, in the shape requested by json_format.
+      sig { returns(T::Hash[Symbol, T.anything]) }
+      attr_accessor :json_content
+
+      # URLs that supplied search results or readable page content, in first-seen order.
+      # Unreadable pages are excluded.
+      sig { returns(T::Array[String]) }
+      attr_accessor :sources
+
+      # Credit usage, included whenever a valid API key is provided.
+      sig do
+        returns(T.nilable(ContextDev::Models::WebAnswersResponse::KeyMetadata))
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::WebAnswersResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
+      # True when the request deadline ended research and the answer uses the evidence
+      # collected so far.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :partial
+
+      sig { params(partial: T::Boolean).void }
+      attr_writer :partial
+
+      sig do
+        params(
+          json_content: T::Hash[Symbol, T.anything],
+          sources: T::Array[String],
+          key_metadata:
+            ContextDev::Models::WebAnswersResponse::KeyMetadata::OrHash,
+          partial: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The answer, in the shape requested by json_format.
+        json_content:,
+        # URLs that supplied search results or readable page content, in first-seen order.
+        # Unreadable pages are excluded.
+        sources:,
+        # Credit usage, included whenever a valid API key is provided.
+        key_metadata: nil,
+        # True when the request deadline ended research and the answer uses the evidence
+        # collected so far.
+        partial: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            json_content: T::Hash[Symbol, T.anything],
+            sources: T::Array[String],
+            key_metadata: ContextDev::Models::WebAnswersResponse::KeyMetadata,
+            partial: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebAnswersResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Credits used by this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # Credits remaining for your organization.
+        sig { returns(Integer) }
+        attr_accessor :credits_remaining
+
+        # Credit usage, included whenever a valid API key is provided.
+        sig do
+          params(credits_consumed: Integer, credits_remaining: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Credits used by this request.
+          credits_consumed:,
+          # Credits remaining for your organization.
+          credits_remaining:
+        )
+        end
+
+        sig do
+          override.returns(
+            { credits_consumed: Integer, credits_remaining: Integer }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/context_dev/models/web_extract_competitors_params.rbi

@@ -34,21 +34,29 @@ 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::WebExtractCompetitorsParams::TimeoutOpts))
+      end
+      attr_reader :timeout_opts
 
-      sig { params(timeout_ms: Integer).void }
-      attr_writer :timeout_ms
+      sig do
+        params(
+          timeout_opts:
+            ContextDev::WebExtractCompetitorsParams::TimeoutOpts::OrHash
+        ).void
+      end
+      attr_writer :timeout_opts
 
       sig do
         params(
           domain: String,
           num_competitors: Integer,
           tags: T::Array[String],
-          timeout_ms: Integer,
+          timeout_opts:
+            ContextDev::WebExtractCompetitorsParams::TimeoutOpts::OrHash,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -61,10 +69,10 @@ module ContextDev
         # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-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 +83,119 @@ module ContextDev
             domain: String,
             num_competitors: Integer,
             tags: T::Array[String],
-            timeout_ms: Integer,
+            timeout_opts: ContextDev::WebExtractCompetitorsParams::TimeoutOpts,
             request_options: ContextDev::RequestOptions
           }
         )
       end
       def to_hash
       end
+
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::WebExtractCompetitorsParams::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::WebExtractCompetitorsParams::TimeoutOpts::Behavior::OrSymbol
+            )
+          )
+        end
+        attr_reader :behavior
+
+        sig do
+          params(
+            behavior:
+              ContextDev::WebExtractCompetitorsParams::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::WebExtractCompetitorsParams::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::WebExtractCompetitorsParams::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::WebExtractCompetitorsParams::TimeoutOpts::Behavior
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FAIL =
+            T.let(
+              :fail,
+              ContextDev::WebExtractCompetitorsParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+          RETURN_PARTIAL =
+            T.let(
+              :"return-partial",
+              ContextDev::WebExtractCompetitorsParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::WebExtractCompetitorsParams::TimeoutOpts::Behavior::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
     end
   end
 end

data/rbi/context_dev/models/web_extract_competitors_response.rbi

@@ -68,6 +68,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
+
       sig do
         params(
           competitors:
@@ -81,7 +89,8 @@ module ContextDev
           target:
             ContextDev::Models::WebExtractCompetitorsResponse::Target::OrHash,
           key_metadata:
-            ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata::OrHash
+            ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata::OrHash,
+          partial: T::Boolean
         ).returns(T.attached_class)
       end
       def self.new(
@@ -97,7 +106,10 @@ module ContextDev
         # Target company profile inferred from the landing page.
         target:,
         # Credit usage, included whenever a valid API key is provided.
-        key_metadata: nil
+        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
       )
       end
 
@@ -114,7 +126,8 @@ module ContextDev
               ContextDev::Models::WebExtractCompetitorsResponse::Status::TaggedSymbol,
             target: ContextDev::Models::WebExtractCompetitorsResponse::Target,
             key_metadata:
-              ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata
+              ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata,
+            partial: T::Boolean
           }
         )
       end