Class: ContextDev::Models::WebExtractCompetitorsResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/context_dev/models/web_extract_competitors_response.rb

Overview

See Also:

Defined Under Namespace

Modules: Status Classes: Competitor, KeyMetadata, Target

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(company_name:, field:, field_description:, website_url:) ⇒ Object

Target company profile inferred from the landing page.

Parameters:

  • company_name (String) —

    Company or product name inferred from the landing page.

  • field (String) —

    Specific operating field, product category, or market.

  • field_description (String) —

    One-sentence description of what the target company sells and who it serves.

  • website_url (String) —

    Resolved URL used for the landing page analysis.




# File 'lib/context_dev/models/web_extract_competitors_response.rb', line 156

Instance Attribute Details

#competitors ⇒ Array<ContextDev::Models::WebExtractCompetitorsResponse::Competitor>

Direct competitors ordered by relevance and confidence.

Returns:



11
12
 
# File 'lib/context_dev/models/web_extract_competitors_response.rb', line 11

required :competitors,
-> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebExtractCompetitorsResponse::Competitor] }

#domain ⇒ String

Normalized input domain.

Returns:

  • (String) 


18
 
# File 'lib/context_dev/models/web_extract_competitors_response.rb', line 18

required :domain, String

#key_metadata ⇒ ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata?

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.

Returns:



37
 
# File 'lib/context_dev/models/web_extract_competitors_response.rb', line 37

optional :key_metadata, -> { ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata }

#status ⇒ Symbol, ContextDev::Models::WebExtractCompetitorsResponse::Status

Status of the response.

Returns:



24
 
# File 'lib/context_dev/models/web_extract_competitors_response.rb', line 24

required :status, enum: -> { ContextDev::Models::WebExtractCompetitorsResponse::Status }

#target ⇒ ContextDev::Models::WebExtractCompetitorsResponse::Target

Target company profile inferred from the landing page.

Returns:



30
 
# File 'lib/context_dev/models/web_extract_competitors_response.rb', line 30

required :target, -> { ContextDev::Models::WebExtractCompetitorsResponse::Target }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/context_dev/models/web_extract_competitors_response.rb', line 113