Interface EvaluationResult.SemanticSimilarityResultOrBuilder (0.3.0) 

public static interface EvaluationResult.SemanticSimilarityResultOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getExplanation()

public abstract String getExplanation()

Output only. The explanation for the semantic similarity score.

string explanation = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The explanation.

getExplanationBytes()

public abstract ByteString getExplanationBytes()

Output only. The explanation for the semantic similarity score.

string explanation = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for explanation.

getLabel()

public abstract String getLabel()

Output only. The label associated with each score. Score 4: Fully Consistent Score 3: Mostly Consistent Score 2: Partially Consistent (Minor Omissions) Score 1: Largely Inconsistent (Major Omissions) Score 0: Completely Inconsistent / Contradictory

string label = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The label.

getLabelBytes()

public abstract ByteString getLabelBytes()

Output only. The label associated with each score. Score 4: Fully Consistent Score 3: Mostly Consistent Score 2: Partially Consistent (Minor Omissions) Score 1: Largely Inconsistent (Major Omissions) Score 0: Completely Inconsistent / Contradictory

string label = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for label.

getOutcome()

public abstract EvaluationResult.Outcome getOutcome()

Output only. The outcome of the semantic similarity check. This is determined by comparing the score to the semantic_similarity_success_threshold. If the score is equal to or above the threshold, the outcome will be PASS. Otherwise, the outcome will be FAIL.

.google.cloud.ces.v1beta.EvaluationResult.Outcome outcome = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationResult.Outcome

The outcome.

getOutcomeValue()

public abstract int getOutcomeValue()

Output only. The outcome of the semantic similarity check. This is determined by comparing the score to the semantic_similarity_success_threshold. If the score is equal to or above the threshold, the outcome will be PASS. Otherwise, the outcome will be FAIL.

.google.cloud.ces.v1beta.EvaluationResult.Outcome outcome = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for outcome.

getScore()

public abstract int getScore()

Output only. The semantic similarity score. Can be 0, 1, 2, 3, or 4.

optional int32 score = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The score.

hasScore()

public abstract boolean hasScore()

Output only. The semantic similarity score. Can be 0, 1, 2, 3, or 4.

optional int32 score = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the score field is set.