context.dev 1.36.0 → 2.1.0

data/lib/context_dev/models/utility_prefetch_params.rb

@@ -7,11 +7,17 @@ module ContextDev
       extend ContextDev::Internal::Type::RequestParameters::Converter
       include ContextDev::Internal::Type::RequestParameters
 
-      # @!attribute domain
-      #   Domain name to prefetch brand data for
+      # @!attribute identifier
+      #   Identifier of the brand to prefetch. Provide exactly one of domain or email.
       #
-      #   @return [String]
-      required :domain, String
+      #   @return [ContextDev::Models::UtilityPrefetchParams::Identifier::UtilityPrefetchDomainIdentifier, ContextDev::Models::UtilityPrefetchParams::Identifier::UtilityPrefetchEmailIdentifier]
+      required :identifier, union: -> { ContextDev::UtilityPrefetchParams::Identifier }
+
+      # @!attribute type
+      #   What to prefetch. Currently only 'brand' is supported.
+      #
+      #   @return [Symbol, ContextDev::Models::UtilityPrefetchParams::Type]
+      required :type, enum: -> { ContextDev::UtilityPrefetchParams::Type }
 
       # @!attribute timeout_ms
       #   Optional timeout in milliseconds for the request. If the request takes longer
@@ -21,15 +27,73 @@ module ContextDev
       #   @return [Integer, nil]
       optional :timeout_ms, Integer, api_name: :timeoutMS
 
-      # @!method initialize(domain:, timeout_ms: nil, request_options: {})
+      # @!method initialize(identifier:, type:, timeout_ms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::UtilityPrefetchParams} for more details.
       #
-      #   @param domain [String] Domain name to prefetch brand data for
+      #   @param identifier [ContextDev::Models::UtilityPrefetchParams::Identifier::UtilityPrefetchDomainIdentifier, ContextDev::Models::UtilityPrefetchParams::Identifier::UtilityPrefetchEmailIdentifier] Identifier of the brand to prefetch. Provide exactly one of domain or email.
+      #
+      #   @param type [Symbol, ContextDev::Models::UtilityPrefetchParams::Type] What to prefetch. Currently only 'brand' is supported.
       #
       #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
       #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+
+      # Identifier of the brand to prefetch. Provide exactly one of domain or email.
+      module Identifier
+        extend ContextDev::Internal::Type::Union
+
+        # Prefetch brand data by domain.
+        variant -> { ContextDev::UtilityPrefetchParams::Identifier::UtilityPrefetchDomainIdentifier }
+
+        # Prefetch brand data by email. The domain will be extracted and validated.
+        variant -> { ContextDev::UtilityPrefetchParams::Identifier::UtilityPrefetchEmailIdentifier }
+
+        class UtilityPrefetchDomainIdentifier < ContextDev::Internal::Type::BaseModel
+          # @!attribute domain
+          #   Domain name to prefetch brand data for
+          #
+          #   @return [String]
+          required :domain, String
+
+          # @!method initialize(domain:)
+          #   Prefetch brand data by domain.
+          #
+          #   @param domain [String] Domain name to prefetch brand data for
+        end
+
+        class UtilityPrefetchEmailIdentifier < ContextDev::Internal::Type::BaseModel
+          # @!attribute email
+          #   Email address to prefetch brand data for. The domain will be extracted from the
+          #   email. Free email providers (gmail.com, yahoo.com, etc.) and disposable email
+          #   addresses are not allowed.
+          #
+          #   @return [String]
+          required :email, String
+
+          # @!method initialize(email:)
+          #   Some parameter documentations has been truncated, see
+          #   {ContextDev::Models::UtilityPrefetchParams::Identifier::UtilityPrefetchEmailIdentifier}
+          #   for more details.
+          #
+          #   Prefetch brand data by email. The domain will be extracted and validated.
+          #
+          #   @param email [String] Email address to prefetch brand data for. The domain will be extracted from the
+        end
+
+        # @!method self.variants
+        #   @return [Array(ContextDev::Models::UtilityPrefetchParams::Identifier::UtilityPrefetchDomainIdentifier, ContextDev::Models::UtilityPrefetchParams::Identifier::UtilityPrefetchEmailIdentifier)]
+      end
+
+      # What to prefetch. Currently only 'brand' is supported.
+      module Type
+        extend ContextDev::Internal::Type::Enum
+
+        BRAND = :brand
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/context_dev/models/utility_prefetch_response.rb

