Class RagRetrievalConfig.Filter.Builder (1.43.0)

Version latest

• 1.43.0 (latest)
• 1.42.0
• 1.40.0
• 1.38.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.30.0
• 1.28.0
• 1.27.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.20.1
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.8.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static final class RagRetrievalConfig.Filter.Builder extends GeneratedMessage.Builder<RagRetrievalConfig.Filter.Builder> implements RagRetrievalConfig.FilterOrBuilder

Config for filters.

Protobuf type google.cloud.vertexai.v1.RagRetrievalConfig.Filter

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > RagRetrievalConfig.Filter.Builder

Implements

RagRetrievalConfig.FilterOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

build()

public RagRetrievalConfig.Filter build()

Returns
Type	Description
RagRetrievalConfig.Filter

buildPartial()

public RagRetrievalConfig.Filter buildPartial()

Returns
Type	Description
RagRetrievalConfig.Filter

clear()

public RagRetrievalConfig.Filter.Builder clear()

Returns
Type	Description
RagRetrievalConfig.Filter.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearMetadataFilter()

public RagRetrievalConfig.Filter.Builder clearMetadataFilter()

Optional. String for metadata filtering.

string metadata_filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
RagRetrievalConfig.Filter.Builder	This builder for chaining.

clearVectorDbThreshold()

public RagRetrievalConfig.Filter.Builder clearVectorDbThreshold()

Returns
Type	Description
RagRetrievalConfig.Filter.Builder

clearVectorDistanceThreshold()

public RagRetrievalConfig.Filter.Builder clearVectorDistanceThreshold()

Optional. Only returns contexts with vector distance smaller than the threshold.

double vector_distance_threshold = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
RagRetrievalConfig.Filter.Builder	This builder for chaining.

clearVectorSimilarityThreshold()

public RagRetrievalConfig.Filter.Builder clearVectorSimilarityThreshold()

Optional. Only returns contexts with vector similarity larger than the threshold.

double vector_similarity_threshold = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
RagRetrievalConfig.Filter.Builder	This builder for chaining.

getDefaultInstanceForType()

public RagRetrievalConfig.Filter getDefaultInstanceForType()

Returns
Type	Description
RagRetrievalConfig.Filter

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getMetadataFilter()

public String getMetadataFilter()

Optional. String for metadata filtering.

string metadata_filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The metadataFilter.

getMetadataFilterBytes()

public ByteString getMetadataFilterBytes()

Optional. String for metadata filtering.

string metadata_filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for metadataFilter.

getVectorDbThresholdCase()

public RagRetrievalConfig.Filter.VectorDbThresholdCase getVectorDbThresholdCase()

Returns
Type	Description
RagRetrievalConfig.Filter.VectorDbThresholdCase

getVectorDistanceThreshold()

public double getVectorDistanceThreshold()

Optional. Only returns contexts with vector distance smaller than the threshold.

double vector_distance_threshold = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
double	The vectorDistanceThreshold.

getVectorSimilarityThreshold()

public double getVectorSimilarityThreshold()

Optional. Only returns contexts with vector similarity larger than the threshold.

double vector_similarity_threshold = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
double	The vectorSimilarityThreshold.

hasVectorDistanceThreshold()

public boolean hasVectorDistanceThreshold()

Optional. Only returns contexts with vector distance smaller than the threshold.

double vector_distance_threshold = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the vectorDistanceThreshold field is set.

hasVectorSimilarityThreshold()

public boolean hasVectorSimilarityThreshold()

Optional. Only returns contexts with vector similarity larger than the threshold.

double vector_similarity_threshold = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the vectorSimilarityThreshold field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(RagRetrievalConfig.Filter other)

public RagRetrievalConfig.Filter.Builder mergeFrom(RagRetrievalConfig.Filter other)

Parameter
Name	Description
other	RagRetrievalConfig.Filter

Returns
Type	Description
RagRetrievalConfig.Filter.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RagRetrievalConfig.Filter.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RagRetrievalConfig.Filter.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public RagRetrievalConfig.Filter.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
RagRetrievalConfig.Filter.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

setMetadataFilter(String value)

public RagRetrievalConfig.Filter.Builder setMetadataFilter(String value)

Optional. String for metadata filtering.

string metadata_filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The metadataFilter to set.

Returns
Type	Description
RagRetrievalConfig.Filter.Builder	This builder for chaining.

setMetadataFilterBytes(ByteString value)

public RagRetrievalConfig.Filter.Builder setMetadataFilterBytes(ByteString value)

Optional. String for metadata filtering.

string metadata_filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for metadataFilter to set.

Returns
Type	Description
RagRetrievalConfig.Filter.Builder	This builder for chaining.

setVectorDistanceThreshold(double value)

public RagRetrievalConfig.Filter.Builder setVectorDistanceThreshold(double value)

Optional. Only returns contexts with vector distance smaller than the threshold.

double vector_distance_threshold = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	double The vectorDistanceThreshold to set.

Returns
Type	Description
RagRetrievalConfig.Filter.Builder	This builder for chaining.

setVectorSimilarityThreshold(double value)

public RagRetrievalConfig.Filter.Builder setVectorSimilarityThreshold(double value)

Optional. Only returns contexts with vector similarity larger than the threshold.

double vector_similarity_threshold = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	double The vectorSimilarityThreshold to set.

Returns
Type	Description
RagRetrievalConfig.Filter.Builder	This builder for chaining.