Class RagContextRecallInstance.Builder (3.42.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
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public RagContextRecallInstance build()
Returns
Type Description
RagContextRecallInstance

buildPartial()

public RagContextRecallInstance buildPartial()
Returns
Type Description
RagContextRecallInstance

clear()

public RagContextRecallInstance.Builder clear()
Returns
Type Description
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
Type Description
RagContextRecallInstance.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

public RagContextRecallInstance.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
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
Type Description
RagContextRecallInstance.Builder

This builder for chaining.

clone()

public RagContextRecallInstance.Builder clone()
Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for context.

getDefaultInstanceForType()

public RagContextRecallInstance getDefaultInstanceForType()
Returns
Type Description
RagContextRecallInstance

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

Whether the reference field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RagContextRecallInstance other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RagContextRecallInstance.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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
Name Description
value String

The context to set.

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

The bytes for context to set.

Returns
Type Description
RagContextRecallInstance.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public RagContextRecallInstance.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
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
Name Description
value String

The reference to set.

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

The bytes for reference to set.

Returns
Type Description
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
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RagContextRecallInstance.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

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