Class EvalTextSimilarityGrader.EvaluationMetric
-
- All Implemented Interfaces:
-
com.openai.core.Enum
public final class EvalTextSimilarityGrader.EvaluationMetric implements EnumThe evaluation metric to use. One of
cosine,fuzzy_match,bleu,gleu,meteor,rouge_1,rouge_2,rouge_3,rouge_4,rouge_5, orrouge_l.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumEvalTextSimilarityGrader.EvaluationMetric.KnownAn enum containing EvaluationMetric's known values.
public enumEvalTextSimilarityGrader.EvaluationMetric.ValueAn enum containing EvaluationMetric's known values, as well as an _UNKNOWN member.
An instance of EvaluationMetric can contain an unknown value in a couple of cases:
It was deserialized from data that doesn't match any known member. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of.
It was constructed with an arbitrary value using the of method.
-
Field Summary
Fields Modifier and Type Field Description public final static EvalTextSimilarityGrader.EvaluationMetricFUZZY_MATCHpublic final static EvalTextSimilarityGrader.EvaluationMetricBLEUpublic final static EvalTextSimilarityGrader.EvaluationMetricGLEUpublic final static EvalTextSimilarityGrader.EvaluationMetricMETEORpublic final static EvalTextSimilarityGrader.EvaluationMetricROUGE_1public final static EvalTextSimilarityGrader.EvaluationMetricROUGE_2public final static EvalTextSimilarityGrader.EvaluationMetricROUGE_3public final static EvalTextSimilarityGrader.EvaluationMetricROUGE_4public final static EvalTextSimilarityGrader.EvaluationMetricROUGE_5public final static EvalTextSimilarityGrader.EvaluationMetricROUGE_Lpublic final static EvalTextSimilarityGrader.EvaluationMetricCOSINE
-
Method Summary
Modifier and Type Method Description final JsonField<String>_value()Returns this class instance's raw value. final EvalTextSimilarityGrader.EvaluationMetric.Valuevalue()Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value. final EvalTextSimilarityGrader.EvaluationMetric.Knownknown()Returns an enum member corresponding to this class instance's value. final StringasString()Returns this class instance's primitive wire representation. final EvalTextSimilarityGrader.EvaluationMetricvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static EvalTextSimilarityGrader.EvaluationMetricof(String value)-
-
Method Detail
-
_value
final JsonField<String> _value()
Returns this class instance's raw value.
This is usually only useful if this instance was deserialized from data that doesn't match any known member, and you want to know that value. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of.
-
value
final EvalTextSimilarityGrader.EvaluationMetric.Value value()
Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value.
Use the known method instead if you're certain the value is always known or if you want to throw for the unknown case.
-
known
final EvalTextSimilarityGrader.EvaluationMetric.Known known()
Returns an enum member corresponding to this class instance's value.
Use the value method instead if you're uncertain the value is always known and don't want to throw for the unknown case.
-
asString
final String asString()
Returns this class instance's primitive wire representation.
This differs from the toString method because that method is primarily for debugging and generally doesn't throw.
-
validate
final EvalTextSimilarityGrader.EvaluationMetric validate()
-
of
final static EvalTextSimilarityGrader.EvaluationMetric of(String value)
-
-
-
-