All Implemented Interfaces:
```
public final class EvalTextSimilarityGrader

                    
```
A TextSimilarityGrader object which grades text based on similarity metrics.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`EvalTextSimilarityGrader.Builder`	A builder for EvalTextSimilarityGrader.
`public final class`	`EvalTextSimilarityGrader.EvaluationMetric`	The evaluation metric to use. One of `cosine`, `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, or `rouge_l`.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final EvalTextSimilarityGrader.EvaluationMetric`	`evaluationMetric()`	The evaluation metric to use.
`final String`	`input()`	The text being graded.
`final Double`	`passThreshold()`	A float score where a value greater than or equal indicates a passing grade.
`final String`	`reference()`	The text being graded against.
`final JsonValue`	`_type()`	The type of grader.
`final Optional<String>`	`name()`	The name of the grader.
`final JsonField<EvalTextSimilarityGrader.EvaluationMetric>`	`_evaluationMetric()`	Returns the raw JSON value of evaluationMetric.
`final JsonField<String>`	`_input()`	Returns the raw JSON value of input.
`final JsonField<Double>`	`_passThreshold()`	Returns the raw JSON value of passThreshold.
`final JsonField<String>`	`_reference()`	Returns the raw JSON value of reference.
`final JsonField<String>`	`_name()`	Returns the raw JSON value of name.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final EvalTextSimilarityGrader.Builder`	`toBuilder()`
`final EvalTextSimilarityGrader`	`validate()`
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static EvalTextSimilarityGrader.Builder`	`builder()`	Returns a mutable builder for constructing an instance of EvalTextSimilarityGrader.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - evaluationMetric
```
 final EvalTextSimilarityGrader.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, or rouge_l.
  - input
```
 final String input()
```
    The text being graded.
  - passThreshold
```
 final Double passThreshold()
```
    A float score where a value greater than or equal indicates a passing grade.
  - reference
```
 final String reference()
```
    The text being graded against.
  - _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).
  - name
```
 final Optional<String> name()
```
    The name of the grader.
  - _evaluationMetric
```
 final JsonField<EvalTextSimilarityGrader.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.
  - _passThreshold
```
 final JsonField<Double> _passThreshold()
```
    Returns the raw JSON value of passThreshold.
    Unlike passThreshold, 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.
  - _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.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - toBuilder
```
 final EvalTextSimilarityGrader.Builder toBuilder()
```
  - validate
```
 final EvalTextSimilarityGrader validate()
```
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static EvalTextSimilarityGrader.Builder builder()
```
    Returns a mutable builder for constructing an instance of EvalTextSimilarityGrader.
    The following fields are required:
    .evaluationMetric() .input() .passThreshold() .reference()

Class EvalTextSimilarityGrader

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

evaluationMetric

input

passThreshold

reference

_type

name

_evaluationMetric

_input

_passThreshold

_reference

_name

_additionalProperties

toBuilder

validate

isValid

equals

hashCode

toString

builder