context.dev 2.20.0 → 2.21.0

data/rbi/context_dev/models/feedback_submit_response.rbi

@@ -0,0 +1,122 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class FeedbackSubmitResponse < ContextDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::Models::FeedbackSubmitResponse,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      # True when feedback for this request_id was already recorded; the original
+      # feedback_id is returned.
+      sig { returns(T::Boolean) }
+      attr_accessor :already_submitted
+
+      # ID of the stored feedback.
+      sig { returns(String) }
+      attr_accessor :feedback_id
+
+      # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      # it when contacting support about a failed request.
+      sig { returns(String) }
+      attr_accessor :request_id
+
+      # Credit usage, included whenever a valid API key is provided.
+      sig do
+        returns(
+          T.nilable(ContextDev::Models::FeedbackSubmitResponse::KeyMetadata)
+        )
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata:
+            ContextDev::Models::FeedbackSubmitResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
+      sig do
+        params(
+          already_submitted: T::Boolean,
+          feedback_id: String,
+          request_id: String,
+          key_metadata:
+            ContextDev::Models::FeedbackSubmitResponse::KeyMetadata::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # True when feedback for this request_id was already recorded; the original
+        # feedback_id is returned.
+        already_submitted:,
+        # ID of the stored feedback.
+        feedback_id:,
+        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        # it when contacting support about a failed request.
+        request_id:,
+        # Credit usage, included whenever a valid API key is provided.
+        key_metadata: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            already_submitted: T::Boolean,
+            feedback_id: String,
+            request_id: String,
+            key_metadata:
+              ContextDev::Models::FeedbackSubmitResponse::KeyMetadata
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::FeedbackSubmitResponse::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/news_search_params.rbi

@@ -24,7 +24,9 @@ module ContextDev
       sig { returns(T.nilable(String)) }
       attr_accessor :cursor
 
-      # Optional result filters.
+      # Optional result filters. Use at most one of sourceDomain, sourceCountry,
+      # articleLanguage, or articleType. A date range may accompany that category;
+      # date.from must not exceed date.to.
       sig { returns(T.nilable(ContextDev::NewsSearchParams::FilterBy)) }
       attr_reader :filter_by
 
@@ -70,7 +72,9 @@ module ContextDev
         search_by:,
         # Opaque next_cursor from the previous response, or null for the first page.
         cursor: nil,
-        # Optional result filters.
+        # Optional result filters. Use at most one of sourceDomain, sourceCountry,
+        # articleLanguage, or articleType. A date range may accompany that category;
+        # date.from must not exceed date.to.
         filter_by: nil,
         # Maximum results to return. Defaults to 10.
         limit: nil,
@@ -812,7 +816,7 @@ module ContextDev
         end
         attr_writer :article_type
 
-        # Published-at window in epoch milliseconds.
+        # Published-at window in epoch milliseconds. from must be before or equal to to.
         sig { returns(T.nilable(ContextDev::NewsSearchParams::FilterBy::Date)) }
         attr_reader :date
 
@@ -852,7 +856,9 @@ module ContextDev
         sig { params(source_domain: T::Array[String]).void }
         attr_writer :source_domain
 
-        # Optional result filters.
+        # Optional result filters. Use at most one of sourceDomain, sourceCountry,
+        # articleLanguage, or articleType. A date range may accompany that category;
+        # date.from must not exceed date.to.
         sig do
           params(
             article_language:
@@ -876,7 +882,7 @@ module ContextDev
           article_language: nil,
           # Article types to include. Up to 3.
           article_type: nil,
-          # Published-at window in epoch milliseconds.
+          # Published-at window in epoch milliseconds. from must be before or equal to to.
           date: nil,
           # Publisher countries to include, as lowercase ISO 3166-1 alpha-2 codes. Up to 3.
           source_country: nil,
@@ -1061,7 +1067,7 @@ module ContextDev
           sig { params(to: Integer).void }
           attr_writer :to
 
-          # Published-at window in epoch milliseconds.
+          # Published-at window in epoch milliseconds. from must be before or equal to to.
           sig { params(from: Integer, to: Integer).returns(T.attached_class) }
           def self.new(
             # Inclusive start of the published-at window, in epoch milliseconds.

data/rbi/context_dev/models/web_scrape_params.rbi

@@ -131,12 +131,16 @@ module ContextDev
       attr_writer :tags
 
       # Total deadline, including navigation, actions, waiting, and all outputs.
-      # Defaults to 60000 milliseconds with behavior fail. Use return-partial to capture
-      # the current page state and return captured images if image processing cannot
-      # finish before the deadline; these responses set isPartial and are not cached.
-      # Every requested format must still be available. Fixed waits must fit before a
-      # response reserve of up to 5000 milliseconds (at most one quarter of the timeout)
-      # when using return-partial.
+      # Defaults to 60000 milliseconds with behavior fail. Individual outputs have
+      # internal deadlines that reserve time to return completed outputs; timed-out
+      # outputs have success: false and data: null under either behavior. The overall
+      # request deadline remains enforced: fail returns an error if that deadline is
+      # reached. Use return-partial to allow the current page state and available
+      # outputs when the page is still loading. Partial responses set isPartial. Failed
+      # retrievals and incomplete captures are not cached; valid captured pieces may be
+      # cached independently. Fixed waits must fit before a response reserve of up to
+      # 5000 milliseconds (at most one quarter of the timeout) when using
+      # return-partial.
       sig { returns(T.nilable(ContextDev::WebScrapeParams::TimeoutOpts)) }
       attr_reader :timeout_opts
 
@@ -148,8 +152,7 @@ module ContextDev
       attr_writer :timeout_opts
 
       # Zero data retention. Bypasses caches and uploads; excludes request/response
-      # content and tags from logs. Must be enabled for your organization. Not available
-      # with the highlights output.
+      # content and tags from logs. Must be enabled for your organization.
       sig { returns(T.nilable(ContextDev::WebScrapeParams::Zdr::OrSymbol)) }
       attr_reader :zdr
 
@@ -207,16 +210,19 @@ module ContextDev
         # Labels for tracking request usage. Not retained when zdr is enabled.
         tags: nil,
         # Total deadline, including navigation, actions, waiting, and all outputs.
-        # Defaults to 60000 milliseconds with behavior fail. Use return-partial to capture
-        # the current page state and return captured images if image processing cannot
-        # finish before the deadline; these responses set isPartial and are not cached.
-        # Every requested format must still be available. Fixed waits must fit before a
-        # response reserve of up to 5000 milliseconds (at most one quarter of the timeout)
-        # when using return-partial.
+        # Defaults to 60000 milliseconds with behavior fail. Individual outputs have
+        # internal deadlines that reserve time to return completed outputs; timed-out
+        # outputs have success: false and data: null under either behavior. The overall
+        # request deadline remains enforced: fail returns an error if that deadline is
+        # reached. Use return-partial to allow the current page state and available
+        # outputs when the page is still loading. Partial responses set isPartial. Failed
+        # retrievals and incomplete captures are not cached; valid captured pieces may be
+        # cached independently. Fixed waits must fit before a response reserve of up to
+        # 5000 milliseconds (at most one quarter of the timeout) when using
+        # return-partial.
         timeout_opts: nil,
         # Zero data retention. Bypasses caches and uploads; excludes request/response
-        # content and tags from logs. Must be enabled for your organization. Not available
-        # with the highlights output.
+        # content and tags from logs. Must be enabled for your organization.
         zdr: nil,
         request_options: {}
       )
@@ -262,9 +268,9 @@ module ContextDev
         sig { params(bytes: T::Boolean).void }
         attr_writer :bytes
 
-        # Plain-text passages from the page that are most relevant to
-        # highlightsParams.query, each prefixed with its section heading. Adds 3 credits.
-        # Not available with zdr enabled.
+        # Relevant Markdown excerpts for your question or topic, preserving code, lists,
+        # and tables, with headings included when needed for context. Adds 3 credits when
+        # passages are returned.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :highlights
 
@@ -285,10 +291,8 @@ module ContextDev
         sig { params(images: T::Boolean).void }
         attr_writer :images
 
-        # Page data extracted by an LLM from the page Markdown into jsonParams.schema;
-        # values carried only in attributes or CSS classes need formats.parse instead.
-        # Adds four credits when the page has text to extract; when shared content filters
-        # leave no text the result is an empty object and only the base price applies.
+        # Page data extracted using your schema. Adds 4 credits when extraction succeeds
+        # and its result is returned.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :json
 
@@ -309,7 +313,8 @@ module ContextDev
         sig { params(parse: T::Boolean).void }
         attr_writer :parse
 
-        # Structured product data for product detail pages. Adds one credit.
+        # Product details such as name, price, and availability. Adds 1 credit when its
+        # successful result is returned or the target page is missing.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :product
 
@@ -340,24 +345,23 @@ module ContextDev
         def self.new(
           # The original HTTP response body.
           bytes: nil,
-          # Plain-text passages from the page that are most relevant to
-          # highlightsParams.query, each prefixed with its section heading. Adds 3 credits.
-          # Not available with zdr enabled.
+          # Relevant Markdown excerpts for your question or topic, preserving code, lists,
+          # and tables, with headings included when needed for context. Adds 3 credits when
+          # passages are returned.
           highlights: nil,
           # Rendered HTML.
           html: nil,
           # Images found on the page.
           images: nil,
-          # Page data extracted by an LLM from the page Markdown into jsonParams.schema;
-          # values carried only in attributes or CSS classes need formats.parse instead.
-          # Adds four credits when the page has text to extract; when shared content filters
-          # leave no text the result is an empty object and only the base price applies.
+          # Page data extracted using your schema. Adds 4 credits when extraction succeeds
+          # and its result is returned.
           json: nil,
           # Page content as Markdown.
           markdown: nil,
           # Fields selected by parseParams.rules.
           parse: nil,
-          # Structured product data for product detail pages. Adds one credit.
+          # Product details such as name, price, and availability. Adds 1 credit when its
+          # successful result is returned or the target page is missing.
           product: nil,
           # An inline image of the page.
           screenshot: nil
@@ -993,9 +997,10 @@ module ContextDev
           end
 
         # Extract the product with a specialized model when the page has no structured
-        # product data. Adds six credits when the model returns a verdict. If the fallback
-        # fails, returns a partial response with the deterministic result and no fallback
-        # charge. Request deadlines and client disconnects still apply.
+        # product data. Adds six credits when the model verdict is returned successfully.
+        # If the fallback fails, the product output has success: false and data: null with
+        # no fallback charge; other outputs remain available. Request deadlines and client
+        # disconnects still apply.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :use_ai_fallback
 
@@ -1006,9 +1011,10 @@ module ContextDev
         sig { params(use_ai_fallback: T::Boolean).returns(T.attached_class) }
         def self.new(
           # Extract the product with a specialized model when the page has no structured
-          # product data. Adds six credits when the model returns a verdict. If the fallback
-          # fails, returns a partial response with the deterministic result and no fallback
-          # charge. Request deadlines and client disconnects still apply.
+          # product data. Adds six credits when the model verdict is returned successfully.
+          # If the fallback fails, the product output has success: false and data: null with
+          # no fallback charge; other outputs remain available. Request deadlines and client
+          # disconnects still apply.
           use_ai_fallback: nil
         )
         end
@@ -2119,12 +2125,16 @@ module ContextDev
         attr_writer :behavior
 
         # Total deadline, including navigation, actions, waiting, and all outputs.
-        # Defaults to 60000 milliseconds with behavior fail. Use return-partial to capture
-        # the current page state and return captured images if image processing cannot
-        # finish before the deadline; these responses set isPartial and are not cached.
-        # Every requested format must still be available. Fixed waits must fit before a
-        # response reserve of up to 5000 milliseconds (at most one quarter of the timeout)
-        # when using return-partial.
+        # Defaults to 60000 milliseconds with behavior fail. Individual outputs have
+        # internal deadlines that reserve time to return completed outputs; timed-out
+        # outputs have success: false and data: null under either behavior. The overall
+        # request deadline remains enforced: fail returns an error if that deadline is
+        # reached. Use return-partial to allow the current page state and available
+        # outputs when the page is still loading. Partial responses set isPartial. Failed
+        # retrievals and incomplete captures are not cached; valid captured pieces may be
+        # cached independently. Fixed waits must fit before a response reserve of up to
+        # 5000 milliseconds (at most one quarter of the timeout) when using
+        # return-partial.
         sig do
           params(
             milliseconds: Integer,
@@ -2194,8 +2204,7 @@ module ContextDev
       end
 
       # Zero data retention. Bypasses caches and uploads; excludes request/response
-      # content and tags from logs. Must be enabled for your organization. Not available
-      # with the highlights output.
+      # content and tags from logs. Must be enabled for your organization.
       module Zdr
         extend ContextDev::Internal::Type::Enum