Class RagContextRecallResult (3.42.0)

public final class RagContextRecallResult extends GeneratedMessageV3 implements RagContextRecallResultOrBuilder

Spec for rag context recall result.

Protobuf type google.cloud.aiplatform.v1beta1.RagContextRecallResult

Static Fields

CONFIDENCE_FIELD_NUMBER

public static final int CONFIDENCE_FIELD_NUMBER
Field Value
TypeDescription
int

EXPLANATION_FIELD_NUMBER

public static final int EXPLANATION_FIELD_NUMBER
Field Value
TypeDescription
int

SCORE_FIELD_NUMBER

public static final int SCORE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static RagContextRecallResult getDefaultInstance()
Returns
TypeDescription
RagContextRecallResult

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static RagContextRecallResult.Builder newBuilder()
Returns
TypeDescription
RagContextRecallResult.Builder

newBuilder(RagContextRecallResult prototype)

public static RagContextRecallResult.Builder newBuilder(RagContextRecallResult prototype)
Parameter
NameDescription
prototypeRagContextRecallResult
Returns
TypeDescription
RagContextRecallResult.Builder

parseDelimitedFrom(InputStream input)

public static RagContextRecallResult parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RagContextRecallResult
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RagContextRecallResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RagContextRecallResult
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RagContextRecallResult parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RagContextRecallResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RagContextRecallResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RagContextRecallResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RagContextRecallResult parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RagContextRecallResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RagContextRecallResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RagContextRecallResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RagContextRecallResult parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RagContextRecallResult
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RagContextRecallResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RagContextRecallResult
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RagContextRecallResult parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RagContextRecallResult
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RagContextRecallResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RagContextRecallResult
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RagContextRecallResult parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RagContextRecallResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RagContextRecallResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RagContextRecallResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RagContextRecallResult> parser()
Returns
TypeDescription
Parser<RagContextRecallResult>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getConfidence()

public float getConfidence()

Output only. Confidence for rag context recall score.

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

Returns
TypeDescription
float

The confidence.

getDefaultInstanceForType()

public RagContextRecallResult getDefaultInstanceForType()
Returns
TypeDescription
RagContextRecallResult

getExplanation()

public String getExplanation()

Output only. Explanation for rag context recall score.

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

Returns
TypeDescription
String

The explanation.

getExplanationBytes()

public ByteString getExplanationBytes()

Output only. Explanation for rag context recall score.

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

Returns
TypeDescription
ByteString

The bytes for explanation.

getParserForType()

public Parser<RagContextRecallResult> getParserForType()
Returns
TypeDescription
Parser<RagContextRecallResult>
Overrides

getScore()

public float getScore()

Output only. RagContextRecall score.

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

Returns
TypeDescription
float

The score.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasConfidence()

public boolean hasConfidence()

Output only. Confidence for rag context recall score.

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

Returns
TypeDescription
boolean

Whether the confidence field is set.

hasScore()

public boolean hasScore()

Output only. RagContextRecall score.

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

Returns
TypeDescription
boolean

Whether the score field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public RagContextRecallResult.Builder newBuilderForType()
Returns
TypeDescription
RagContextRecallResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RagContextRecallResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RagContextRecallResult.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public RagContextRecallResult.Builder toBuilder()
Returns
TypeDescription
RagContextRecallResult.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException