KeyValueDetectionModelMetrics¶

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

Bases: ModelMetrics

Metrics for Document Key Value Detection Model.

Attributes:

`MODEL_TYPE_DOCUMENT_CLASSIFICATION`	A constant which can be used with the model_type property of a ModelMetrics.
`MODEL_TYPE_KEY_VALUE_EXTRACTION`	A constant which can be used with the model_type property of a ModelMetrics.
`MODEL_TYPE_PRE_TRAINED_DOCUMENT_CLASSIFICATION`	A constant which can be used with the model_type property of a ModelMetrics.
`MODEL_TYPE_PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION`	A constant which can be used with the model_type property of a ModelMetrics.
`MODEL_TYPE_PRE_TRAINED_KEY_VALUE_EXTRACTION`	A constant which can be used with the model_type property of a ModelMetrics.
`MODEL_TYPE_PRE_TRAINED_TABLE_EXTRACTION`	A constant which can be used with the model_type property of a ModelMetrics.
`MODEL_TYPE_PRE_TRAINED_TEXT_EXTRACTION`	A constant which can be used with the model_type property of a ModelMetrics.
`dataset_summary`	Gets the dataset_summary of this ModelMetrics.
`label_metrics_report`	[Required] Gets the label_metrics_report of this KeyValueDetectionModelMetrics.
`model_type`	[Required] Gets the model_type of this ModelMetrics.
`overall_metrics_report`	[Required] Gets the overall_metrics_report of this KeyValueDetectionModelMetrics.

Methods:

`__init__`(**kwargs)	Initializes a new KeyValueDetectionModelMetrics 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.

MODEL_TYPE_DOCUMENT_CLASSIFICATION = 'DOCUMENT_CLASSIFICATION'¶: A constant which can be used with the model_type property of a ModelMetrics. This constant has a value of “DOCUMENT_CLASSIFICATION”

MODEL_TYPE_KEY_VALUE_EXTRACTION = 'KEY_VALUE_EXTRACTION'¶: A constant which can be used with the model_type property of a ModelMetrics. This constant has a value of “KEY_VALUE_EXTRACTION”

MODEL_TYPE_PRE_TRAINED_DOCUMENT_CLASSIFICATION = 'PRE_TRAINED_DOCUMENT_CLASSIFICATION'¶: A constant which can be used with the model_type property of a ModelMetrics. This constant has a value of “PRE_TRAINED_DOCUMENT_CLASSIFICATION”

MODEL_TYPE_PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION = 'PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION'¶: A constant which can be used with the model_type property of a ModelMetrics. This constant has a value of “PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION”

MODEL_TYPE_PRE_TRAINED_KEY_VALUE_EXTRACTION = 'PRE_TRAINED_KEY_VALUE_EXTRACTION'¶: A constant which can be used with the model_type property of a ModelMetrics. This constant has a value of “PRE_TRAINED_KEY_VALUE_EXTRACTION”

MODEL_TYPE_PRE_TRAINED_TABLE_EXTRACTION = 'PRE_TRAINED_TABLE_EXTRACTION'¶: A constant which can be used with the model_type property of a ModelMetrics. This constant has a value of “PRE_TRAINED_TABLE_EXTRACTION”

MODEL_TYPE_PRE_TRAINED_TEXT_EXTRACTION = 'PRE_TRAINED_TEXT_EXTRACTION'¶: A constant which can be used with the model_type property of a ModelMetrics. This constant has a value of “PRE_TRAINED_TEXT_EXTRACTION”

__init__(**kwargs)¶

Initializes a new KeyValueDetectionModelMetrics object with values from keyword arguments. The default value of the model_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

model_type (str) – The value to assign to the model_type property of this KeyValueDetectionModelMetrics. Allowed values for this property are: “KEY_VALUE_EXTRACTION”, “DOCUMENT_CLASSIFICATION”, “PRE_TRAINED_TEXT_EXTRACTION”, “PRE_TRAINED_TABLE_EXTRACTION”, “PRE_TRAINED_KEY_VALUE_EXTRACTION”, “PRE_TRAINED_DOCUMENT_CLASSIFICATION”, “PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION”
dataset_summary (oci.ai_document.models.DatasetSummary) – The value to assign to the dataset_summary property of this KeyValueDetectionModelMetrics.
label_metrics_report (list[oci.ai_document.models.KeyValueDetectionLabelMetricsReport]) – The value to assign to the label_metrics_report property of this KeyValueDetectionModelMetrics.
overall_metrics_report (oci.ai_document.models.KeyValueDetectionOverallMetricsReport) – The value to assign to the overall_metrics_report property of this KeyValueDetectionModelMetrics.

property dataset_summary¶

Gets the dataset_summary of this ModelMetrics.

Returns: The dataset_summary of this ModelMetrics.
Return type: oci.ai_document.models.DatasetSummary

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 label_metrics_report¶

[Required] Gets the label_metrics_report of this KeyValueDetectionModelMetrics. List of metrics entries per label.

Returns: The label_metrics_report of this KeyValueDetectionModelMetrics.
Return type: list[oci.ai_document.models.KeyValueDetectionLabelMetricsReport]

property model_type¶

[Required] Gets the model_type of this ModelMetrics. The type of custom model trained.

Allowed values for this property are: “KEY_VALUE_EXTRACTION”, “DOCUMENT_CLASSIFICATION”, “PRE_TRAINED_TEXT_EXTRACTION”, “PRE_TRAINED_TABLE_EXTRACTION”, “PRE_TRAINED_KEY_VALUE_EXTRACTION”, “PRE_TRAINED_DOCUMENT_CLASSIFICATION”, “PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The model_type of this ModelMetrics.
Return type: str

property overall_metrics_report¶

[Required] Gets the overall_metrics_report of this KeyValueDetectionModelMetrics.

Returns: The overall_metrics_report of this KeyValueDetectionModelMetrics.
Return type: oci.ai_document.models.KeyValueDetectionOverallMetricsReport