DocumentTextExtractionFeature¶
- class oci.ai_document.models.DocumentTextExtractionFeature(**kwargs)¶
Bases:
DocumentFeatureText recognition
Attributes:
A constant which can be used with the feature_type property of a DocumentFeature.
A constant which can be used with the feature_type property of a DocumentFeature.
A constant which can be used with the feature_type property of a DocumentFeature.
A constant which can be used with the feature_type property of a DocumentFeature.
A constant which can be used with the feature_type property of a DocumentFeature.
A constant which can be used with the feature_type property of a DocumentFeature.
[Required] Gets the feature_type of this DocumentFeature.
Gets the generate_searchable_pdf of this DocumentTextExtractionFeature.
Gets the model_id of this DocumentTextExtractionFeature.
Gets the selection_mark_detection of this DocumentTextExtractionFeature.
Methods:
__init__(**kwargs)Initializes a new DocumentTextExtractionFeature 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_DOCUMENT_ELEMENTS_EXTRACTION = 'DOCUMENT_ELEMENTS_EXTRACTION'¶
A constant which can be used with the feature_type property of a DocumentFeature. This constant has a value of “DOCUMENT_ELEMENTS_EXTRACTION”
- 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 DocumentTextExtractionFeature object with values from keyword arguments. The default value of the
feature_typeattribute of this class isTEXT_EXTRACTIONand it should not be changed. 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 DocumentTextExtractionFeature. Allowed values for this property are: “LANGUAGE_CLASSIFICATION”, “TEXT_EXTRACTION”, “TABLE_EXTRACTION”, “KEY_VALUE_EXTRACTION”, “DOCUMENT_CLASSIFICATION”, “DOCUMENT_ELEMENTS_EXTRACTION”
generate_searchable_pdf (bool) – The value to assign to the generate_searchable_pdf property of this DocumentTextExtractionFeature.
model_id (str) – The value to assign to the model_id property of this DocumentTextExtractionFeature.
selection_mark_detection (bool) – The value to assign to the selection_mark_detection property of this DocumentTextExtractionFeature.
- property 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. - DOCUMENT_ELEMENTS_EXTRACTION: Extract information from bar code
Allowed values for this property are: “LANGUAGE_CLASSIFICATION”, “TEXT_EXTRACTION”, “TABLE_EXTRACTION”, “KEY_VALUE_EXTRACTION”, “DOCUMENT_CLASSIFICATION”, “DOCUMENT_ELEMENTS_EXTRACTION”, ‘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
- property generate_searchable_pdf¶
Gets the generate_searchable_pdf of this DocumentTextExtractionFeature. Whether or not to generate a searchable PDF file.
- Returns
The generate_searchable_pdf of this DocumentTextExtractionFeature.
- Return type
bool
- 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.
- property model_id¶
Gets the model_id of this DocumentTextExtractionFeature. Unique identifier custom model OCID that should be used for inference.
- Returns
The model_id of this DocumentTextExtractionFeature.
- Return type
str
- property selection_mark_detection¶
Gets the selection_mark_detection of this DocumentTextExtractionFeature. Whether checkbox detection feature is enabled or disabled.
- Returns
The selection_mark_detection of this DocumentTextExtractionFeature.
- Return type
bool