context.dev 2.8.0 → 2.10.0

data/lib/context_dev/models/parse_handle_params.rb

@@ -28,23 +28,24 @@ module ContextDev
       # @!attribute include_images
       #   Include image references in Markdown output
       #
-      #   @return [Boolean, Symbol, ContextDev::Models::ParseHandleParams::IncludeImages, nil]
-      optional :include_images, union: -> { ContextDev::ParseHandleParams::IncludeImages }
+      #   @return [Boolean, nil]
+      optional :include_images, ContextDev::Internal::Type::Boolean
 
       # @!attribute include_links
       #   Preserve hyperlinks in Markdown output
       #
-      #   @return [Boolean, Symbol, ContextDev::Models::ParseHandleParams::IncludeLinks, nil]
-      optional :include_links, union: -> { ContextDev::ParseHandleParams::IncludeLinks }
+      #   @return [Boolean, nil]
+      optional :include_links, ContextDev::Internal::Type::Boolean
 
       # @!attribute ocr
-      #   When true for PDF inputs, detect and OCR images embedded in the selected pages,
-      #   inserting recognized text at each image's position in page reading order while
-      #   preserving the PDF text layer. pdf.start/pdf.end limit the inclusive page range.
-      #   When false, all OCR is disabled, including the automatic scanned-PDF fallback.
+      #   When true for PDF inputs, OCR the selected pages that have no usable text layer
+      #   (scans), replacing each recovered page's text with the OCR result while pages
+      #   with a real text layer keep it. pdf.start/pdf.end limit the inclusive page
+      #   range. Billed at 1 credit per page OCR actually recovered, on top of the base
+      #   request cost. When false, no OCR runs.
       #
-      #   @return [Boolean, Symbol, ContextDev::Models::ParseHandleParams::Ocr, nil]
-      optional :ocr, union: -> { ContextDev::ParseHandleParams::Ocr }
+      #   @return [Boolean, nil]
+      optional :ocr, ContextDev::Internal::Type::Boolean
 
       # @!attribute pdf
       #   PDF page-range options as a JSON object, e.g. {"start": 2, "end": 5}.
@@ -55,8 +56,8 @@ module ContextDev
       # @!attribute shorten_base64_images
       #   Shorten base64-encoded image data in the Markdown output
       #
-      #   @return [Boolean, Symbol, ContextDev::Models::ParseHandleParams::ShortenBase64Images, nil]
-      optional :shorten_base64_images, union: -> { ContextDev::ParseHandleParams::ShortenBase64Images }
+      #   @return [Boolean, nil]
+      optional :shorten_base64_images, ContextDev::Internal::Type::Boolean
 
       # @!attribute tags
       #   Optional comma-separated caller-defined tags for tracking this request. Tags are
@@ -69,8 +70,8 @@ module ContextDev
       # @!attribute use_main_content_only
       #   Extract only the main content from HTML-like inputs
       #
-      #   @return [Boolean, Symbol, ContextDev::Models::ParseHandleParams::UseMainContentOnly, nil]
-      optional :use_main_content_only, union: -> { ContextDev::ParseHandleParams::UseMainContentOnly }
+      #   @return [Boolean, nil]
+      optional :use_main_content_only, ContextDev::Internal::Type::Boolean
 
       # @!attribute zdr
       #   Set to enabled to bypass shared caches and omit request and response content
@@ -91,19 +92,19 @@ module ContextDev
       #
       #   @param extension [Symbol, ContextDev::Models::ParseHandleParams::Extension] Optional file extension hint, such as pdf, docx, xlsx, pptx, html, json, csv, md
       #
-      #   @param include_images [Boolean, Symbol, ContextDev::Models::ParseHandleParams::IncludeImages] Include image references in Markdown output
+      #   @param include_images [Boolean] Include image references in Markdown output
       #
-      #   @param include_links [Boolean, Symbol, ContextDev::Models::ParseHandleParams::IncludeLinks] Preserve hyperlinks in Markdown output
+      #   @param include_links [Boolean] Preserve hyperlinks in Markdown output
       #
-      #   @param ocr [Boolean, Symbol, ContextDev::Models::ParseHandleParams::Ocr] When true for PDF inputs, detect and OCR images embedded in the selected pages,
+      #   @param ocr [Boolean] When true for PDF inputs, OCR the selected pages that have no usable text layer
       #
       #   @param pdf [ContextDev::Models::ParseHandleParams::Pdf] PDF page-range options as a JSON object, e.g. {"start": 2, "end": 5}.
       #
-      #   @param shorten_base64_images [Boolean, Symbol, ContextDev::Models::ParseHandleParams::ShortenBase64Images] Shorten base64-encoded image data in the Markdown output
+      #   @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output
       #
       #   @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
       #
-      #   @param use_main_content_only [Boolean, Symbol, ContextDev::Models::ParseHandleParams::UseMainContentOnly] Extract only the main content from HTML-like inputs
+      #   @param use_main_content_only [Boolean] Extract only the main content from HTML-like inputs
       #
       #   @param zdr [Symbol, ContextDev::Models::ParseHandleParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
       #
