Interface RagRetrievalConfig.FilterOrBuilder (3.56.0)

public static interface RagRetrievalConfig.FilterOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getMetadataFilter()

public abstract String getMetadataFilter()

Optional. String for metadata filtering.

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

Returns
Type Description
String

The metadataFilter.

getMetadataFilterBytes()

public abstract 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 abstract RagRetrievalConfig.Filter.VectorDbThresholdCase getVectorDbThresholdCase()
Returns
Type Description
RagRetrievalConfig.Filter.VectorDbThresholdCase

getVectorDistanceThreshold()

public abstract 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 abstract 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 abstract 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 abstract 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.