context.dev 1.8.0 → 1.10.0

data/rbi/context_dev/models/industry_retrieve_sic_params.rbi

@@ -0,0 +1,140 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class IndustryRetrieveSicParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::IndustryRetrieveSicParams,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      # Brand domain or title to retrieve SIC code for. If a valid domain is provided,
+      # it will be used for classification, otherwise, we will search for the brand
+      # using the provided title.
+      sig { returns(String) }
+      attr_accessor :input
+
+      # Maximum number of SIC codes to return. Must be between 1 and 10. Defaults to 5.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :max_results
+
+      sig { params(max_results: Integer).void }
+      attr_writer :max_results
+
+      # Minimum number of SIC codes to return. Must be at least 1. Defaults to 1.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :min_results
+
+      sig { params(min_results: Integer).void }
+      attr_writer :min_results
+
+      # 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
+
+      sig { params(timeout_ms: Integer).void }
+      attr_writer :timeout_ms
+
+      # Which SIC dataset to classify against. `original_sic` uses the 1987 Standard
+      # Industrial Classification system; `latest_sec` uses the current SIC list as
+      # published by the SEC. Defaults to `original_sic`.
+      sig do
+        returns(
+          T.nilable(ContextDev::IndustryRetrieveSicParams::Type::OrSymbol)
+        )
+      end
+      attr_reader :type
+
+      sig do
+        params(type: ContextDev::IndustryRetrieveSicParams::Type::OrSymbol).void
+      end
+      attr_writer :type
+
+      sig do
+        params(
+          input: String,
+          max_results: Integer,
+          min_results: Integer,
+          timeout_ms: Integer,
+          type: ContextDev::IndustryRetrieveSicParams::Type::OrSymbol,
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Brand domain or title to retrieve SIC code for. If a valid domain is provided,
+        # it will be used for classification, otherwise, we will search for the brand
+        # using the provided title.
+        input:,
+        # Maximum number of SIC codes to return. Must be between 1 and 10. Defaults to 5.
+        max_results: nil,
+        # Minimum number of SIC codes to return. Must be at least 1. Defaults to 1.
+        min_results: 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,
+        # Which SIC dataset to classify against. `original_sic` uses the 1987 Standard
+        # Industrial Classification system; `latest_sec` uses the current SIC list as
+        # published by the SEC. Defaults to `original_sic`.
+        type: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            input: String,
+            max_results: Integer,
+            min_results: Integer,
+            timeout_ms: Integer,
+            type: ContextDev::IndustryRetrieveSicParams::Type::OrSymbol,
+            request_options: ContextDev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Which SIC dataset to classify against. `original_sic` uses the 1987 Standard
+      # Industrial Classification system; `latest_sec` uses the current SIC list as
+      # published by the SEC. Defaults to `original_sic`.
+      module Type
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ContextDev::IndustryRetrieveSicParams::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ORIGINAL_SIC =
+          T.let(
+            :original_sic,
+            ContextDev::IndustryRetrieveSicParams::Type::TaggedSymbol
+          )
+        LATEST_SEC =
+          T.let(
+            :latest_sec,
+            ContextDev::IndustryRetrieveSicParams::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[ContextDev::IndustryRetrieveSicParams::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/context_dev/models/industry_retrieve_sic_response.rbi

@@ -0,0 +1,292 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class IndustryRetrieveSicResponse < ContextDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::Models::IndustryRetrieveSicResponse,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      # Echoes back which SIC dataset was used to classify the brand.
+      sig do
+        returns(
+          T.nilable(
+            ContextDev::Models::IndustryRetrieveSicResponse::Classification::TaggedSymbol
+          )
+        )
+      end
+      attr_reader :classification
+
+      sig do
+        params(
+          classification:
+            ContextDev::Models::IndustryRetrieveSicResponse::Classification::OrSymbol
+        ).void
+      end
+      attr_writer :classification
+
+      # Array of SIC codes with confidence scores. Extra fields depend on the requested
+      # classification: `original_sic` results include `majorGroup` and
+      # `majorGroupName`; `latest_sec` results include `office`.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[ContextDev::Models::IndustryRetrieveSicResponse::Code]
+          )
+        )
+      end
+      attr_reader :codes
+
+      sig do
+        params(
+          codes:
+            T::Array[
+              ContextDev::Models::IndustryRetrieveSicResponse::Code::OrHash
+            ]
+        ).void
+      end
+      attr_writer :codes
+
+      # Domain found for the brand
+      sig { returns(T.nilable(String)) }
+      attr_reader :domain
+
+      sig { params(domain: String).void }
+      attr_writer :domain
+
+      # Status of the response, e.g., 'ok'
+      sig { returns(T.nilable(String)) }
+      attr_reader :status
+
+      sig { params(status: String).void }
+      attr_writer :status
+
+      # Industry classification type, for sic api it will be `sic`
+      sig { returns(T.nilable(String)) }
+      attr_reader :type
+
+      sig { params(type: String).void }
+      attr_writer :type
+
+      sig do
+        params(
+          classification:
+            ContextDev::Models::IndustryRetrieveSicResponse::Classification::OrSymbol,
+          codes:
+            T::Array[
+              ContextDev::Models::IndustryRetrieveSicResponse::Code::OrHash
+            ],
+          domain: String,
+          status: String,
+          type: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Echoes back which SIC dataset was used to classify the brand.
+        classification: nil,
+        # Array of SIC codes with confidence scores. Extra fields depend on the requested
+        # classification: `original_sic` results include `majorGroup` and
+        # `majorGroupName`; `latest_sec` results include `office`.
+        codes: nil,
+        # Domain found for the brand
+        domain: nil,
+        # Status of the response, e.g., 'ok'
+        status: nil,
+        # Industry classification type, for sic api it will be `sic`
+        type: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            classification:
+              ContextDev::Models::IndustryRetrieveSicResponse::Classification::TaggedSymbol,
+            codes:
+              T::Array[ContextDev::Models::IndustryRetrieveSicResponse::Code],
+            domain: String,
+            status: String,
+            type: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Echoes back which SIC dataset was used to classify the brand.
+      module Classification
+        extend ContextDev::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ContextDev::Models::IndustryRetrieveSicResponse::Classification
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ORIGINAL_SIC =
+          T.let(
+            :original_sic,
+            ContextDev::Models::IndustryRetrieveSicResponse::Classification::TaggedSymbol
+          )
+        LATEST_SEC =
+          T.let(
+            :latest_sec,
+            ContextDev::Models::IndustryRetrieveSicResponse::Classification::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ContextDev::Models::IndustryRetrieveSicResponse::Classification::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class Code < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::IndustryRetrieveSicResponse::Code,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # SIC code (4-digit).
+        sig { returns(String) }
+        attr_accessor :code
+
+        # Confidence level for how well this SIC code matches the company description.
+        sig do
+          returns(
+            ContextDev::Models::IndustryRetrieveSicResponse::Code::Confidence::TaggedSymbol
+          )
+        end
+        attr_accessor :confidence
+
+        # SIC industry title.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # 2-digit major group identifier (the leading two digits of the code). Only
+        # present when `classification` is `original_sic`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :major_group
+
+        sig { params(major_group: String).void }
+        attr_writer :major_group
+
+        # Description of the 2-digit major group. Only present when `classification` is
+        # `original_sic`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :major_group_name
+
+        sig { params(major_group_name: String).void }
+        attr_writer :major_group_name
+
+        # SEC review office responsible for filings under this code. Only present when
+        # `classification` is `latest_sec`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :office
+
+        sig { params(office: String).void }
+        attr_writer :office
+
+        sig do
+          params(
+            code: String,
+            confidence:
+              ContextDev::Models::IndustryRetrieveSicResponse::Code::Confidence::OrSymbol,
+            name: String,
+            major_group: String,
+            major_group_name: String,
+            office: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # SIC code (4-digit).
+          code:,
+          # Confidence level for how well this SIC code matches the company description.
+          confidence:,
+          # SIC industry title.
+          name:,
+          # 2-digit major group identifier (the leading two digits of the code). Only
+          # present when `classification` is `original_sic`.
+          major_group: nil,
+          # Description of the 2-digit major group. Only present when `classification` is
+          # `original_sic`.
+          major_group_name: nil,
+          # SEC review office responsible for filings under this code. Only present when
+          # `classification` is `latest_sec`.
+          office: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              code: String,
+              confidence:
+                ContextDev::Models::IndustryRetrieveSicResponse::Code::Confidence::TaggedSymbol,
+              name: String,
+              major_group: String,
+              major_group_name: String,
+              office: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Confidence level for how well this SIC code matches the company description.
+        module Confidence
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::Models::IndustryRetrieveSicResponse::Code::Confidence
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          HIGH =
+            T.let(
+              :high,
+              ContextDev::Models::IndustryRetrieveSicResponse::Code::Confidence::TaggedSymbol
+            )
+          MEDIUM =
+            T.let(
+              :medium,
+              ContextDev::Models::IndustryRetrieveSicResponse::Code::Confidence::TaggedSymbol
+            )
+          LOW =
+            T.let(
+              :low,
+              ContextDev::Models::IndustryRetrieveSicResponse::Code::Confidence::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Models::IndustryRetrieveSicResponse::Code::Confidence::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/context_dev/models.rbi

@@ -25,6 +25,8 @@ module ContextDev
 
   IndustryRetrieveNaicsParams = ContextDev::Models::IndustryRetrieveNaicsParams
 
+  IndustryRetrieveSicParams = ContextDev::Models::IndustryRetrieveSicParams
+
   UtilityPrefetchByEmailParams =
     ContextDev::Models::UtilityPrefetchByEmailParams
 

data/rbi/context_dev/resources/ai.rbi

@@ -31,12 +31,12 @@ module ContextDev
       )
       end
 
-      # Beta feature: Given a single URL, determines if it is a product detail page,
-      # classifies the platform/product type, and extracts the product information.
-      # Supports Amazon, TikTok Shop, Etsy, and generic ecommerce sites.
+      # Given a single URL, determines if it is a product page and extracts the product
+      # information.
       sig do
         params(
           url: String,
+          max_age_ms: Integer,
           timeout_ms: Integer,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(ContextDev::Models::AIExtractProductResponse)
@@ -44,6 +44,10 @@ module ContextDev
       def extract_product(
         # The product page URL to extract product data from.
         url:,
+        # Return a cached result if a prior scrape for the same parameters exists and is
+        # younger than this many milliseconds. Defaults to 7 days (604800000 ms) when
+        # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
+        max_age_ms: nil,
         # Optional timeout in milliseconds for the request. Maximum allowed value is
         # 300000ms (5 minutes).
         timeout_ms: nil,
@@ -51,9 +55,9 @@ module ContextDev
       )
       end
 
-      # Beta feature: Extract product information from a brand's website. We will
-      # analyze the website and return a list of products with details such as name,
-      # description, image, pricing, features, and more.
+      # Extract product information from a brand's website. We will analyze the website
+      # and return a list of products with details such as name, description, image,
+      # pricing, features, and more.
       sig do
         params(
           body:

data/rbi/context_dev/resources/industry.rbi

@@ -31,6 +31,40 @@ module ContextDev
       )
       end
 
+      # Classify any brand into Standard Industrial Classification (SIC) codes from its
+      # domain or name. Choose between the original SIC system (`original_sic`) or the
+      # latest SIC list maintained by the SEC (`latest_sec`).
+      sig do
+        params(
+          input: String,
+          max_results: Integer,
+          min_results: Integer,
+          timeout_ms: Integer,
+          type: ContextDev::IndustryRetrieveSicParams::Type::OrSymbol,
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(ContextDev::Models::IndustryRetrieveSicResponse)
+      end
+      def retrieve_sic(
+        # Brand domain or title to retrieve SIC code for. If a valid domain is provided,
+        # it will be used for classification, otherwise, we will search for the brand
+        # using the provided title.
+        input:,
+        # Maximum number of SIC codes to return. Must be between 1 and 10. Defaults to 5.
+        max_results: nil,
+        # Minimum number of SIC codes to return. Must be at least 1. Defaults to 1.
+        min_results: 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,
+        # Which SIC dataset to classify against. `original_sic` uses the 1987 Standard
+        # Industrial Classification system; `latest_sec` uses the current SIC list as
+        # published by the SEC. Defaults to `original_sic`.
+        type: nil,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: ContextDev::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/context_dev/resources/utility.rbi

@@ -4,9 +4,7 @@ module ContextDev
   module Resources
     class Utility
       # Signal that you may fetch brand data for a particular domain soon to improve
-      # latency. This endpoint does not charge credits and is available for paid
-      # customers to optimize future requests. [You must be on a paid plan to use this
-      # endpoint]
+      # latency.
       sig do
         params(
           domain: String,
@@ -28,9 +26,7 @@ module ContextDev
       # Signal that you may fetch brand data for a particular domain soon to improve
       # latency. This endpoint accepts an email address, extracts the domain from it,
       # validates that it's not a disposable or free email provider, and queues the
-      # domain for prefetching. This endpoint does not charge credits and is available
-      # for paid customers to optimize future requests. [You must be on a paid plan to
-      # use this endpoint]
+      # domain for prefetching.
       sig do
         params(
           email: String,

data/sig/context_dev/models/ai_extract_product_params.rbs

@@ -1,7 +1,7 @@
 module ContextDev
   module Models
     type ai_extract_product_params =
-      { url: String, timeout_ms: Integer }
+      { url: String, max_age_ms: Integer, timeout_ms: Integer }
       & ContextDev::Internal::Type::request_parameters
 
     class AIExtractProductParams < ContextDev::Internal::Type::BaseModel
@@ -10,18 +10,24 @@ module ContextDev
 
       attr_accessor url: String
 
+      attr_reader max_age_ms: Integer?
+
+      def max_age_ms=: (Integer) -> Integer
+
       attr_reader timeout_ms: Integer?
 
       def timeout_ms=: (Integer) -> Integer
 
       def initialize: (
         url: String,
+        ?max_age_ms: Integer,
         ?timeout_ms: Integer,
         ?request_options: ContextDev::request_opts
       ) -> void
 
       def to_hash: -> {
         url: String,
+        max_age_ms: Integer,
         timeout_ms: Integer,
         request_options: ContextDev::RequestOptions
       }

data/sig/context_dev/models/ai_extract_products_params.rbs

@@ -28,11 +28,20 @@ module ContextDev
         extend ContextDev::Internal::Type::Union
 
         type by_domain =
-          { domain: String, max_products: Integer, timeout_ms: Integer }
+          {
+            domain: String,
+            max_age_ms: Integer,
+            max_products: Integer,
+            timeout_ms: Integer
+          }
 
         class ByDomain < ContextDev::Internal::Type::BaseModel
           attr_accessor domain: String
 
+          attr_reader max_age_ms: Integer?
+
+          def max_age_ms=: (Integer) -> Integer
+
           attr_reader max_products: Integer?
 
           def max_products=: (Integer) -> Integer
@@ -43,23 +52,34 @@ module ContextDev
 
           def initialize: (
             domain: String,
+            ?max_age_ms: Integer,
             ?max_products: Integer,
             ?timeout_ms: Integer
           ) -> void
 
           def to_hash: -> {
             domain: String,
+            max_age_ms: Integer,
             max_products: Integer,
             timeout_ms: Integer
           }
         end
 
         type by_direct_url =
-          { direct_url: String, max_products: Integer, timeout_ms: Integer }
+          {
+            direct_url: String,
+            max_age_ms: Integer,
+            max_products: Integer,
+            timeout_ms: Integer
+          }
 
         class ByDirectURL < ContextDev::Internal::Type::BaseModel
           attr_accessor direct_url: String
 
+          attr_reader max_age_ms: Integer?
+
+          def max_age_ms=: (Integer) -> Integer
+
           attr_reader max_products: Integer?
 
           def max_products=: (Integer) -> Integer
@@ -70,12 +90,14 @@ module ContextDev
 
           def initialize: (
             direct_url: String,
+            ?max_age_ms: Integer,
             ?max_products: Integer,
             ?timeout_ms: Integer
           ) -> void
 
           def to_hash: -> {
             direct_url: String,
+            max_age_ms: Integer,
             max_products: Integer,
             timeout_ms: Integer
           }