context.dev 1.36.0 → 2.1.0

data/lib/context_dev/models/ai_ai_query_params.rb

@@ -1,235 +0,0 @@
-# frozen_string_literal: true
-
-module ContextDev
-  module Models
-    # @see ContextDev::Resources::AI#ai_query
-    class AIAIQueryParams < ContextDev::Internal::Type::BaseModel
-      extend ContextDev::Internal::Type::RequestParameters::Converter
-      include ContextDev::Internal::Type::RequestParameters
-
-      # @!attribute data_to_extract
-      #   Array of data points to extract from the website
-      #
-      #   @return [Array<ContextDev::Models::AIAIQueryParams::DataToExtract>]
-      required :data_to_extract,
-               -> { ContextDev::Internal::Type::ArrayOf[ContextDev::AIAIQueryParams::DataToExtract] }
-
-      # @!attribute domain
-      #   The domain name to analyze
-      #
-      #   @return [String]
-      required :domain, String
-
-      # @!attribute specific_pages
-      #   Optional object specifying which pages to analyze
-      #
-      #   @return [ContextDev::Models::AIAIQueryParams::SpecificPages, nil]
-      optional :specific_pages, -> { ContextDev::AIAIQueryParams::SpecificPages }
-
-      # @!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(data_to_extract:, domain:, specific_pages: nil, timeout_ms: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {ContextDev::Models::AIAIQueryParams} for more details.
-      #
-      #   @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}]
-
-      class DataToExtract < ContextDev::Internal::Type::BaseModel
-        # @!attribute datapoint_description
-        #   Description of what to extract
-        #
-        #   @return [String]
-        required :datapoint_description, String
-
-        # @!attribute datapoint_example
-        #   Example of the expected value
-        #
-        #   @return [String]
-        required :datapoint_example, String
-
-        # @!attribute datapoint_name
-        #   Name of the data point to extract
-        #
-        #   @return [String]
-        required :datapoint_name, String
-
-        # @!attribute datapoint_type
-        #   Type of the data point
-        #
-        #   @return [Symbol, ContextDev::Models::AIAIQueryParams::DataToExtract::DatapointType]
-        required :datapoint_type, enum: -> { ContextDev::AIAIQueryParams::DataToExtract::DatapointType }
-
-        # @!attribute datapoint_list_type
-        #   Type of items in the list when datapoint_type is 'list'. Defaults to 'string'.
-        #   Use 'object' to extract an array of objects matching a schema.
-        #
-        #   @return [Symbol, ContextDev::Models::AIAIQueryParams::DataToExtract::DatapointListType, nil]
-        optional :datapoint_list_type, enum: -> { ContextDev::AIAIQueryParams::DataToExtract::DatapointListType }
-
-        # @!attribute datapoint_object_schema
-        #   Schema definition for objects when datapoint_list_type is 'object'. Provide a
-        #   map of field names to their scalar types.
-        #
-        #   @return [Hash{Symbol=>Symbol, ContextDev::Models::AIAIQueryParams::DataToExtract::DatapointObjectSchema}, nil]
-        optional :datapoint_object_schema,
-                 -> { ContextDev::Internal::Type::HashOf[enum: ContextDev::AIAIQueryParams::DataToExtract::DatapointObjectSchema] }
-
-        # @!method initialize(datapoint_description:, datapoint_example:, datapoint_name:, datapoint_type:, datapoint_list_type: nil, datapoint_object_schema: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {ContextDev::Models::AIAIQueryParams::DataToExtract} for more details.
-        #
-        #   @param datapoint_description [String] Description of what to extract
-        #
-        #   @param datapoint_example [String] Example of the expected value
-        #
-        #   @param datapoint_name [String] Name of the data point to extract
-        #
-        #   @param datapoint_type [Symbol, ContextDev::Models::AIAIQueryParams::DataToExtract::DatapointType] Type of the data point
-        #
-        #   @param datapoint_list_type [Symbol, ContextDev::Models::AIAIQueryParams::DataToExtract::DatapointListType] Type of items in the list when datapoint_type is 'list'. Defaults to 'string'. U
-        #
-        #   @param datapoint_object_schema [Hash{Symbol=>Symbol, ContextDev::Models::AIAIQueryParams::DataToExtract::DatapointObjectSchema}] Schema definition for objects when datapoint_list_type is 'object'. Provide a ma
-
-        # Type of the data point
-        #
-        # @see ContextDev::Models::AIAIQueryParams::DataToExtract#datapoint_type
-        module DatapointType
-          extend ContextDev::Internal::Type::Enum
-
-          TEXT = :text
-          NUMBER = :number
-          DATE = :date
-          BOOLEAN = :boolean
-          LIST = :list
-          URL = :url
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # Type of items in the list when datapoint_type is 'list'. Defaults to 'string'.
-        # Use 'object' to extract an array of objects matching a schema.
-        #
-        # @see ContextDev::Models::AIAIQueryParams::DataToExtract#datapoint_list_type
-        module DatapointListType
-          extend ContextDev::Internal::Type::Enum
-
-          STRING = :string
-          TEXT = :text
-          NUMBER = :number
-          DATE = :date
-          BOOLEAN = :boolean
-          LIST = :list
-          URL = :url
-          OBJECT = :object
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        module DatapointObjectSchema
-          extend ContextDev::Internal::Type::Enum
-
-          STRING = :string
-          NUMBER = :number
-          DATE = :date
-          BOOLEAN = :boolean
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
-      class SpecificPages < ContextDev::Internal::Type::BaseModel
-        # @!attribute about_us
-        #   Whether to analyze the about us page
-        #
-        #   @return [Boolean, nil]
-        optional :about_us, ContextDev::Internal::Type::Boolean
-
-        # @!attribute blog
-        #   Whether to analyze the blog
-        #
-        #   @return [Boolean, nil]
-        optional :blog, ContextDev::Internal::Type::Boolean
-
-        # @!attribute careers
-        #   Whether to analyze the careers page
-        #
-        #   @return [Boolean, nil]
-        optional :careers, ContextDev::Internal::Type::Boolean
-
-        # @!attribute contact_us
-        #   Whether to analyze the contact us page
-        #
-        #   @return [Boolean, nil]
-        optional :contact_us, ContextDev::Internal::Type::Boolean
-
-        # @!attribute faq
-        #   Whether to analyze the FAQ page
-        #
-        #   @return [Boolean, nil]
-        optional :faq, ContextDev::Internal::Type::Boolean
-
-        # @!attribute home_page
-        #   Whether to analyze the home page
-        #
-        #   @return [Boolean, nil]
-        optional :home_page, ContextDev::Internal::Type::Boolean
-
-        # @!attribute pricing
-        #   Whether to analyze the pricing page
-        #
-        #   @return [Boolean, nil]
-        optional :pricing, ContextDev::Internal::Type::Boolean
-
-        # @!attribute privacy_policy
-        #   Whether to analyze the privacy policy page
-        #
-        #   @return [Boolean, nil]
-        optional :privacy_policy, ContextDev::Internal::Type::Boolean
-
-        # @!attribute terms_and_conditions
-        #   Whether to analyze the terms and conditions page
-        #
-        #   @return [Boolean, nil]
-        optional :terms_and_conditions, ContextDev::Internal::Type::Boolean
-
-        # @!method initialize(about_us: nil, blog: nil, careers: nil, contact_us: nil, faq: nil, home_page: nil, pricing: nil, privacy_policy: nil, terms_and_conditions: nil)
-        #   Optional object specifying which pages to analyze
-        #
-        #   @param about_us [Boolean] Whether to analyze the about us page
-        #
-        #   @param blog [Boolean] Whether to analyze the blog
-        #
-        #   @param careers [Boolean] Whether to analyze the careers page
-        #
-        #   @param contact_us [Boolean] Whether to analyze the contact us page
-        #
-        #   @param faq [Boolean] Whether to analyze the FAQ page
-        #
-        #   @param home_page [Boolean] Whether to analyze the home page
-        #
-        #   @param pricing [Boolean] Whether to analyze the pricing page
-        #
-        #   @param privacy_policy [Boolean] Whether to analyze the privacy policy page
-        #
-        #   @param terms_and_conditions [Boolean] Whether to analyze the terms and conditions page
-      end
-    end
-  end
-end

