All Implemented Interfaces:


public final class EvalCreateParams.TestingCriterion.TextSimilarity

A TextSimilarityGrader object which grades text based on similarity metrics.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`EvalCreateParams.TestingCriterion.TextSimilarity.Builder`	A builder for TextSimilarity.

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 TextSimilarityGrader`	`toTextSimilarityGrader()`
`final TextSimilarityGrader.EvaluationMetric`	`evaluationMetric()`	The evaluation metric to use.
`final String`	`input()`	The text being graded.
`final String`	`name()`	The name of the grader.
`final String`	`reference()`	The text being graded against.
`final JsonValue`	`_type()`	The type of grader.
`final Double`	`passThreshold()`	The threshold for the score.
`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 JsonField<Double>`	`_passThreshold()`	Returns the raw JSON value of passThreshold.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final EvalCreateParams.TestingCriterion.TextSimilarity.Builder`	`toBuilder()`
`final EvalCreateParams.TestingCriterion.TextSimilarity`	`validate()`	Validates that the types of all values in this object match their expected types recursively.
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static EvalCreateParams.TestingCriterion.TextSimilarity.Builder`	`builder()`	Returns a mutable builder for constructing an instance of TextSimilarity.

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

- Constructor Detail
- Method Detail
  - toTextSimilarityGrader
```
 final TextSimilarityGrader toTextSimilarityGrader()
```
  - 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, or rouge_l.
  - input
```
 final String input()
```
    The text being graded.
  - name
```
 final String name()
```
    The name of the grader.
  - 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).
  - passThreshold
```
 final Double passThreshold()
```
    The threshold for the score.
  - _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.
  - _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.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - toBuilder
```
 final EvalCreateParams.TestingCriterion.TextSimilarity.Builder toBuilder()
```
  - validate
```
 final EvalCreateParams.TestingCriterion.TextSimilarity 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.
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static EvalCreateParams.TestingCriterion.TextSimilarity.Builder builder()
```
    Returns a mutable builder for constructing an instance of TextSimilarity.
    The following fields are required:
    .evaluationMetric() .input() .name() .reference() .passThreshold()

Class EvalCreateParams.TestingCriterion.TextSimilarity

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

toTextSimilarityGrader

evaluationMetric

input

name

reference

_type

passThreshold

_evaluationMetric

_input

_name

_reference

_passThreshold

_additionalProperties

toBuilder

validate

isValid

equals

hashCode

toString

builder