Class GroundednessResult (3.47.0)

public final class GroundednessResult extends GeneratedMessageV3 implements GroundednessResultOrBuilder

Spec for groundedness result.

Protobuf type google.cloud.aiplatform.v1beta1.GroundednessResult

Static Fields

CONFIDENCE_FIELD_NUMBER

public static final int CONFIDENCE_FIELD_NUMBER
Field Value
Type Description
int

EXPLANATION_FIELD_NUMBER

public static final int EXPLANATION_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 GroundednessResult getDefaultInstance()
Returns
Type Description
GroundednessResult

getDescriptor()

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

newBuilder()

public static GroundednessResult.Builder newBuilder()
Returns
Type Description
GroundednessResult.Builder

newBuilder(GroundednessResult prototype)

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

parseDelimitedFrom(InputStream input)

public static GroundednessResult parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GroundednessResult
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static GroundednessResult parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GroundednessResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static GroundednessResult parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GroundednessResult
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static GroundednessResult parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GroundednessResult
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static GroundednessResult parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GroundednessResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<GroundednessResult> parser()
Returns
Type Description
Parser<GroundednessResult>

Methods

equals(Object obj)

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

getConfidence()

public float getConfidence()

Output only. Confidence for groundedness score.

optional float confidence = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
float

The confidence.

getDefaultInstanceForType()

public GroundednessResult getDefaultInstanceForType()
Returns
Type Description
GroundednessResult

getExplanation()

public String getExplanation()

Output only. Explanation for groundedness score.

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

Returns
Type Description
String

The explanation.

getExplanationBytes()

public ByteString getExplanationBytes()

Output only. Explanation for groundedness score.

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

Returns
Type Description
ByteString

The bytes for explanation.

getParserForType()

public Parser<GroundednessResult> getParserForType()
Returns
Type Description
Parser<GroundednessResult>
Overrides

getScore()

public float getScore()

Output only. Groundedness score.

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

Returns
Type Description
float

The score.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasConfidence()

public boolean hasConfidence()

Output only. Confidence for groundedness score.

optional float confidence = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the confidence field is set.

hasScore()

public boolean hasScore()

Output only. Groundedness score.

optional float 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 GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public GroundednessResult.Builder newBuilderForType()
Returns
Type Description
GroundednessResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GroundednessResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GroundednessResult.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public GroundednessResult.Builder toBuilder()
Returns
Type Description
GroundednessResult.Builder

writeTo(CodedOutputStream output)

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