KeyValueDetectionModelMetrics

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

Bases: oci.ai_document.models.model_metrics.ModelMetrics

Metrics for Document Key Value Detection Model.

Attributes

MODEL_TYPE_DOCUMENT_CLASSIFICATION str(object=’’) -> str
MODEL_TYPE_KEY_VALUE_EXTRACTION str(object=’’) -> str
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'
MODEL_TYPE_KEY_VALUE_EXTRACTION = 'KEY_VALUE_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:
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.

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]
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”, ‘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
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