@@ -189,84 +190,6 @@ module ContextDev
         #   @return [Array<Symbol>]
       end
 
-      # Include image references in Markdown output
-      module IncludeImages
-        extend ContextDev::Internal::Type::Union
-
-        variant ContextDev::Internal::Type::Boolean
-
-        variant const: -> { ContextDev::Models::ParseHandleParams::IncludeImages::TRUE }
-
-        variant const: -> { ContextDev::Models::ParseHandleParams::IncludeImages::FALSE }
-
-        # @!method self.variants
-        #   @return [Array(Boolean, Symbol)]
-
-        define_sorbet_constant!(:Variants) do
-          T.type_alias { T.any(T::Boolean, ContextDev::ParseHandleParams::IncludeImages::TaggedSymbol) }
-        end
-
-        # @!group
-
-        TRUE = :true
-        FALSE = :false
-
-        # @!endgroup
-      end
-
-      # Preserve hyperlinks in Markdown output
-      module IncludeLinks
-        extend ContextDev::Internal::Type::Union
-
-        variant ContextDev::Internal::Type::Boolean
-
-        variant const: -> { ContextDev::Models::ParseHandleParams::IncludeLinks::TRUE }
-
-        variant const: -> { ContextDev::Models::ParseHandleParams::IncludeLinks::FALSE }
-
-        # @!method self.variants
-        #   @return [Array(Boolean, Symbol)]
-
-        define_sorbet_constant!(:Variants) do
-          T.type_alias { T.any(T::Boolean, ContextDev::ParseHandleParams::IncludeLinks::TaggedSymbol) }
-        end
-
-        # @!group
-
-        TRUE = :true
-        FALSE = :false
-
-        # @!endgroup
-      end
-
-      # When true for PDF inputs, detect and OCR images embedded in the selected pages,
-      # inserting recognized text at each image's position in page reading order while
-      # preserving the PDF text layer. pdf.start/pdf.end limit the inclusive page range.
-      # When false, all OCR is disabled, including the automatic scanned-PDF fallback.
-      module Ocr
-        extend ContextDev::Internal::Type::Union
-
-        variant ContextDev::Internal::Type::Boolean
-
-        variant const: -> { ContextDev::Models::ParseHandleParams::Ocr::TRUE }
-
-        variant const: -> { ContextDev::Models::ParseHandleParams::Ocr::FALSE }
-
-        # @!method self.variants
-        #   @return [Array(Boolean, Symbol)]
-
-        define_sorbet_constant!(:Variants) do
-          T.type_alias { T.any(T::Boolean, ContextDev::ParseHandleParams::Ocr::TaggedSymbol) }
-        end
-
-        # @!group
-
-        TRUE = :true
-        FALSE = :false
-
-        # @!endgroup
-      end
-
       class Pdf < ContextDev::Internal::Type::BaseModel
         # @!attribute end_
         #   Last 1-based PDF page to parse. When omitted, parsing ends at the last page.
@@ -292,56 +215,6 @@ module ContextDev
         #   @param start [Integer] First 1-based PDF page to parse. When omitted, parsing starts at the first page.
       end
 
-      # Shorten base64-encoded image data in the Markdown output
-      module ShortenBase64Images
-        extend ContextDev::Internal::Type::Union
-
-        variant ContextDev::Internal::Type::Boolean
-
-        variant const: -> { ContextDev::Models::ParseHandleParams::ShortenBase64Images::TRUE }
-
-        variant const: -> { ContextDev::Models::ParseHandleParams::ShortenBase64Images::FALSE }
-
-        # @!method self.variants
-        #   @return [Array(Boolean, Symbol)]
-
-        define_sorbet_constant!(:Variants) do
-          T.type_alias { T.any(T::Boolean, ContextDev::ParseHandleParams::ShortenBase64Images::TaggedSymbol) }
-        end
-
-        # @!group
-
-        TRUE = :true
-        FALSE = :false
-
-        # @!endgroup
-      end
-
-      # Extract only the main content from HTML-like inputs
-      module UseMainContentOnly
-        extend ContextDev::Internal::Type::Union
-
-        variant ContextDev::Internal::Type::Boolean
-
-        variant const: -> { ContextDev::Models::ParseHandleParams::UseMainContentOnly::TRUE }
-
-        variant const: -> { ContextDev::Models::ParseHandleParams::UseMainContentOnly::FALSE }
-
-        # @!method self.variants
-        #   @return [Array(Boolean, Symbol)]
-
-        define_sorbet_constant!(:Variants) do
-          T.type_alias { T.any(T::Boolean, ContextDev::ParseHandleParams::UseMainContentOnly::TaggedSymbol) }
-        end
-
-        # @!group
-
-        TRUE = :true
-        FALSE = :false
-
-        # @!endgroup
-      end
-
       # Set to enabled to bypass shared caches and omit request and response content
       # from retained usage logs. Requires zero data retention to be enabled for your
       # organization (contact support@context.dev), otherwise the request fails with

