Package com.oracle.bmc.ailanguage.model

Class EntityMetrics

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.ailanguage.model.EntityMetrics

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20221001")
public final class EntityMetrics
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Entity level named entity recognition model metrics
Note: Objects should always be created or deserialized using the EntityMetrics.Builder.

This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the EntityMetrics.Builder, which maintain a set of all explicitly set fields called EntityMetrics.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EntityMetrics.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
EntityMetrics(String label, Float f1, Float precision, Float recall)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static EntityMetrics.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Float	getF1()	F1-score, is a measure of a model\u2019s accuracy on a dataset
String	getLabel()	Entity label
Float	getPrecision()	Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)
Float	getRecall()	Measures the model’s ability to predict actual positive classes.
int	hashCode()
EntityMetrics.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EntityMetrics

@Deprecated
@ConstructorProperties({"label","f1","precision","recall"})
public EntityMetrics(String label,
                     Float f1,
                     Float precision,
                     Float recall)

Deprecated.

Method Detail

builder

public static EntityMetrics.Builder builder()

Create a new builder.

toBuilder

public EntityMetrics.Builder toBuilder()

getLabel

public String getLabel()

Entity label

Returns:

the value

getF1

public Float getF1()

F1-score, is a measure of a model\u2019s accuracy on a dataset

Returns:

the value

getPrecision

public Float getPrecision()

Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)

Returns:

the value

getRecall

public Float getRecall()

Measures the model’s ability to predict actual positive classes.

It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel