Google Cloud Ai Platform V1 Client - Class Filter (1.54.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Filter.

Config for filters.

Generated from protobuf message google.cloud.aiplatform.v1.RagRetrievalConfig.Filter

Namespace

Google \ Cloud \ AIPlatform \ V1 \ RagRetrievalConfig

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ vector_distance_threshold float

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

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

Optional. String for metadata filtering.

getVectorDistanceThreshold

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

Returns
Type Description
float

hasVectorDistanceThreshold

setVectorDistanceThreshold

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

Parameter
Name Description
var float
Returns
Type Description
$this

getVectorSimilarityThreshold

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

Returns
Type Description
float

hasVectorSimilarityThreshold

setVectorSimilarityThreshold

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

Parameter
Name Description
var float
Returns
Type Description
$this

getMetadataFilter

Optional. String for metadata filtering.

Returns
Type Description
string

setMetadataFilter

Optional. String for metadata filtering.

Parameter
Name Description
var string
Returns
Type Description
$this

getVectorDbThreshold

Returns
Type Description
string