Class RagContextRecallResult.Builder (3.42.0)

public static final class RagContextRecallResult.Builder extends GeneratedMessageV3.Builder<RagContextRecallResult.Builder> implements RagContextRecallResultOrBuilder

Spec for rag context recall result.

Protobuf type google.cloud.aiplatform.v1beta1.RagContextRecallResult

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RagContextRecallResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RagContextRecallResult.Builder
Overrides

build()

public RagContextRecallResult build()
Returns
Type Description
RagContextRecallResult

buildPartial()

public RagContextRecallResult buildPartial()
Returns
Type Description
RagContextRecallResult

clear()

public RagContextRecallResult.Builder clear()
Returns
Type Description
RagContextRecallResult.Builder
Overrides

clearConfidence()

public RagContextRecallResult.Builder clearConfidence()

Output only. Confidence for rag context recall score.

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

Returns
Type Description
RagContextRecallResult.Builder

This builder for chaining.

clearExplanation()

public RagContextRecallResult.Builder clearExplanation()

Output only. Explanation for rag context recall score.

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

Returns
Type Description
RagContextRecallResult.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public RagContextRecallResult.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RagContextRecallResult.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public RagContextRecallResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RagContextRecallResult.Builder
Overrides

clearScore()

public RagContextRecallResult.Builder clearScore()

Output only. RagContextRecall score.

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

Returns
Type Description
RagContextRecallResult.Builder

This builder for chaining.

clone()

public RagContextRecallResult.Builder clone()
Returns
Type Description
RagContextRecallResult.Builder
Overrides

getConfidence()

public float getConfidence()

Output only. Confidence for rag context recall score.

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

Returns
Type Description
float

The confidence.

getDefaultInstanceForType()

public RagContextRecallResult getDefaultInstanceForType()
Returns
Type Description
RagContextRecallResult

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getExplanation()

public String getExplanation()

Output only. Explanation for rag context recall score.

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

Returns
Type Description
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
Type Description
ByteString

The bytes for explanation.

getScore()

public float getScore()

Output only. RagContextRecall score.

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

Returns
Type Description
float

The score.

hasConfidence()

public boolean hasConfidence()

Output only. Confidence for rag context recall 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. RagContextRecall score.

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

Returns
Type Description
boolean

Whether the score field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RagContextRecallResult other)

public RagContextRecallResult.Builder mergeFrom(RagContextRecallResult other)
Parameter
Name Description
other RagContextRecallResult
Returns
Type Description
RagContextRecallResult.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RagContextRecallResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagContextRecallResult.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RagContextRecallResult.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RagContextRecallResult.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RagContextRecallResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RagContextRecallResult.Builder
Overrides

setConfidence(float value)

public RagContextRecallResult.Builder setConfidence(float value)

Output only. Confidence for rag context recall score.

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

Parameter
Name Description
value float

The confidence to set.

Returns
Type Description
RagContextRecallResult.Builder

This builder for chaining.

setExplanation(String value)

public RagContextRecallResult.Builder setExplanation(String value)

Output only. Explanation for rag context recall score.

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

Parameter
Name Description
value String

The explanation to set.

Returns
Type Description
RagContextRecallResult.Builder

This builder for chaining.

setExplanationBytes(ByteString value)

public RagContextRecallResult.Builder setExplanationBytes(ByteString value)

Output only. Explanation for rag context recall score.

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

Parameter
Name Description
value ByteString

The bytes for explanation to set.

Returns
Type Description
RagContextRecallResult.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public RagContextRecallResult.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RagContextRecallResult.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RagContextRecallResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RagContextRecallResult.Builder
Overrides

setScore(float value)

public RagContextRecallResult.Builder setScore(float value)

Output only. RagContextRecall score.

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

Parameter
Name Description
value float

The score to set.

Returns
Type Description
RagContextRecallResult.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RagContextRecallResult.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RagContextRecallResult.Builder
Overrides