NamedEntityRecognitionEvaluationResults

class oci.ai_language.models.NamedEntityRecognitionEvaluationResults(**kwargs)

Bases: EvaluationResults

Named entity recognition model testing and evaluation results

Methods:

__init__(**kwargs)

Initializes a new NamedEntityRecognitionEvaluationResults 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.

Attributes:

confusion_matrix

Gets the confusion_matrix of this NamedEntityRecognitionEvaluationResults.

entity_metrics

Gets the entity_metrics of this NamedEntityRecognitionEvaluationResults.

labels

Gets the labels of this NamedEntityRecognitionEvaluationResults.

metrics

Gets the metrics of this NamedEntityRecognitionEvaluationResults.

model_type

[Required] Gets the model_type of this EvaluationResults.

__init__(**kwargs)

Initializes a new NamedEntityRecognitionEvaluationResults object with values from keyword arguments. The default value of the model_type attribute of this class is NAMED_ENTITY_RECOGNITION 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 NamedEntityRecognitionEvaluationResults.

  • metrics (oci.ai_language.models.NamedEntityRecognitionModelMetrics) – The value to assign to the metrics property of this NamedEntityRecognitionEvaluationResults.

  • entity_metrics (list[oci.ai_language.models.EntityMetrics]) – The value to assign to the entity_metrics property of this NamedEntityRecognitionEvaluationResults.

  • confusion_matrix (dict(str, ConfusionMatrixDetails)) – The value to assign to the confusion_matrix property of this NamedEntityRecognitionEvaluationResults.

  • labels (list[str]) – The value to assign to the labels property of this NamedEntityRecognitionEvaluationResults.

property confusion_matrix

Gets the confusion_matrix of this NamedEntityRecognitionEvaluationResults. class level confusion matrix

Returns

The confusion_matrix of this NamedEntityRecognitionEvaluationResults.

Return type

dict(str, ConfusionMatrixDetails)

property entity_metrics

Gets the entity_metrics of this NamedEntityRecognitionEvaluationResults. List of entity metrics

Returns

The entity_metrics of this NamedEntityRecognitionEvaluationResults.

Return type

list[oci.ai_language.models.EntityMetrics]

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 labels

Gets the labels of this NamedEntityRecognitionEvaluationResults. labels

Returns

The labels of this NamedEntityRecognitionEvaluationResults.

Return type

list[str]

property metrics

Gets the metrics of this NamedEntityRecognitionEvaluationResults.

Returns

The metrics of this NamedEntityRecognitionEvaluationResults.

Return type

oci.ai_language.models.NamedEntityRecognitionModelMetrics

property model_type

[Required] Gets the model_type of this EvaluationResults. Model type

Returns

The model_type of this EvaluationResults.

Return type

str