@@ -29,7 +29,14 @@ module ContextDev
       #   @return [String, nil]
       optional :status, String
 
-      # @!method initialize(domain: nil, key_metadata: nil, message: nil, status: nil)
+      # @!attribute type
+      #   The type of prefetch that was queued, echoed from the request (currently always
+      #   'brand')
+      #
+      #   @return [Symbol, ContextDev::Models::UtilityPrefetchResponse::Type, nil]
+      optional :type, enum: -> { ContextDev::Models::UtilityPrefetchResponse::Type }
+
+      # @!method initialize(domain: nil, key_metadata: nil, message: nil, status: nil, type: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::UtilityPrefetchResponse} for more details.
       #
@@ -40,6 +47,8 @@ module ContextDev
       #   @param message [String] Success message
       #
       #   @param status [String] Status of the response, e.g., 'ok'
+      #
+      #   @param type [Symbol, ContextDev::Models::UtilityPrefetchResponse::Type] The type of prefetch that was queued, echoed from the request (currently always
 
       # @see ContextDev::Models::UtilityPrefetchResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
@@ -63,6 +72,19 @@ module ContextDev
         #
         #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
       end
+
+      # The type of prefetch that was queued, echoed from the request (currently always
+      # 'brand')
+      #
+      # @see ContextDev::Models::UtilityPrefetchResponse#type
+      module Type
+        extend ContextDev::Internal::Type::Enum
+
+        BRAND = :brand
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/context_dev/models/web_extract_response.rb

@@ -63,6 +63,13 @@ module ContextDev
         #   @return [Integer]
         required :max_crawl_depth, Integer, api_name: :maxCrawlDepth
 
+        # @!attribute num_blocked
+        #   Number of crawled pages excluded because they were anti-bot challenges, error
+        #   pages, or parked-domain placeholders.
+        #
+        #   @return [Integer]
+        required :num_blocked, Integer, api_name: :numBlocked
+
         # @!attribute num_failed
         #
         #   @return [Integer]
@@ -83,11 +90,20 @@ module ContextDev
         #   @return [Integer]
         required :num_urls, Integer, api_name: :numUrls
 
-        # @!method initialize(max_crawl_depth:, num_failed:, num_skipped:, num_succeeded:, num_urls:)
+        # @!method initialize(max_crawl_depth:, num_blocked:, num_failed:, num_skipped:, num_succeeded:, num_urls:)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::WebExtractResponse::Metadata} for more details.
+        #
         #   @param max_crawl_depth [Integer]
+        #
+        #   @param num_blocked [Integer] Number of crawled pages excluded because they were anti-bot challenges, error pa
+        #
         #   @param num_failed [Integer]
+        #
         #   @param num_skipped [Integer]
+        #
         #   @param num_succeeded [Integer]
+        #
         #   @param num_urls [Integer]
       end
 

data/lib/context_dev/models/web_web_crawl_md_params.rb

@@ -92,6 +92,14 @@ module ContextDev
       #   @return [ContextDev::Models::WebWebCrawlMdParams::Pdf, nil]
       optional :pdf, -> { ContextDev::WebWebCrawlMdParams::Pdf }
 
