com.google.cloud.vertexai.api

Interface RagRetrievalConfig.FilterOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

RagRetrievalConfig.Filter, RagRetrievalConfig.Filter.Builder

Enclosing class:

RagRetrievalConfig

public static interface RagRetrievalConfig.FilterOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasVectorDistanceThreshold

boolean hasVectorDistanceThreshold()

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

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

Returns:

Whether the vectorDistanceThreshold field is set.

getVectorDistanceThreshold

double getVectorDistanceThreshold()

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

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

Returns:

The vectorDistanceThreshold.

hasVectorSimilarityThreshold

boolean hasVectorSimilarityThreshold()

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

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

Returns:

Whether the vectorSimilarityThreshold field is set.

getVectorSimilarityThreshold

double getVectorSimilarityThreshold()

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

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

Returns:

The vectorSimilarityThreshold.

getMetadataFilter

String getMetadataFilter()

 Optional. String for metadata filtering.
 

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

Returns:

The metadataFilter.

getMetadataFilterBytes

com.google.protobuf.ByteString getMetadataFilterBytes()

 Optional. String for metadata filtering.
 

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

Returns:

The bytes for metadataFilter.

getVectorDbThresholdCase

RagRetrievalConfig.Filter.VectorDbThresholdCase getVectorDbThresholdCase()