RagRetrievalConfig.Filter.Builder (proto-google-cloud-aiplatform-v1beta1 0.73.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<RagRetrievalConfig.Filter.Builder>
    - - com.google.cloud.aiplatform.v1beta1.RagRetrievalConfig.Filter.Builder

All Implemented Interfaces:

RagRetrievalConfig.FilterOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

RagRetrievalConfig.Filter
```
public static final class RagRetrievalConfig.Filter.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RagRetrievalConfig.Filter.Builder>
implements RagRetrievalConfig.FilterOrBuilder
```
```
 Config for filters.
 
```
Protobuf type google.cloud.aiplatform.v1beta1.RagRetrievalConfig.Filter

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RagRetrievalConfig.Filter.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`RagRetrievalConfig.Filter`	`build()`
`RagRetrievalConfig.Filter`	`buildPartial()`
`RagRetrievalConfig.Filter.Builder`	`clear()`
`RagRetrievalConfig.Filter.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`RagRetrievalConfig.Filter.Builder`	`clearMetadataFilter()` Optional.
`RagRetrievalConfig.Filter.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`RagRetrievalConfig.Filter.Builder`	`clearVectorDbThreshold()`
`RagRetrievalConfig.Filter.Builder`	`clearVectorDistanceThreshold()` Optional.
`RagRetrievalConfig.Filter.Builder`	`clearVectorSimilarityThreshold()` Optional.
`RagRetrievalConfig.Filter.Builder`	`clone()`
`RagRetrievalConfig.Filter`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getMetadataFilter()` Optional.
`com.google.protobuf.ByteString`	`getMetadataFilterBytes()` Optional.
`RagRetrievalConfig.Filter.VectorDbThresholdCase`	`getVectorDbThresholdCase()`
`double`	`getVectorDistanceThreshold()` Optional.
`double`	`getVectorSimilarityThreshold()` Optional.
`boolean`	`hasVectorDistanceThreshold()` Optional.
`boolean`	`hasVectorSimilarityThreshold()` Optional.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`RagRetrievalConfig.Filter.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`RagRetrievalConfig.Filter.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`RagRetrievalConfig.Filter.Builder`	`mergeFrom(RagRetrievalConfig.Filter other)`
`RagRetrievalConfig.Filter.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`RagRetrievalConfig.Filter.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`RagRetrievalConfig.Filter.Builder`	`setMetadataFilter(String value)` Optional.
`RagRetrievalConfig.Filter.Builder`	`setMetadataFilterBytes(com.google.protobuf.ByteString value)` Optional.
`RagRetrievalConfig.Filter.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`RagRetrievalConfig.Filter.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`RagRetrievalConfig.Filter.Builder`	`setVectorDistanceThreshold(double value)` Optional.
`RagRetrievalConfig.Filter.Builder`	`setVectorSimilarityThreshold(double value)` Optional.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RagRetrievalConfig.Filter.Builder>
  - clear
```
public RagRetrievalConfig.Filter.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<RagRetrievalConfig.Filter.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RagRetrievalConfig.Filter.Builder>
  - getDefaultInstanceForType
```
public RagRetrievalConfig.Filter getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public RagRetrievalConfig.Filter build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public RagRetrievalConfig.Filter buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public RagRetrievalConfig.Filter.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<RagRetrievalConfig.Filter.Builder>
  - setField
```
public RagRetrievalConfig.Filter.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<RagRetrievalConfig.Filter.Builder>
  - clearField
```
public RagRetrievalConfig.Filter.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RagRetrievalConfig.Filter.Builder>
  - clearOneof
```
public RagRetrievalConfig.Filter.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RagRetrievalConfig.Filter.Builder>
  - setRepeatedField
```
public RagRetrievalConfig.Filter.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                          int index,
                                                          Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RagRetrievalConfig.Filter.Builder>
  - addRepeatedField
```
public RagRetrievalConfig.Filter.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                          Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RagRetrievalConfig.Filter.Builder>
  - mergeFrom
```
public RagRetrievalConfig.Filter.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RagRetrievalConfig.Filter.Builder>
  - mergeFrom
```
public RagRetrievalConfig.Filter.Builder mergeFrom(RagRetrievalConfig.Filter other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RagRetrievalConfig.Filter.Builder>
  - mergeFrom
```
public RagRetrievalConfig.Filter.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RagRetrievalConfig.Filter.Builder>
    
    Throws:
    
    IOException
  - getVectorDbThresholdCase
```
public RagRetrievalConfig.Filter.VectorDbThresholdCase getVectorDbThresholdCase()
```
    Specified by:
    
    getVectorDbThresholdCase in interface RagRetrievalConfig.FilterOrBuilder
  - clearVectorDbThreshold
```
public RagRetrievalConfig.Filter.Builder clearVectorDbThreshold()
```
  - 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];
    Specified by:
    
    hasVectorDistanceThreshold in interface RagRetrievalConfig.FilterOrBuilder
    
    Returns:
    
    Whether the vectorDistanceThreshold field is set.
  - 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];
    Specified by:
    
    getVectorDistanceThreshold in interface RagRetrievalConfig.FilterOrBuilder
    
    Returns:
    
    The vectorDistanceThreshold.
  - setVectorDistanceThreshold
```
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];
    Parameters:
    
    value - The vectorDistanceThreshold to set.
    
    Returns:
    
    This builder for chaining.
  - 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:
    
    This builder for chaining.
  - 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];
    Specified by:
    
    hasVectorSimilarityThreshold in interface RagRetrievalConfig.FilterOrBuilder
    
    Returns:
    
    Whether the vectorSimilarityThreshold field is set.
  - 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];
    Specified by:
    
    getVectorSimilarityThreshold in interface RagRetrievalConfig.FilterOrBuilder
    
    Returns:
    
    The vectorSimilarityThreshold.
  - setVectorSimilarityThreshold
