DocumentClassificationFeature¶

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

Bases: oci.ai_document.models.document_feature.DocumentFeature

Identifying the document type.

Attributes

`FEATURE_TYPE_DOCUMENT_CLASSIFICATION`	str(object=’’) -> str
`FEATURE_TYPE_DOCUMENT_ELEMENTS_EXTRACTION`	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.
`max_results`	Gets the max_results of this DocumentClassificationFeature.
`model_id`	Gets the model_id of this DocumentClassificationFeature.
`tenancy_id`	Gets the tenancy_id of this DocumentClassificationFeature.

Methods

`__init__`(**kwargs)	Initializes a new DocumentClassificationFeature 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_DOCUMENT_ELEMENTS_EXTRACTION = 'DOCUMENT_ELEMENTS_EXTRACTION'¶

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

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

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.

max_results¶

Gets the max_results of this DocumentClassificationFeature. The maximum number of results to return.

Returns:	The max_results of this DocumentClassificationFeature.
Return type:	int

model_id¶

Gets the model_id of this DocumentClassificationFeature. Unique identifier custom model OCID that should be used for inference.

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

tenancy_id¶

Gets the tenancy_id of this DocumentClassificationFeature. The custom model tenancy ID when modelId represents aliasName.

Returns:	The tenancy_id of this DocumentClassificationFeature.
Return type:	str