data/lib/context_dev/models/person_enrich_params.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::People#enrich
+    class PersonEnrichParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      # @!attribute company
+      #
+      #   @return [ContextDev::Models::PersonEnrichParams::Company, nil]
+      optional :company, -> { ContextDev::PersonEnrichParams::Company }
+
+      # @!attribute education
+      #
+      #   @return [Array<ContextDev::Models::PersonEnrichParams::Education>, nil]
+      optional :education, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::PersonEnrichParams::Education] }
+
+      # @!attribute email
+      #
+      #   @return [String, nil]
+      optional :email, String
+
+      # @!attribute location
+      #
+      #   @return [ContextDev::Models::PersonEnrichParams::Location, nil]
+      optional :location, -> { ContextDev::PersonEnrichParams::Location }
+
+      # @!attribute name
+      #
+      #   @return [ContextDev::Models::PersonEnrichParams::Name, nil]
+      optional :name, -> { ContextDev::PersonEnrichParams::Name }
+
+      # @!attribute social_urls
+      #
+      #   @return [Array<String>, nil]
+      optional :social_urls, ContextDev::Internal::Type::ArrayOf[String]
+
+      # @!attribute tags
+      #   Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      #
+      #   @return [Array<String>, nil]
+      optional :tags, ContextDev::Internal::Type::ArrayOf[String]
+
+      # @!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
+      #   value is 300000ms (5 minutes).
+      #
+      #   @return [Integer, nil]
+      optional :timeout_ms, Integer, api_name: :timeoutMS
+
+      # @!method initialize(company: nil, education: nil, email: nil, location: nil, name: nil, social_urls: nil, tags: nil, timeout_ms: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::PersonEnrichParams} for more details.
+      #
+      #   @param company [ContextDev::Models::PersonEnrichParams::Company]
+      #
+      #   @param education [Array<ContextDev::Models::PersonEnrichParams::Education>]
+      #
+      #   @param email [String]
+      #
+      #   @param location [ContextDev::Models::PersonEnrichParams::Location]
+      #
+      #   @param name [ContextDev::Models::PersonEnrichParams::Name]
+      #
+      #   @param social_urls [Array<String>]
+      #
+      #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+      #
+      #   @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}]
+
+      class Company < ContextDev::Internal::Type::BaseModel
+        # @!attribute domain
+        #
+        #   @return [String, nil]
+        optional :domain, String
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!method initialize(domain: nil, name: nil)
+        #   @param domain [String]
+        #   @param name [String]
+      end
+
+      class Education < ContextDev::Internal::Type::BaseModel
+        # @!attribute degree
+        #
+        #   @return [String, nil]
+        optional :degree, String
+
+        # @!attribute field_of_study
+        #
+        #   @return [String, nil]
+        optional :field_of_study, String
+
+        # @!attribute graduation_year
+        #
+        #   @return [Integer, nil]
+        optional :graduation_year, Integer
+
+        # @!attribute institution
+        #
+        #   @return [ContextDev::Models::PersonEnrichParams::Education::Institution, nil]
+        optional :institution, -> { ContextDev::PersonEnrichParams::Education::Institution }
+
+        # @!method initialize(degree: nil, field_of_study: nil, graduation_year: nil, institution: nil)
+        #   @param degree [String]
+        #   @param field_of_study [String]
+        #   @param graduation_year [Integer]
+        #   @param institution [ContextDev::Models::PersonEnrichParams::Education::Institution]
+
+        # @see ContextDev::Models::PersonEnrichParams::Education#institution
+        class Institution < ContextDev::Internal::Type::BaseModel
+          # @!attribute domain
+          #
+          #   @return [String, nil]
+          optional :domain, String
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(domain: nil, name: nil)
+          #   @param domain [String]
+          #   @param name [String]
+        end
+      end
+
+      class Location < ContextDev::Internal::Type::BaseModel
+        # @!attribute city
+        #
+        #   @return [String, nil]
+        optional :city, String
+
+        # @!attribute country
+        #
+        #   @return [String, nil]
+        optional :country, String
+
+        # @!attribute region
+        #
+        #   @return [String, nil]
+        optional :region, String
+
+        # @!method initialize(city: nil, country: nil, region: nil)
+        #   @param city [String]
+        #   @param country [String]
+        #   @param region [String]
+      end
+
+      class Name < ContextDev::Internal::Type::BaseModel
+        # @!attribute first
+        #
+        #   @return [String, nil]
+        optional :first, String
+
+        # @!attribute last
+        #
+        #   @return [String, nil]
+        optional :last, String
+
+        # @!method initialize(first: nil, last: nil)
+        #   @param first [String]
+        #   @param last [String]
+      end
+    end
+  end
+end