AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::Comprehend::Model::EntityTypesEvaluationMetrics Class Reference

#include <EntityTypesEvaluationMetrics.h>

Public Member Functions

 EntityTypesEvaluationMetrics ()
 
 EntityTypesEvaluationMetrics (Aws::Utils::Json::JsonView jsonValue)
 
EntityTypesEvaluationMetricsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
double GetPrecision () const
 
bool PrecisionHasBeenSet () const
 
void SetPrecision (double value)
 
EntityTypesEvaluationMetricsWithPrecision (double value)
 
double GetRecall () const
 
bool RecallHasBeenSet () const
 
void SetRecall (double value)
 
EntityTypesEvaluationMetricsWithRecall (double value)
 
double GetF1Score () const
 
bool F1ScoreHasBeenSet () const
 
void SetF1Score (double value)
 
EntityTypesEvaluationMetricsWithF1Score (double value)
 

Detailed Description

Detailed information about the accuracy of an entity recognizer for a specific entity type.

See Also:

AWS API Reference

Definition at line 30 of file EntityTypesEvaluationMetrics.h.

Constructor & Destructor Documentation

◆ EntityTypesEvaluationMetrics() [1/2]

Aws::Comprehend::Model::EntityTypesEvaluationMetrics::EntityTypesEvaluationMetrics ( )

◆ EntityTypesEvaluationMetrics() [2/2]

Aws::Comprehend::Model::EntityTypesEvaluationMetrics::EntityTypesEvaluationMetrics ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ F1ScoreHasBeenSet()

bool Aws::Comprehend::Model::EntityTypesEvaluationMetrics::F1ScoreHasBeenSet ( ) const
inline

A measure of how accurate the recognizer results are for a specific entity type in the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.

Definition at line 111 of file EntityTypesEvaluationMetrics.h.

◆ GetF1Score()

double Aws::Comprehend::Model::EntityTypesEvaluationMetrics::GetF1Score ( ) const
inline

A measure of how accurate the recognizer results are for a specific entity type in the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.

Definition at line 103 of file EntityTypesEvaluationMetrics.h.

◆ GetPrecision()

double Aws::Comprehend::Model::EntityTypesEvaluationMetrics::GetPrecision ( ) const
inline

A measure of the usefulness of the recognizer results for a specific entity type in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.

Definition at line 44 of file EntityTypesEvaluationMetrics.h.

◆ GetRecall()

double Aws::Comprehend::Model::EntityTypesEvaluationMetrics::GetRecall ( ) const
inline

A measure of how complete the recognizer results are for a specific entity type in the test data. High recall means that the recognizer returned most of the relevant results.

Definition at line 73 of file EntityTypesEvaluationMetrics.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Comprehend::Model::EntityTypesEvaluationMetrics::Jsonize ( ) const

◆ operator=()

EntityTypesEvaluationMetrics& Aws::Comprehend::Model::EntityTypesEvaluationMetrics::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PrecisionHasBeenSet()

bool Aws::Comprehend::Model::EntityTypesEvaluationMetrics::PrecisionHasBeenSet ( ) const
inline

A measure of the usefulness of the recognizer results for a specific entity type in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.

Definition at line 51 of file EntityTypesEvaluationMetrics.h.

◆ RecallHasBeenSet()

bool Aws::Comprehend::Model::EntityTypesEvaluationMetrics::RecallHasBeenSet ( ) const
inline

A measure of how complete the recognizer results are for a specific entity type in the test data. High recall means that the recognizer returned most of the relevant results.

Definition at line 80 of file EntityTypesEvaluationMetrics.h.

◆ SetF1Score()

void Aws::Comprehend::Model::EntityTypesEvaluationMetrics::SetF1Score ( double  value)
inline

A measure of how accurate the recognizer results are for a specific entity type in the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.

Definition at line 119 of file EntityTypesEvaluationMetrics.h.

◆ SetPrecision()

void Aws::Comprehend::Model::EntityTypesEvaluationMetrics::SetPrecision ( double  value)
inline

A measure of the usefulness of the recognizer results for a specific entity type in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.

Definition at line 58 of file EntityTypesEvaluationMetrics.h.

◆ SetRecall()

void Aws::Comprehend::Model::EntityTypesEvaluationMetrics::SetRecall ( double  value)
inline

A measure of how complete the recognizer results are for a specific entity type in the test data. High recall means that the recognizer returned most of the relevant results.

Definition at line 87 of file EntityTypesEvaluationMetrics.h.

◆ WithF1Score()

EntityTypesEvaluationMetrics& Aws::Comprehend::Model::EntityTypesEvaluationMetrics::WithF1Score ( double  value)
inline

A measure of how accurate the recognizer results are for a specific entity type in the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.

Definition at line 127 of file EntityTypesEvaluationMetrics.h.

◆ WithPrecision()

EntityTypesEvaluationMetrics& Aws::Comprehend::Model::EntityTypesEvaluationMetrics::WithPrecision ( double  value)
inline

A measure of the usefulness of the recognizer results for a specific entity type in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.

Definition at line 65 of file EntityTypesEvaluationMetrics.h.

◆ WithRecall()

EntityTypesEvaluationMetrics& Aws::Comprehend::Model::EntityTypesEvaluationMetrics::WithRecall ( double  value)
inline

A measure of how complete the recognizer results are for a specific entity type in the test data. High recall means that the recognizer returned most of the relevant results.

Definition at line 94 of file EntityTypesEvaluationMetrics.h.


The documentation for this class was generated from the following file: