Class TextSimilarityGrader
-
- All Implemented Interfaces:
public final class TextSimilarityGraderA TextSimilarityGrader object which grades text based on similarity metrics.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classTextSimilarityGrader.BuilderA builder for TextSimilarityGrader.
public final classTextSimilarityGrader.EvaluationMetricThe evaluation metric to use. One of
cosine,fuzzy_match,bleu,gleu,meteor,rouge_1,rouge_2,rouge_3,rouge_4,rouge_5, orrouge_l.
-
Method Summary
Modifier and Type Method Description final TextSimilarityGrader.EvaluationMetricevaluationMetric()The evaluation metric to use. final Stringinput()The text being graded. final Stringname()The name of the grader. final Stringreference()The text being graded against. final JsonValue_type()The type of grader. final JsonField<TextSimilarityGrader.EvaluationMetric>_evaluationMetric()Returns the raw JSON value of evaluationMetric. final JsonField<String>_input()Returns the raw JSON value of input. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<String>_reference()Returns the raw JSON value of reference. final Map<String, JsonValue>_additionalProperties()final TextSimilarityGrader.BuildertoBuilder()final TextSimilarityGradervalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static TextSimilarityGrader.Builderbuilder()Returns a mutable builder for constructing an instance of TextSimilarityGrader. -
-
Method Detail
-
evaluationMetric
final TextSimilarityGrader.EvaluationMetric evaluationMetric()
The evaluation metric to use. One of
cosine,fuzzy_match,bleu,gleu,meteor,rouge_1,rouge_2,rouge_3,rouge_4,rouge_5, orrouge_l.
-
_type
final JsonValue _type()
The type of grader.
Expected to always return the following:
JsonValue.from("text_similarity")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_evaluationMetric
final JsonField<TextSimilarityGrader.EvaluationMetric> _evaluationMetric()
Returns the raw JSON value of evaluationMetric.
Unlike evaluationMetric, this method doesn't throw if the JSON field has an unexpected type.
-
_input
final JsonField<String> _input()
Returns the raw JSON value of input.
Unlike input, this method doesn't throw if the JSON field has an unexpected type.
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, this method doesn't throw if the JSON field has an unexpected type.
-
_reference
final JsonField<String> _reference()
Returns the raw JSON value of reference.
Unlike reference, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final TextSimilarityGrader.Builder toBuilder()
-
validate
final TextSimilarityGrader validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static TextSimilarityGrader.Builder builder()
Returns a mutable builder for constructing an instance of TextSimilarityGrader.
The following fields are required:
.evaluationMetric() .input() .name() .reference()
-
-
-
-