NamedEntityRecognitionEvaluationResult

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

Bases: EvaluationResultSummary

Possible NER model error analysis

Methods:

__init__(**kwargs)

Initializes a new NamedEntityRecognitionEvaluationResult 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:

defined_tags

Gets the defined_tags of this EvaluationResultSummary.

freeform_tags

Gets the freeform_tags of this EvaluationResultSummary.

model_type

[Required] Gets the model_type of this EvaluationResultSummary.

predicted_entities

[Required] Gets the predicted_entities of this NamedEntityRecognitionEvaluationResult.

record

[Required] Gets the record of this NamedEntityRecognitionEvaluationResult.

true_entities

[Required] Gets the true_entities of this NamedEntityRecognitionEvaluationResult.

__init__(**kwargs)

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

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this NamedEntityRecognitionEvaluationResult.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this NamedEntityRecognitionEvaluationResult.

  • record (str) – The value to assign to the record property of this NamedEntityRecognitionEvaluationResult.

  • true_entities (list[oci.ai_language.models.EntityLabelErrorAnalysis]) – The value to assign to the true_entities property of this NamedEntityRecognitionEvaluationResult.

  • predicted_entities (list[oci.ai_language.models.EntityLabelErrorAnalysis]) – The value to assign to the predicted_entities property of this NamedEntityRecognitionEvaluationResult.

property defined_tags

Gets the defined_tags of this EvaluationResultSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns

The defined_tags of this EvaluationResultSummary.

Return type

dict(str, dict(str, object))

property freeform_tags

Gets the freeform_tags of this EvaluationResultSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns

The freeform_tags of this EvaluationResultSummary.

Return type

dict(str, 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 model_type

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

Returns

The model_type of this EvaluationResultSummary.

Return type

str

property predicted_entities

[Required] Gets the predicted_entities of this NamedEntityRecognitionEvaluationResult. List of true(actual) entities in test data for NER model

Returns

The predicted_entities of this NamedEntityRecognitionEvaluationResult.

Return type

list[oci.ai_language.models.EntityLabelErrorAnalysis]

property record

[Required] Gets the record of this NamedEntityRecognitionEvaluationResult. For CSV format location is rowId(1 is header) and for JSONL location is jsonL line sequence(1 is metadata)

Returns

The record of this NamedEntityRecognitionEvaluationResult.

Return type

str

property true_entities

[Required] Gets the true_entities of this NamedEntityRecognitionEvaluationResult. List of true(actual) entities in test data for NER model

Returns

The true_entities of this NamedEntityRecognitionEvaluationResult.

Return type

list[oci.ai_language.models.EntityLabelErrorAnalysis]