DocumentClassificationFeature

class oci.ai_vision.models.DocumentClassificationFeature(**kwargs)

Bases: DocumentFeature

Identifying the document type.

Attributes:

FEATURE_TYPE_DOCUMENT_CLASSIFICATION	A constant which can be used with the feature_type property of a DocumentFeature.
FEATURE_TYPE_KEY_VALUE_DETECTION	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_DETECTION	A constant which can be used with the feature_type property of a DocumentFeature.
FEATURE_TYPE_TEXT_DETECTION	A constant which can be used with the feature_type property of a DocumentFeature.
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.

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'

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_DETECTION = 'KEY_VALUE_DETECTION'

A constant which can be used with the feature_type property of a DocumentFeature. This constant has a value of “KEY_VALUE_DETECTION”

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_DETECTION = 'TABLE_DETECTION'

A constant which can be used with the feature_type property of a DocumentFeature. This constant has a value of “TABLE_DETECTION”

FEATURE_TYPE_TEXT_DETECTION = 'TEXT_DETECTION'

A constant which can be used with the feature_type property of a DocumentFeature. This constant has a value of “TEXT_DETECTION”

__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_DETECTION”, “TABLE_DETECTION”, “KEY_VALUE_DETECTION”, “DOCUMENT_CLASSIFICATION”

• 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.

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_DETECTION: Recognize text. - TABLE_DETECTION: Detect and extract data in tables. - KEY_VALUE_DETECTION: Extract form fields. - DOCUMENT_CLASSIFICATION: Identify the type of document.

Allowed values for this property are: “LANGUAGE_CLASSIFICATION”, “TEXT_DETECTION”, “TABLE_DETECTION”, “KEY_VALUE_DETECTION”, “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.

property 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

property model_id

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

Returns

The model_id of this DocumentClassificationFeature.

Return type

str