EntityRecognizerEvaluationMetrics (AWS Java SDK for Amazon Comprehend 1.12.60 API)

java.lang.Object
- com.amazonaws.services.comprehend.model.EntityRecognizerEvaluationMetrics

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EntityRecognizerEvaluationMetrics
extends Object
implements Serializable, Cloneable, StructuredPojo

Detailed information about the accuracy of an entity recognizer.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

EntityRecognizerEvaluationMetrics()

Constructors
Constructor and Description
`EntityRecognizerEvaluationMetrics()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EntityRecognizerEvaluationMetrics`	`clone()`
`boolean`	`equals(Object obj)`
`Double`	`getF1Score()` A measure of how accurate the recognizer results are for the test data.
`Double`	`getPrecision()` A measure of the usefulness of the recognizer results in the test data.
`Double`	`getRecall()` A measure of how complete the recognizer results are for the test data.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setF1Score(Double f1Score)` A measure of how accurate the recognizer results are for the test data.
`void`	`setPrecision(Double precision)` A measure of the usefulness of the recognizer results in the test data.
`void`	`setRecall(Double recall)` A measure of how complete the recognizer results are for the test data.
`String`	`toString()` Returns a string representation of this object.
`EntityRecognizerEvaluationMetrics`	`withF1Score(Double f1Score)` A measure of how accurate the recognizer results are for the test data.
`EntityRecognizerEvaluationMetrics`	`withPrecision(Double precision)` A measure of the usefulness of the recognizer results in the test data.
`EntityRecognizerEvaluationMetrics`	`withRecall(Double recall)` A measure of how complete the recognizer results are for the test data.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EntityRecognizerEvaluationMetrics
```
public EntityRecognizerEvaluationMetrics()
```
- Method Detail
  - setPrecision
```
public void setPrecision(Double precision)
```
    A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.
    
    Parameters:
    
    precision - A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.
  - getPrecision
```
public Double getPrecision()
```
    A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.
    
    Returns:
    
    A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.
  - withPrecision
```
public EntityRecognizerEvaluationMetrics withPrecision(Double precision)
```
    A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.
    
    Parameters:
    
    precision - A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRecall
```
public void setRecall(Double recall)
```
    A measure of how complete the recognizer results are for the test data. High recall means that the recognizer returned most of the relevant results.
    
    Parameters:
    
    recall - A measure of how complete the recognizer results are for the test data. High recall means that the recognizer returned most of the relevant results.
  - getRecall
```
public Double getRecall()
```
    A measure of how complete the recognizer results are for the test data. High recall means that the recognizer returned most of the relevant results.
    
    Returns:
    
    A measure of how complete the recognizer results are for the test data. High recall means that the recognizer returned most of the relevant results.
  - withRecall
```
public EntityRecognizerEvaluationMetrics withRecall(Double recall)
```
    A measure of how complete the recognizer results are for the test data. High recall means that the recognizer returned most of the relevant results.
    
    Parameters:
    
    recall - A measure of how complete the recognizer results are for the test data. High recall means that the recognizer returned most of the relevant results.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setF1Score
```
public void setF1Score(Double f1Score)
```
    A measure of how accurate the recognizer results are for 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.
    
    Parameters:
    
    f1Score - A measure of how accurate the recognizer results are for 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.
  - getF1Score
```
public Double getF1Score()
```
    A measure of how accurate the recognizer results are for 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.
    
    Returns:
    
    A measure of how accurate the recognizer results are for 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.
  - withF1Score
```
public EntityRecognizerEvaluationMetrics withF1Score(Double f1Score)
```
    A measure of how accurate the recognizer results are for 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.
    
    Parameters:
    
    f1Score - A measure of how accurate the recognizer results are for 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public EntityRecognizerEvaluationMetrics clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class EntityRecognizerEvaluationMetrics

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EntityRecognizerEvaluationMetrics

Method Detail

setPrecision

getPrecision

withPrecision

setRecall

getRecall

withRecall

setF1Score

getF1Score

withF1Score

toString

equals

hashCode

clone

marshall