Parameter classes that define configuration options for different types of query clauses.

​
KNNSearchClauseParams

KNNSearchClauseParams(limit=None, filters=<factory>, schema_fields_to_return=<factory>, radius=None, should_return_index_vector=False)

​
Parameters

​
limit
int | None
default:"None"
Maximum number of results to return.
​
filters
Sequence[ComparisonOperation[SchemaField]]
default:"<factory>"
Sequence of filter operations to apply.
​
schema_fields_to_return
Sequence[SchemaField]
default:"<factory>"
Sequence of schema fields to include in results.
​
radius
float | None
default:"None"
Search radius for distance-based filtering.
​
should_return_index_vector
bool
default:"False"
Whether to return the index vector in results.

​
Properties

​
filters
Sequence[ComparisonOperation[SchemaField]]
The configured filter operations.
​
limit
int | None
The configured result limit.
​
radius
float | None
The configured search radius.
​
schema_fields_to_return
Sequence[SchemaField]
The configured schema fields to return.
​
should_return_index_vector
bool
Whether index vectors should be returned.

​
ParamEvaluationResult

ParamEvaluationResult(params, query_vectors)

​
Parameters

​
params
KNNSearchClauseParams
required
The evaluated clause parameters.
​
query_vectors
QueryVectors
required
The query vectors associated with the parameters.

​
Properties

​
params
KNNSearchClauseParams
The evaluated clause parameters.
​
query_vectors
QueryVectors
The associated query vectors.