SicResponse

data_models.response_model.SicResponse()

Represents a response model for SIC code assignment.

Attributes

Name	Type	Description
codable	bool	True if enough information is provided to decide SIC code, False otherwise.
followup	Optional[str]	Question to ask user in order to collect additional information to enable reliable SIC assignment. Empty if codable=True.
sic_code	Optional[str]	Full SIC code (to the required number of digits) assigned based on the provided company activity description. Empty if codable=False.
sic_descriptive	Optional[str]	Descriptive label of the SIC category associated with sic_code if provided. Empty if codable=False.
sic_candidates	List[SicCandidate]	Short list of less than ten possible or alternative sic codes that may be applicable with their descriptive label and estimated likelihood.
sic_code_2digits	Optional[str]	First two digits of the hierarchical SIC code assigned. This field should be non empty if the larger (two-digit) group of SIC codes can be determined even in cases where additional information is needed to code to four digits (for example when all SIC candidates share the same first two digits).
reasoning	str	Specifies the information used to assign the SIC code or any additional information required to assign a SIC code.