Package com.google.genai.types

Class RagRetrievalConfigFilter

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.RagRetrievalConfigFilter

public abstract class RagRetrievalConfigFilter
extends JsonSerializable

Config for filters.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RagRetrievalConfigFilter.Builder	Builder for RagRetrievalConfigFilter.

Constructor Summary

Constructors

Constructor	Description
RagRetrievalConfigFilter()

Method Summary

Modifier and Type	Method	Description
static RagRetrievalConfigFilter.Builder	builder()	Instantiates a builder for RagRetrievalConfigFilter.
static RagRetrievalConfigFilter	fromJson(String jsonString)	Deserializes a JSON string to a RagRetrievalConfigFilter object.
abstract Optional<String>	metadataFilter()	Optional.
abstract RagRetrievalConfigFilter.Builder	toBuilder()	Creates a builder with the same values as this instance.
abstract Optional<Double>	vectorDistanceThreshold()	Optional.
abstract Optional<Double>	vectorSimilarityThreshold()	Optional.

Methods inherited from class com.google.genai.JsonSerializable

stringToJsonNode, toJson

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RagRetrievalConfigFilter

public RagRetrievalConfigFilter()

Method Details

metadataFilter

public abstract Optional<String> metadataFilter()

Optional. String for metadata filtering.

vectorDistanceThreshold

public abstract Optional<Double> vectorDistanceThreshold()

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

vectorSimilarityThreshold

public abstract Optional<Double> vectorSimilarityThreshold()

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

builder

public static RagRetrievalConfigFilter.Builder builder()

Instantiates a builder for RagRetrievalConfigFilter.

toBuilder

public abstract RagRetrievalConfigFilter.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static RagRetrievalConfigFilter fromJson(String jsonString)

Deserializes a JSON string to a RagRetrievalConfigFilter object.