​
LimitClause

LimitClause(value_param)

​
Parameters

​
value_param
TypedParam | Evaluated[TypedParam]
required
The parameter that specifies the result limit value.

​
Inheritance

Inheritance Chain:
  • LimitClause
  • → SingleValueParamQueryClause
  • → QueryClause
  • → ABC

​
Static Methods

​
from_param()

from_param(limit) -> LimitClause
​
limit
IntParamType
required
The limit parameter to create the clause from.
Returns: LimitClause - A new limit 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 limit.
Returns: KNNSearchClauseParams - The modified search parameters with the limit applied.