data/lib/context_dev/models/ai_ai_query_response.rb

@@ -1,133 +0,0 @@
-# frozen_string_literal: true
-
-module ContextDev
-  module Models
-    # @see ContextDev::Resources::AI#ai_query
-    class AIAIQueryResponse < ContextDev::Internal::Type::BaseModel
-      # @!attribute data_extracted
-      #   Array of extracted data points
-      #
-      #   @return [Array<ContextDev::Models::AIAIQueryResponse::DataExtracted>, nil]
-      optional :data_extracted,
-               -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::AIAIQueryResponse::DataExtracted] }
-
-      # @!attribute domain
-      #   The domain that was analyzed
-      #
-      #   @return [String, nil]
-      optional :domain, String
-
-      # @!attribute key_metadata
-      #   Metadata about the API key used for the request. Included in every response
-      #   whenever a valid API key is provided, even when the response status is not 200.
-      #
-      #   @return [ContextDev::Models::AIAIQueryResponse::KeyMetadata, nil]
-      optional :key_metadata, -> { ContextDev::Models::AIAIQueryResponse::KeyMetadata }
-
-      # @!attribute status
-      #   Status of the response, e.g., 'ok'
-      #
-      #   @return [String, nil]
-      optional :status, String
-
-      # @!attribute urls_analyzed
-      #   List of URLs that were analyzed
-      #
-      #   @return [Array<String>, nil]
-      optional :urls_analyzed, ContextDev::Internal::Type::ArrayOf[String]
-
-      # @!method initialize(data_extracted: nil, domain: nil, key_metadata: nil, status: nil, urls_analyzed: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {ContextDev::Models::AIAIQueryResponse} for more details.
-      #
-      #   @param data_extracted [Array<ContextDev::Models::AIAIQueryResponse::DataExtracted>] Array of extracted data points
-      #
-      #   @param domain [String] The domain that was analyzed
-      #
-      #   @param key_metadata [ContextDev::Models::AIAIQueryResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
-      #
-      #   @param status [String] Status of the response, e.g., 'ok'
-      #
-      #   @param urls_analyzed [Array<String>] List of URLs that were analyzed
-
-      class DataExtracted < ContextDev::Internal::Type::BaseModel
-        # @!attribute datapoint_name
-        #   Name of the extracted data point
-        #
-        #   @return [String, nil]
-        optional :datapoint_name, String
-
-        # @!attribute datapoint_value
-        #   Value of the extracted data point. Can be a primitive type, an array of
-        #   primitives, or an array of objects when datapoint_list_type is 'object'.
-        #
-        #   @return [String, Float, Boolean, Array<String>, Array<Float>, Array<Object>, nil]
-        optional :datapoint_value,
-                 union: -> { ContextDev::Models::AIAIQueryResponse::DataExtracted::DatapointValue }
-
-        # @!method initialize(datapoint_name: nil, datapoint_value: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {ContextDev::Models::AIAIQueryResponse::DataExtracted} for more details.
-        #
-        #   @param datapoint_name [String] Name of the extracted data point
-        #
-        #   @param datapoint_value [String, Float, Boolean, Array<String>, Array<Float>, Array<Object>] Value of the extracted data point. Can be a primitive type, an array of primitiv
-
-        # Value of the extracted data point. Can be a primitive type, an array of
-        # primitives, or an array of objects when datapoint_list_type is 'object'.
-        #
-        # @see ContextDev::Models::AIAIQueryResponse::DataExtracted#datapoint_value
-        module DatapointValue
-          extend ContextDev::Internal::Type::Union
-
-          variant String
-
-          variant Float
-
-          variant ContextDev::Internal::Type::Boolean
-
-          variant -> { ContextDev::Models::AIAIQueryResponse::DataExtracted::DatapointValue::StringArray }
-
-          variant -> { ContextDev::Models::AIAIQueryResponse::DataExtracted::DatapointValue::FloatArray }
-
-          variant -> { ContextDev::Models::AIAIQueryResponse::DataExtracted::DatapointValue::UnionMember5Array }
-
-          # @!method self.variants
-          #   @return [Array(String, Float, Boolean, Array<String>, Array<Float>, Array<Object>)]
-
-          # @type [ContextDev::Internal::Type::Converter]
-          StringArray = ContextDev::Internal::Type::ArrayOf[String]
-
-          # @type [ContextDev::Internal::Type::Converter]
-          FloatArray = ContextDev::Internal::Type::ArrayOf[Float]
-
-          # @type [ContextDev::Internal::Type::Converter]
-          UnionMember5Array = ContextDev::Internal::Type::ArrayOf[ContextDev::Internal::Type::Unknown]
-        end
-      end
-
-      # @see ContextDev::Models::AIAIQueryResponse#key_metadata
-      class KeyMetadata < ContextDev::Internal::Type::BaseModel
-        # @!attribute credits_consumed
-        #   The number of credits consumed by this request.
-        #
-        #   @return [Integer]
-        required :credits_consumed, Integer
-
-        # @!attribute credits_remaining
-        #   The number of credits remaining for your organization after this request.
-        #
-        #   @return [Integer]
-        required :credits_remaining, Integer
-
-        # @!method initialize(credits_consumed:, credits_remaining:)
-        #   Metadata about the API key used for the request. Included in every response
-        #   whenever a valid API key is provided, even when the response status is not 200.
-        #
-        #   @param credits_consumed [Integer] The number of credits consumed by this request.
-        #
-        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
-      end
-    end
-  end
-end