Class RagContextRecallInstance.Builder (3.40.0)

public static final class RagContextRecallInstance.Builder extends GeneratedMessageV3.Builder<RagContextRecallInstance.Builder> implements RagContextRecallInstanceOrBuilder

Spec for rag context recall instance.

Protobuf type google.cloud.aiplatform.v1beta1.RagContextRecallInstance

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RagContextRecallInstance.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RagContextRecallInstance.Builder
Overrides

build()

public RagContextRecallInstance build()
Returns
TypeDescription
RagContextRecallInstance

buildPartial()

public RagContextRecallInstance buildPartial()
Returns
TypeDescription
RagContextRecallInstance

clear()

public RagContextRecallInstance.Builder clear()
Returns
TypeDescription
RagContextRecallInstance.Builder
Overrides

clearContext()

public RagContextRecallInstance.Builder clearContext()

Required. Retrieved facts from RAG pipeline as context to be evaluated.

optional string context = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
RagContextRecallInstance.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public RagContextRecallInstance.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
RagContextRecallInstance.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public RagContextRecallInstance.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
RagContextRecallInstance.Builder
Overrides

clearReference()

public RagContextRecallInstance.Builder clearReference()

Required. Ground truth used to compare against the context.

optional string reference = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
RagContextRecallInstance.Builder

This builder for chaining.

clone()

public RagContextRecallInstance.Builder clone()
Returns
TypeDescription
RagContextRecallInstance.Builder
Overrides

getContext()

public String getContext()

Required. Retrieved facts from RAG pipeline as context to be evaluated.

optional string context = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The context.

getContextBytes()

public ByteString getContextBytes()

Required. Retrieved facts from RAG pipeline as context to be evaluated.

optional string context = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for context.

getDefaultInstanceForType()

public RagContextRecallInstance getDefaultInstanceForType()
Returns
TypeDescription
RagContextRecallInstance

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getReference()

public String getReference()

Required. Ground truth used to compare against the context.

optional string reference = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The reference.

getReferenceBytes()

public ByteString getReferenceBytes()

Required. Ground truth used to compare against the context.

optional string reference = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for reference.

hasContext()

public boolean hasContext()

Required. Retrieved facts from RAG pipeline as context to be evaluated.

optional string context = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the context field is set.

hasReference()

public boolean hasReference()

Required. Ground truth used to compare against the context.

optional string reference = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the reference field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(RagContextRecallInstance other)

public RagContextRecallInstance.Builder mergeFrom(RagContextRecallInstance other)
Parameter
NameDescription
otherRagContextRecallInstance
Returns
TypeDescription
RagContextRecallInstance.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RagContextRecallInstance.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RagContextRecallInstance.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public RagContextRecallInstance.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
RagContextRecallInstance.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RagContextRecallInstance.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RagContextRecallInstance.Builder
Overrides

setContext(String value)

public RagContextRecallInstance.Builder setContext(String value)

Required. Retrieved facts from RAG pipeline as context to be evaluated.

optional string context = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The context to set.

Returns
TypeDescription
RagContextRecallInstance.Builder

This builder for chaining.

setContextBytes(ByteString value)

public RagContextRecallInstance.Builder setContextBytes(ByteString value)

Required. Retrieved facts from RAG pipeline as context to be evaluated.

optional string context = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for context to set.

Returns
TypeDescription
RagContextRecallInstance.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public RagContextRecallInstance.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RagContextRecallInstance.Builder
Overrides

setReference(String value)

public RagContextRecallInstance.Builder setReference(String value)

Required. Ground truth used to compare against the context.

optional string reference = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The reference to set.

Returns
TypeDescription
RagContextRecallInstance.Builder

This builder for chaining.

setReferenceBytes(ByteString value)

public RagContextRecallInstance.Builder setReferenceBytes(ByteString value)

Required. Ground truth used to compare against the context.

optional string reference = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for reference to set.

Returns
TypeDescription
RagContextRecallInstance.Builder

This builder for chaining.

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

public RagContextRecallInstance.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
RagContextRecallInstance.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final RagContextRecallInstance.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RagContextRecallInstance.Builder
Overrides