+      # @!attribute settle_animations
+      #   When true, waits briefly for CSS and transition animations to settle before
+      #   extracting each crawled page. Defaults to false. This adds a bit of latency in
+      #   exchange for more stable output on animated pages.
+      #
+      #   @return [Boolean, nil]
+      optional :settle_animations, ContextDev::Internal::Type::Boolean, api_name: :settleAnimations
+
       # @!attribute shorten_base64_images
       #   Truncate base64-encoded image data in the Markdown output
       #
@@ -135,7 +143,7 @@ module ContextDev
       #   @return [Integer, nil]
       optional :wait_for_ms, Integer, api_name: :waitForMs
 
-      # @!method initialize(url:, country: nil, exclude_selectors: nil, follow_subdomains: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, shorten_base64_images: nil, stop_after_ms: nil, timeout_ms: nil, url_regex: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {})
+      # @!method initialize(url:, country: nil, exclude_selectors: nil, follow_subdomains: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, settle_animations: nil, shorten_base64_images: nil, stop_after_ms: nil, timeout_ms: nil, url_regex: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebWebCrawlMdParams} for more details.
       #
@@ -163,6 +171,8 @@ module ContextDev
       #
       #   @param pdf [ContextDev::Models::WebWebCrawlMdParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and OCR to an inclu
       #
+      #   @param settle_animations [Boolean] When true, waits briefly for CSS and transition animations to settle before extr
+      #
       #   @param shorten_base64_images [Boolean] Truncate base64-encoded image data in the Markdown output
       #
       #   @param stop_after_ms [Integer] Soft time budget for the crawl in milliseconds. After each scrape, the crawler c

data/lib/context_dev/models/web_web_scrape_html_params.rb

@@ -65,6 +65,14 @@ module ContextDev
       #   @return [ContextDev::Models::WebWebScrapeHTMLParams::Pdf, nil]
       optional :pdf, -> { ContextDev::WebWebScrapeHTMLParams::Pdf }
 
+      # @!attribute settle_animations
+      #   When true, waits briefly for CSS and transition animations to settle before
+      #   extracting HTML. Defaults to false. This adds a bit of latency in exchange for
+      #   more stable output on animated pages.
+      #
+      #   @return [Boolean, nil]
+      optional :settle_animations, ContextDev::Internal::Type::Boolean
+
       # @!attribute timeout_ms
       #   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
@@ -87,7 +95,7 @@ module ContextDev
       #   @return [Integer, nil]
       optional :wait_for_ms, Integer
 
-      # @!method initialize(url:, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {})
+      # @!method initialize(url:, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, settle_animations: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebWebScrapeHTMLParams} for more details.
       #
@@ -107,6 +115,8 @@ module ContextDev
       #
       #   @param pdf [ContextDev::Models::WebWebScrapeHTMLParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and OCR to an inclu
       #
+      #   @param settle_animations [Boolean] When true, waits briefly for CSS and transition animations to settle before extr
+      #
       #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
       #
       #   @param use_main_content_only [Boolean] When true, return only the page's main content in the HTML response, excluding h

data/lib/context_dev/models/web_web_scrape_html_response.rb

@@ -26,7 +26,9 @@ module ContextDev
 
       # @!attribute type
       #   Detected content type of the returned `html` field. Sitemaps and feeds are
-      #   surfaced as `xml`; ordinary pages are `html`.
+      #   surfaced as `xml`; ordinary pages are `html`. Excel workbooks are surfaced as
+      #   `xlsx`/`xls` with the extracted sheets as HTML tables; PowerPoint presentations
+      #   are surfaced as `pptx`/`ppt` with the extracted slides as HTML.
       #
       #   @return [Symbol, ContextDev::Models::WebWebScrapeHTMLResponse::Type]
       required :type, enum: -> { ContextDev::Models::WebWebScrapeHTMLResponse::Type }
@@ -320,7 +322,9 @@ module ContextDev
       end
 
       # Detected content type of the returned `html` field. Sitemaps and feeds are
