DocumentFeature¶
-
class
oci.ai_document.models.
DocumentFeature
(**kwargs)¶ Bases:
object
The type of document analysis.
Attributes
FEATURE_TYPE_DOCUMENT_CLASSIFICATION
A constant which can be used with the feature_type property of a DocumentFeature. FEATURE_TYPE_KEY_VALUE_EXTRACTION
A constant which can be used with the feature_type property of a DocumentFeature. FEATURE_TYPE_LANGUAGE_CLASSIFICATION
A constant which can be used with the feature_type property of a DocumentFeature. FEATURE_TYPE_TABLE_EXTRACTION
A constant which can be used with the feature_type property of a DocumentFeature. FEATURE_TYPE_TEXT_EXTRACTION
A constant which can be used with the feature_type property of a DocumentFeature. feature_type
[Required] Gets the feature_type of this DocumentFeature. Methods
__init__
(**kwargs)Initializes a new DocumentFeature object with values from keyword arguments. get_subtype
(object_dictionary)Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype. -
FEATURE_TYPE_DOCUMENT_CLASSIFICATION
= 'DOCUMENT_CLASSIFICATION'¶ A constant which can be used with the feature_type property of a DocumentFeature. This constant has a value of “DOCUMENT_CLASSIFICATION”
-
FEATURE_TYPE_KEY_VALUE_EXTRACTION
= 'KEY_VALUE_EXTRACTION'¶ A constant which can be used with the feature_type property of a DocumentFeature. This constant has a value of “KEY_VALUE_EXTRACTION”
-
FEATURE_TYPE_LANGUAGE_CLASSIFICATION
= 'LANGUAGE_CLASSIFICATION'¶ A constant which can be used with the feature_type property of a DocumentFeature. This constant has a value of “LANGUAGE_CLASSIFICATION”
-
FEATURE_TYPE_TABLE_EXTRACTION
= 'TABLE_EXTRACTION'¶ A constant which can be used with the feature_type property of a DocumentFeature. This constant has a value of “TABLE_EXTRACTION”
-
FEATURE_TYPE_TEXT_EXTRACTION
= 'TEXT_EXTRACTION'¶ A constant which can be used with the feature_type property of a DocumentFeature. This constant has a value of “TEXT_EXTRACTION”
-
__init__
(**kwargs)¶ Initializes a new DocumentFeature object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:
DocumentClassificationFeature
DocumentKeyValueExtractionFeature
DocumentLanguageClassificationFeature
DocumentTextExtractionFeature
DocumentTableExtractionFeature
The following keyword arguments are supported (corresponding to the getters/setters of this class):
Parameters: feature_type (str) – The value to assign to the feature_type property of this DocumentFeature. Allowed values for this property are: “LANGUAGE_CLASSIFICATION”, “TEXT_EXTRACTION”, “TABLE_EXTRACTION”, “KEY_VALUE_EXTRACTION”, “DOCUMENT_CLASSIFICATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
-
feature_type
¶ [Required] Gets the feature_type of this DocumentFeature. The type of document analysis requested. The allowed values are: - LANGUAGE_CLASSIFICATION: Detect the language. - TEXT_EXTRACTION: Recognize text. - TABLE_EXTRACTION: Detect and extract data in tables. - KEY_VALUE_EXTRACTION: Extract form fields. - DOCUMENT_CLASSIFICATION: Identify the type of document.
Allowed values for this property are: “LANGUAGE_CLASSIFICATION”, “TEXT_EXTRACTION”, “TABLE_EXTRACTION”, “KEY_VALUE_EXTRACTION”, “DOCUMENT_CLASSIFICATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The feature_type of this DocumentFeature. Return type: str
-
static
get_subtype
(object_dictionary)¶ Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
-