```
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];
    Parameters:
    
    value - The vectorSimilarityThreshold to set.
    
    Returns:
    
    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:
    
    This builder for chaining.
  - getMetadataFilter
```
public String getMetadataFilter()
```
```
 Optional. String for metadata filtering.
 
```
    string metadata_filter = 2 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getMetadataFilter in interface RagRetrievalConfig.FilterOrBuilder
    
    Returns:
    
    The metadataFilter.
  - getMetadataFilterBytes
```
public com.google.protobuf.ByteString getMetadataFilterBytes()
```
```
 Optional. String for metadata filtering.
 
```
    string metadata_filter = 2 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getMetadataFilterBytes in interface RagRetrievalConfig.FilterOrBuilder
    
    Returns:
    
    The bytes for metadataFilter.
  - setMetadataFilter
```
public RagRetrievalConfig.Filter.Builder setMetadataFilter(String value)
```
```
 Optional. String for metadata filtering.
 
```
    string metadata_filter = 2 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The metadataFilter to set.
    
    Returns:
    
    This builder for chaining.
  - clearMetadataFilter
```
public RagRetrievalConfig.Filter.Builder clearMetadataFilter()
```
```
 Optional. String for metadata filtering.
 
```
    string metadata_filter = 2 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    This builder for chaining.
  - setMetadataFilterBytes
```
public RagRetrievalConfig.Filter.Builder setMetadataFilterBytes(com.google.protobuf.ByteString value)
```
```
 Optional. String for metadata filtering.
 
```
    string metadata_filter = 2 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The bytes for metadataFilter to set.
    
    Returns:
    
    This builder for chaining.
  - setUnknownFields
```
public final RagRetrievalConfig.Filter.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RagRetrievalConfig.Filter.Builder>
  - mergeUnknownFields
```
public final RagRetrievalConfig.Filter.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RagRetrievalConfig.Filter.Builder>

Class RagRetrievalConfig.Filter.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getVectorDbThresholdCase

clearVectorDbThreshold

hasVectorDistanceThreshold

getVectorDistanceThreshold

setVectorDistanceThreshold

clearVectorDistanceThreshold

hasVectorSimilarityThreshold

getVectorSimilarityThreshold

setVectorSimilarityThreshold

clearVectorSimilarityThreshold

getMetadataFilter

getMetadataFilterBytes

setMetadataFilter

clearMetadataFilter

setMetadataFilterBytes

setUnknownFields

mergeUnknownFields