DocumentKeyValueExtractionFeature¶

class oci.ai_document.models.DocumentKeyValueExtractionFeature(**kwargs)¶

Bases: oci.ai_document.models.document_feature.DocumentFeature

Extracting form fields.

Attributes

`FEATURE_TYPE_DOCUMENT_CLASSIFICATION`	str(object=’’) -> str
`FEATURE_TYPE_KEY_VALUE_EXTRACTION`	str(object=’’) -> str
`FEATURE_TYPE_LANGUAGE_CLASSIFICATION`	str(object=’’) -> str
`FEATURE_TYPE_TABLE_EXTRACTION`	str(object=’’) -> str
`FEATURE_TYPE_TEXT_EXTRACTION`	str(object=’’) -> str
`feature_type`	[Required] Gets the feature_type of this DocumentFeature.
`model_id`	Gets the model_id of this DocumentKeyValueExtractionFeature.

Methods

`__init__`(**kwargs)	Initializes a new DocumentKeyValueExtractionFeature 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'¶

FEATURE_TYPE_KEY_VALUE_EXTRACTION = 'KEY_VALUE_EXTRACTION'¶

FEATURE_TYPE_LANGUAGE_CLASSIFICATION = 'LANGUAGE_CLASSIFICATION'¶

FEATURE_TYPE_TABLE_EXTRACTION = 'TABLE_EXTRACTION'¶

FEATURE_TYPE_TEXT_EXTRACTION = 'TEXT_EXTRACTION'¶

__init__(**kwargs)¶

Initializes a new DocumentKeyValueExtractionFeature object with values from keyword arguments. The default value of the feature_type attribute of this class is KEY_VALUE_EXTRACTION and 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 DocumentKeyValueExtractionFeature. Allowed values for this property are: “LANGUAGE_CLASSIFICATION”, “TEXT_EXTRACTION”, “TABLE_EXTRACTION”, “KEY_VALUE_EXTRACTION”, “DOCUMENT_CLASSIFICATION”
model_id (str) – The value to assign to the model_id property of this DocumentKeyValueExtractionFeature.

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.

model_id¶

Gets the model_id of this DocumentKeyValueExtractionFeature. The custom model ID.

Returns:	The model_id of this DocumentKeyValueExtractionFeature.
Return type:	str