-      # surfaced as `xml`; ordinary pages are `html`.
+      # surfaced as `xml`; ordinary pages are `html`. Excel workbooks are surfaced as
+      # `xlsx`/`xls` with the extracted sheets as HTML tables; PowerPoint presentations
+      # are surfaced as `pptx`/`ppt` with the extracted slides as HTML.
       #
       # @see ContextDev::Models::WebWebScrapeHTMLResponse#type
       module Type
@@ -336,6 +340,10 @@ module ContextDev
         PDF = :pdf
         DOCX = :docx
         DOC = :doc
+        XLSX = :xlsx
+        XLS = :xls
+        PPTX = :pptx
+        PPT = :ppt
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/context_dev/models/web_web_scrape_images_params.rb

@@ -13,6 +13,15 @@ module ContextDev
       #   @return [String]
       required :url, String
 
+      # @!attribute dedupe
+      #   When true, visually duplicate images are removed: every image is loaded and
+      #   perceptually hashed, and only the highest-resolution copy of each duplicate
+      #   group is kept. Images that cannot be downloaded or hashed are kept. Default:
+      #   false.
+      #
+      #   @return [Boolean, nil]
+      optional :dedupe, ContextDev::Internal::Type::Boolean
+
       # @!attribute enrichment
       #   Optional per-image processing, sent as deep-object query params such as
       #   enrichment[resolution]=true.
@@ -50,12 +59,14 @@ module ContextDev
       #   @return [Integer, nil]
       optional :wait_for_ms, Integer
 
-      # @!method initialize(url:, enrichment: nil, headers: nil, max_age_ms: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {})
+      # @!method initialize(url:, dedupe: nil, enrichment: nil, headers: nil, max_age_ms: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebWebScrapeImagesParams} for more details.
       #
       #   @param url [String] Page URL to inspect. Must include http:// or https://.
       #
+      #   @param dedupe [Boolean] When true, visually duplicate images are removed: every image is loaded and perc
+      #
       #   @param enrichment [ContextDev::Models::WebWebScrapeImagesParams::Enrichment] Optional per-image processing, sent as deep-object query params such as enrichme
       #
       #   @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob

data/lib/context_dev/models/web_web_scrape_md_params.rb

@@ -78,6 +78,14 @@ module ContextDev
       #   @return [ContextDev::Models::WebWebScrapeMdParams::Pdf, nil]
       optional :pdf, -> { ContextDev::WebWebScrapeMdParams::Pdf }
 
+      # @!attribute settle_animations
+      #   When true, waits briefly for CSS and transition animations to settle before
+      #   converting to Markdown. Defaults to false. This adds a bit of latency in
+      #   exchange for more stable output on animated pages.
+      #
+      #   @return [Boolean, nil]
+      optional :settle_animations, ContextDev::Internal::Type::Boolean
+
       # @!attribute shorten_base64_images
       #   Shorten base64-encoded image data in the Markdown output
       #
@@ -106,7 +114,7 @@ module ContextDev
       #   @return [Integer, nil]
       optional :wait_for_ms, Integer
 
-      # @!method initialize(url:, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {})
+      # @!method initialize(url:, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, settle_animations: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::WebWebScrapeMdParams} for more details.
       #
@@ -130,6 +138,8 @@ module ContextDev
       #
       #   @param pdf [ContextDev::Models::WebWebScrapeMdParams::Pdf] PDF parsing controls. Use start/end to limit text extraction and OCR to an inclu
       #
+      #   @param settle_animations [Boolean] When true, waits briefly for CSS and transition animations to settle before conv
+      #
       #   @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output
       #
       #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th

data/lib/context_dev/models.rb

@@ -39,31 +39,39 @@ module ContextDev
     mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
   end
 
-  AIAIQueryParams = ContextDev::Models::AIAIQueryParams
-
   AIExtractProductParams = ContextDev::Models::AIExtractProductParams
 
   AIExtractProductsParams = ContextDev::Models::AIExtractProductsParams
 
