Class EvaluationResult.SemanticSimilarityResult (0.3.0)

public static final class EvaluationResult.SemanticSimilarityResult extends GeneratedMessage implements EvaluationResult.SemanticSimilarityResultOrBuilder

The result of the semantic similarity check.

Protobuf type google.cloud.ces.v1beta.EvaluationResult.SemanticSimilarityResult

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > EvaluationResult.SemanticSimilarityResult

Static Fields

EXPLANATION_FIELD_NUMBER

public static final int EXPLANATION_FIELD_NUMBER
Field Value
Type Description
int

LABEL_FIELD_NUMBER

public static final int LABEL_FIELD_NUMBER
Field Value
Type Description
int

OUTCOME_FIELD_NUMBER

public static final int OUTCOME_FIELD_NUMBER
Field Value
Type Description
int

SCORE_FIELD_NUMBER

public static final int SCORE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static EvaluationResult.SemanticSimilarityResult getDefaultInstance()
Returns
Type Description
EvaluationResult.SemanticSimilarityResult

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static EvaluationResult.SemanticSimilarityResult.Builder newBuilder()
Returns
Type Description
EvaluationResult.SemanticSimilarityResult.Builder

newBuilder(EvaluationResult.SemanticSimilarityResult prototype)

public static EvaluationResult.SemanticSimilarityResult.Builder newBuilder(EvaluationResult.SemanticSimilarityResult prototype)
Parameter
Name Description
prototype EvaluationResult.SemanticSimilarityResult
Returns
Type Description
EvaluationResult.SemanticSimilarityResult.Builder

parseDelimitedFrom(InputStream input)

public static EvaluationResult.SemanticSimilarityResult parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EvaluationResult.SemanticSimilarityResult
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EvaluationResult.SemanticSimilarityResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EvaluationResult.SemanticSimilarityResult
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static EvaluationResult.SemanticSimilarityResult parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
EvaluationResult.SemanticSimilarityResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static EvaluationResult.SemanticSimilarityResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EvaluationResult.SemanticSimilarityResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static EvaluationResult.SemanticSimilarityResult parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
EvaluationResult.SemanticSimilarityResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static EvaluationResult.SemanticSimilarityResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EvaluationResult.SemanticSimilarityResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static EvaluationResult.SemanticSimilarityResult parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
EvaluationResult.SemanticSimilarityResult
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static EvaluationResult.SemanticSimilarityResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EvaluationResult.SemanticSimilarityResult
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static EvaluationResult.SemanticSimilarityResult parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EvaluationResult.SemanticSimilarityResult
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EvaluationResult.SemanticSimilarityResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EvaluationResult.SemanticSimilarityResult
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static EvaluationResult.SemanticSimilarityResult parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
EvaluationResult.SemanticSimilarityResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static EvaluationResult.SemanticSimilarityResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EvaluationResult.SemanticSimilarityResult
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<EvaluationResult.SemanticSimilarityResult> parser()
Returns
Type Description
Parser<SemanticSimilarityResult>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public EvaluationResult.SemanticSimilarityResult getDefaultInstanceForType()
Returns
Type Description
EvaluationResult.SemanticSimilarityResult

getExplanation()

public 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 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 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 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 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 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.

getParserForType()

public Parser<EvaluationResult.SemanticSimilarityResult> getParserForType()
Returns
Type Description
Parser<SemanticSimilarityResult>
Overrides

getScore()

public 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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasScore()

public 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public EvaluationResult.SemanticSimilarityResult.Builder newBuilderForType()
Returns
Type Description
EvaluationResult.SemanticSimilarityResult.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected EvaluationResult.SemanticSimilarityResult.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
EvaluationResult.SemanticSimilarityResult.Builder
Overrides

toBuilder()

public EvaluationResult.SemanticSimilarityResult.Builder toBuilder()
Returns
Type Description
EvaluationResult.SemanticSimilarityResult.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException