RadiusClause

RadiusClause(value_param)

Parameters

value_param
TypedParam | Evaluated[TypedParam]
required
The parameter that specifies the radius value.

Inheritance

Inheritance Chain:
  • RadiusClause
  • SingleValueParamQueryClause
  • QueryClause
  • ABC

Static Methods

from_param()

from_param(radius) -> RadiusClause
radius
FloatParamType
required
The radius parameter to create the clause from.
Returns: RadiusClause - A new radius clause instance.

Methods

get_altered_knn_search_params()

get_altered_knn_search_params(knn_search_clause_params) -> KNNSearchClauseParams
knn_search_clause_params
KNNSearchClauseParams
required
The KNN search parameters to modify with the radius.
Returns: KNNSearchClauseParams - The modified search parameters with the radius applied.