-  BrandIdentifyFromTransactionParams = ContextDev::Models::BrandIdentifyFromTransactionParams
+  BrandRetrieveParams = ContextDev::Models::BrandRetrieveParams
 
-  BrandRetrieveByEmailParams = ContextDev::Models::BrandRetrieveByEmailParams
+  BrandRetrieveSimplifiedParams = ContextDev::Models::BrandRetrieveSimplifiedParams
 
-  BrandRetrieveByIsinParams = ContextDev::Models::BrandRetrieveByIsinParams
+  IndustryRetrieveNaicsParams = ContextDev::Models::IndustryRetrieveNaicsParams
 
-  BrandRetrieveByNameParams = ContextDev::Models::BrandRetrieveByNameParams
+  IndustryRetrieveSicParams = ContextDev::Models::IndustryRetrieveSicParams
 
-  BrandRetrieveByTickerParams = ContextDev::Models::BrandRetrieveByTickerParams
+  MonitorCreateParams = ContextDev::Models::MonitorCreateParams
 
-  BrandRetrieveParams = ContextDev::Models::BrandRetrieveParams
+  MonitorDeleteParams = ContextDev::Models::MonitorDeleteParams
 
-  BrandRetrieveSimplifiedParams = ContextDev::Models::BrandRetrieveSimplifiedParams
+  MonitorListAccountChangesParams = ContextDev::Models::MonitorListAccountChangesParams
 
-  IndustryRetrieveNaicsParams = ContextDev::Models::IndustryRetrieveNaicsParams
+  MonitorListAccountRunsParams = ContextDev::Models::MonitorListAccountRunsParams
 
-  IndustryRetrieveSicParams = ContextDev::Models::IndustryRetrieveSicParams
+  MonitorListChangesParams = ContextDev::Models::MonitorListChangesParams
+
+  MonitorListParams = ContextDev::Models::MonitorListParams
+
+  MonitorListRunsParams = ContextDev::Models::MonitorListRunsParams
+
+  MonitorRetrieveChangeParams = ContextDev::Models::MonitorRetrieveChangeParams
+
+  MonitorRetrieveParams = ContextDev::Models::MonitorRetrieveParams
+
+  MonitorRunParams = ContextDev::Models::MonitorRunParams
 
-  UtilityPrefetchByEmailParams = ContextDev::Models::UtilityPrefetchByEmailParams
+  MonitorUpdateParams = ContextDev::Models::MonitorUpdateParams
 
   UtilityPrefetchParams = ContextDev::Models::UtilityPrefetchParams
 

data/lib/context_dev/resources/ai.rb

@@ -3,39 +3,6 @@
 module ContextDev
   module Resources
     class AI
-      # Some parameter documentations has been truncated, see
-      # {ContextDev::Models::AIAIQueryParams} for more details.
-      #
-      # Use AI to extract specific data points from a brand's website. The AI will crawl
-      # the website and extract the requested information based on the provided data
-      # points.
-      #
-      # @overload ai_query(data_to_extract:, domain:, specific_pages: nil, timeout_ms: nil, request_options: {})
-      #
-      # @param data_to_extract [Array<ContextDev::Models::AIAIQueryParams::DataToExtract>] Array of data points to extract from the website
-      #
-      # @param domain [String] The domain name to analyze
-      #
-      # @param specific_pages [ContextDev::Models::AIAIQueryParams::SpecificPages] Optional object specifying which pages to analyze
-      #
-      # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
-      #
-      # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [ContextDev::Models::AIAIQueryResponse]
-      #
-      # @see ContextDev::Models::AIAIQueryParams
-      def ai_query(params)
-        parsed, options = ContextDev::AIAIQueryParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "brand/ai/query",
-          body: parsed,
-          model: ContextDev::Models::AIAIQueryResponse,
-          options: options
-        )
-      end
-
       # Some parameter documentations has been truncated, see
       # {ContextDev::Models::AIExtractProductParams} for more details.
       #