context.dev 1.26.0 → 1.28.0

data/rbi/context_dev/models/web_extract_competitors_response.rbi

@@ -0,0 +1,297 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class WebExtractCompetitorsResponse < ContextDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::Models::WebExtractCompetitorsResponse,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      # Direct competitors ordered by relevance and confidence.
+      sig do
+        returns(
+          T::Array[
+            ContextDev::Models::WebExtractCompetitorsResponse::Competitor
+          ]
+        )
+      end
+      attr_accessor :competitors
+
+      # Normalized input domain.
+      sig { returns(String) }
+      attr_accessor :domain
+
+      # Status of the response.
+      sig do
+        returns(
+          ContextDev::Models::WebExtractCompetitorsResponse::Status::TaggedSymbol
+        )
+      end
+      attr_accessor :status
+
+      # Target company profile inferred from the landing page.
+      sig { returns(ContextDev::Models::WebExtractCompetitorsResponse::Target) }
+      attr_reader :target
+
+      sig do
+        params(
+          target:
+            ContextDev::Models::WebExtractCompetitorsResponse::Target::OrHash
+        ).void
+      end
+      attr_writer :target
+
+      sig do
+        params(
+          competitors:
+            T::Array[
+              ContextDev::Models::WebExtractCompetitorsResponse::Competitor::OrHash
+            ],
+          domain: String,
+          status:
+            ContextDev::Models::WebExtractCompetitorsResponse::Status::OrSymbol,
+          target:
+            ContextDev::Models::WebExtractCompetitorsResponse::Target::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Direct competitors ordered by relevance and confidence.
+        competitors:,
+        # Normalized input domain.
+        domain:,
+        # Status of the response.
+        status:,
+        # Target company profile inferred from the landing page.
+        target:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            competitors:
+              T::Array[
+                ContextDev::Models::WebExtractCompetitorsResponse::Competitor
+              ],
+            domain: String,
+            status:
+              ContextDev::Models::WebExtractCompetitorsResponse::Status::TaggedSymbol,
+            target: ContextDev::Models::WebExtractCompetitorsResponse::Target
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Competitor < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebExtractCompetitorsResponse::Competitor,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Confidence that this company is a direct competitor.
+        sig do
+          returns(
+            ContextDev::Models::WebExtractCompetitorsResponse::Competitor::Confidence::TaggedSymbol
+          )
+        end
+        attr_accessor :confidence
+
+        # Short description of the competitor.
+        sig { returns(String) }
+        attr_accessor :description
+
+        # Competitor's normalized official domain.
+        sig { returns(String) }
+        attr_accessor :domain
+
+        # Competitor company or product name.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # Search result URLs used as evidence for this competitor.
+        sig { returns(T::Array[String]) }
+        attr_accessor :source_urls
+
+        # Competitor website URL.
+        sig { returns(String) }
+        attr_accessor :url
+
+        sig do
+          params(
+            confidence:
+              ContextDev::Models::WebExtractCompetitorsResponse::Competitor::Confidence::OrSymbol,
+            description: String,
+            domain: String,
+            name: String,
+            source_urls: T::Array[String],
+            url: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Confidence that this company is a direct competitor.
+          confidence:,
+          # Short description of the competitor.
+          description:,
+          # Competitor's normalized official domain.
+          domain:,
+          # Competitor company or product name.
+          name:,
+          # Search result URLs used as evidence for this competitor.
+          source_urls:,
+          # Competitor website URL.
+          url:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              confidence:
+                ContextDev::Models::WebExtractCompetitorsResponse::Competitor::Confidence::TaggedSymbol,
+              description: String,
+              domain: String,
+              name: String,
+              source_urls: T::Array[String],
+              url: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Confidence that this company is a direct competitor.
+        module Confidence
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::Models::WebExtractCompetitorsResponse::Competitor::Confidence
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          HIGH =
+            T.let(
+              :high,
+              ContextDev::Models::WebExtractCompetitorsResponse::Competitor::Confidence::TaggedSymbol
+            )
+          MEDIUM =
+            T.let(
+              :medium,
+              ContextDev::Models::WebExtractCompetitorsResponse::Competitor::Confidence::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Models::WebExtractCompetitorsResponse::Competitor::Confidence::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      # Status of the response.
+      module Status
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ContextDev::Models::WebExtractCompetitorsResponse::Status
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        OK =
+          T.let(
+            :ok,
+            ContextDev::Models::WebExtractCompetitorsResponse::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::Models::WebExtractCompetitorsResponse::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class Target < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::WebExtractCompetitorsResponse::Target,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Company or product name inferred from the landing page.
+        sig { returns(String) }
+        attr_accessor :company_name
+
+        # Specific operating field, product category, or market.
+        sig { returns(String) }
+        attr_accessor :field
+
+        # One-sentence description of what the target company sells and who it serves.
+        sig { returns(String) }
+        attr_accessor :field_description
+
+        # Resolved URL used for the landing page analysis.
+        sig { returns(String) }
+        attr_accessor :website_url
+
+        # Target company profile inferred from the landing page.
+        sig do
+          params(
+            company_name: String,
+            field: String,
+            field_description: String,
+            website_url: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Company or product name inferred from the landing page.
+          company_name:,
+          # Specific operating field, product category, or market.
+          field:,
+          # One-sentence description of what the target company sells and who it serves.
+          field_description:,
+          # Resolved URL used for the landing page analysis.
+          website_url:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              company_name: String,
+              field: String,
+              field_description: String,
+              website_url: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/context_dev/models/web_web_scrape_html_params.rbi

@@ -18,6 +18,15 @@ module ContextDev
       sig { returns(String) }
       attr_accessor :url
 
+      # Optional outbound HTTP headers forwarded only to the target URL, sent as
+      # deep-object query params such as headers[X-Custom]=value. When provided, caching
+      # is bypassed: the result is neither read from nor written to cache.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :headers
+
+      sig { params(headers: T::Hash[Symbol, String]).void }
+      attr_writer :headers
+
       # When true, iframes are rendered inline into the returned HTML.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :include_frames
@@ -62,6 +71,7 @@ module ContextDev
       sig do
         params(
           url: String,
+          headers: T::Hash[Symbol, String],
           include_frames: T::Boolean,
           max_age_ms: Integer,
           pdf: ContextDev::WebWebScrapeHTMLParams::Pdf::OrHash,
@@ -73,6 +83,10 @@ module ContextDev
       def self.new(
         # Full URL to scrape (must include http:// or https:// protocol)
         url:,
+        # Optional outbound HTTP headers forwarded only to the target URL, sent as
+        # deep-object query params such as headers[X-Custom]=value. When provided, caching
+        # is bypassed: the result is neither read from nor written to cache.
+        headers: nil,
         # When true, iframes are rendered inline into the returned HTML.
         include_frames: nil,
         # Return a cached result if a prior scrape for the same parameters exists and is
@@ -97,6 +111,7 @@ module ContextDev
         override.returns(
           {
             url: String,
+            headers: T::Hash[Symbol, String],
             include_frames: T::Boolean,
             max_age_ms: Integer,
             pdf: ContextDev::WebWebScrapeHTMLParams::Pdf,

data/rbi/context_dev/models/web_web_scrape_images_params.rbi

@@ -32,6 +32,15 @@ module ContextDev
       end
       attr_writer :enrichment
 
+      # Optional outbound HTTP headers forwarded only to the target URL, sent as
+      # deep-object query params such as headers[X-Custom]=value. When provided, caching
+      # is bypassed: the result is neither read from nor written to cache.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :headers
+
+      sig { params(headers: T::Hash[Symbol, String]).void }
+      attr_writer :headers
+
       # Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1
       # day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days).
       sig { returns(T.nilable(Integer)) }
@@ -61,6 +70,7 @@ module ContextDev
         params(
           url: String,
           enrichment: ContextDev::WebWebScrapeImagesParams::Enrichment::OrHash,
+          headers: T::Hash[Symbol, String],
           max_age_ms: Integer,
           timeout_ms: Integer,
           wait_for_ms: Integer,
@@ -73,6 +83,10 @@ module ContextDev
         # Optional per-image processing, sent as deep-object query params such as
         # enrichment[resolution]=true.
         enrichment: nil,
+        # Optional outbound HTTP headers forwarded only to the target URL, sent as
+        # deep-object query params such as headers[X-Custom]=value. When provided, caching
+        # is bypassed: the result is neither read from nor written to cache.
+        headers: nil,
         # Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1
         # day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days).
         max_age_ms: nil,
@@ -92,6 +106,7 @@ module ContextDev
           {
             url: String,
             enrichment: ContextDev::WebWebScrapeImagesParams::Enrichment,
+            headers: T::Hash[Symbol, String],
             max_age_ms: Integer,
             timeout_ms: Integer,
             wait_for_ms: Integer,

data/rbi/context_dev/models/web_web_scrape_md_params.rbi

@@ -16,6 +16,15 @@ module ContextDev
       sig { returns(String) }
       attr_accessor :url
 
+      # Optional outbound HTTP headers forwarded only to the target URL, sent as
+      # deep-object query params such as headers[X-Custom]=value. When provided, caching
+      # is bypassed: the result is neither read from nor written to cache.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :headers
+
+      sig { params(headers: T::Hash[Symbol, String]).void }
+      attr_writer :headers
+
       # When true, the contents of iframes are rendered to Markdown.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :include_frames
@@ -89,6 +98,7 @@ module ContextDev
       sig do
         params(
           url: String,
+          headers: T::Hash[Symbol, String],
           include_frames: T::Boolean,
           include_images: T::Boolean,
           include_links: T::Boolean,
@@ -105,6 +115,10 @@ module ContextDev
         # Full URL to scrape into LLM usable Markdown (must include http:// or https://
         # protocol)
         url:,
+        # Optional outbound HTTP headers forwarded only to the target URL, sent as
+        # deep-object query params such as headers[X-Custom]=value. When provided, caching
+        # is bypassed: the result is neither read from nor written to cache.
+        headers: nil,
         # When true, the contents of iframes are rendered to Markdown.
         include_frames: nil,
         # Include image references in Markdown output
@@ -138,6 +152,7 @@ module ContextDev
         override.returns(
           {
             url: String,
+            headers: T::Hash[Symbol, String],
             include_frames: T::Boolean,
             include_images: T::Boolean,
             include_links: T::Boolean,

data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi

@@ -18,6 +18,15 @@ module ContextDev
       sig { returns(String) }
       attr_accessor :domain
 
+      # Optional outbound HTTP headers forwarded only to the target URL, sent as
+      # deep-object query params such as headers[X-Custom]=value. When provided, caching
+      # is bypassed: the result is neither read from nor written to cache.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :headers
+
+      sig { params(headers: T::Hash[Symbol, String]).void }
+      attr_writer :headers
+
       # Maximum number of links to return from the sitemap crawl. Defaults to 10,000.
       # Minimum is 1, maximum is 100,000.
       sig { returns(T.nilable(Integer)) }
@@ -46,6 +55,7 @@ module ContextDev
       sig do
         params(
           domain: String,
+          headers: T::Hash[Symbol, String],
           max_links: Integer,
           timeout_ms: Integer,
           url_regex: String,
@@ -55,6 +65,10 @@ module ContextDev
       def self.new(
         # Domain to build a sitemap for
         domain:,
+        # Optional outbound HTTP headers forwarded only to the target URL, sent as
+        # deep-object query params such as headers[X-Custom]=value. When provided, caching
+        # is bypassed: the result is neither read from nor written to cache.
+        headers: nil,
         # Maximum number of links to return from the sitemap crawl. Defaults to 10,000.
         # Minimum is 1, maximum is 100,000.
         max_links: nil,
@@ -73,6 +87,7 @@ module ContextDev
         override.returns(
           {
             domain: String,
+            headers: T::Hash[Symbol, String],
             max_links: Integer,
             timeout_ms: Integer,
             url_regex: String,

data/rbi/context_dev/models.rbi

@@ -32,6 +32,8 @@ module ContextDev
 
   UtilityPrefetchParams = ContextDev::Models::UtilityPrefetchParams
 
+  WebExtractCompetitorsParams = ContextDev::Models::WebExtractCompetitorsParams
+
   WebExtractFontsParams = ContextDev::Models::WebExtractFontsParams
 
   WebExtractParams = ContextDev::Models::WebExtractParams

data/rbi/context_dev/resources/web.rbi

@@ -60,6 +60,30 @@ module ContextDev
       )
       end
 
+      # Analyze a company's landing page and web search evidence to return direct
+      # competitors for the same product or market.
+      sig do
+        params(
+          domain: String,
+          num_competitors: Integer,
+          timeout_ms: Integer,
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(ContextDev::Models::WebExtractCompetitorsResponse)
+      end
+      def extract_competitors(
+        # Company domain to analyze, such as `stripe.com`. Full http(s) URLs are accepted
+        # and normalized to their domain.
+        domain:,
+        # Exact number of direct competitors to return. Defaults to 5.
+        num_competitors: 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,
+        request_options: {}
+      )
+      end
+
       # Scrape font information from a website including font families, usage
       # statistics, fallbacks, and element/word counts.
       sig do
@@ -296,6 +320,7 @@ module ContextDev
       sig do
         params(
           url: String,
+          headers: T::Hash[Symbol, String],
           include_frames: T::Boolean,
           max_age_ms: Integer,
           pdf: ContextDev::WebWebScrapeHTMLParams::Pdf::OrHash,
@@ -307,6 +332,10 @@ module ContextDev
       def web_scrape_html(
         # Full URL to scrape (must include http:// or https:// protocol)
         url:,
+        # Optional outbound HTTP headers forwarded only to the target URL, sent as
+        # deep-object query params such as headers[X-Custom]=value. When provided, caching
+        # is bypassed: the result is neither read from nor written to cache.
+        headers: nil,
         # When true, iframes are rendered inline into the returned HTML.
         include_frames: nil,
         # Return a cached result if a prior scrape for the same parameters exists and is
@@ -335,6 +364,7 @@ module ContextDev
         params(
           url: String,
           enrichment: ContextDev::WebWebScrapeImagesParams::Enrichment::OrHash,
+          headers: T::Hash[Symbol, String],
           max_age_ms: Integer,
           timeout_ms: Integer,
           wait_for_ms: Integer,
@@ -347,6 +377,10 @@ module ContextDev
         # Optional per-image processing, sent as deep-object query params such as
         # enrichment[resolution]=true.
         enrichment: nil,
+        # Optional outbound HTTP headers forwarded only to the target URL, sent as
+        # deep-object query params such as headers[X-Custom]=value. When provided, caching
+        # is bypassed: the result is neither read from nor written to cache.
+        headers: nil,
         # Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1
         # day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days).
         max_age_ms: nil,
@@ -365,6 +399,7 @@ module ContextDev
       sig do
         params(
           url: String,
+          headers: T::Hash[Symbol, String],
           include_frames: T::Boolean,
           include_images: T::Boolean,
           include_links: T::Boolean,
@@ -381,6 +416,10 @@ module ContextDev
         # Full URL to scrape into LLM usable Markdown (must include http:// or https://
         # protocol)
         url:,
+        # Optional outbound HTTP headers forwarded only to the target URL, sent as
+        # deep-object query params such as headers[X-Custom]=value. When provided, caching
+        # is bypassed: the result is neither read from nor written to cache.
+        headers: nil,
         # When true, the contents of iframes are rendered to Markdown.
         include_frames: nil,
         # Include image references in Markdown output
@@ -414,6 +453,7 @@ module ContextDev
       sig do
         params(
           domain: String,
+          headers: T::Hash[Symbol, String],
           max_links: Integer,
           timeout_ms: Integer,
           url_regex: String,
@@ -423,6 +463,10 @@ module ContextDev
       def web_scrape_sitemap(
         # Domain to build a sitemap for
         domain:,
+        # Optional outbound HTTP headers forwarded only to the target URL, sent as
+        # deep-object query params such as headers[X-Custom]=value. When provided, caching
+        # is bypassed: the result is neither read from nor written to cache.
+        headers: nil,
         # Maximum number of links to return from the sitemap crawl. Defaults to 10,000.
         # Minimum is 1, maximum is 100,000.
         max_links: nil,

data/sig/context_dev/models/web_extract_competitors_params.rbs

@@ -0,0 +1,36 @@
+module ContextDev
+  module Models
+    type web_extract_competitors_params =
+      { domain: String, num_competitors: Integer, timeout_ms: Integer }
+      & ContextDev::Internal::Type::request_parameters
+
+    class WebExtractCompetitorsParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      attr_accessor domain: String
+
+      attr_reader num_competitors: Integer?
+
+      def num_competitors=: (Integer) -> Integer
+
+      attr_reader timeout_ms: Integer?
+
+      def timeout_ms=: (Integer) -> Integer
+
+      def initialize: (
+        domain: String,
+        ?num_competitors: Integer,
+        ?timeout_ms: Integer,
+        ?request_options: ContextDev::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        domain: String,
+        num_competitors: Integer,
+        timeout_ms: Integer,
+        request_options: ContextDev::RequestOptions
+      }
+    end
+  end
+end