​
SelectClause

SelectClause(
    value_param,
    schema,
    vector_parts,
    fields_to_exclude
)

​
Parameters

​
value_param
TypedParam | Evaluated[TypedParam]
required
The typed parameter or evaluated typed parameter for the select clause.
​
schema
IdSchemaObject
required
The schema object that defines the structure of the data.
​
vector_parts
Sequence[Space]
required
The sequence of spaces that define the vector components.
​
fields_to_exclude
Sequence[SchemaField]
required
The sequence of schema fields to exclude from the query results.

​
Inheritance

Inheritance Chain:
  • SelectClause
  • → QueryClause
  • → ABC

​
Properties

​
fields_to_exclude
Sequence[SchemaField]
The sequence of schema fields to exclude from the query results.
​
schema
IdSchemaObject
The schema object that defines the structure of the data.

​
Static Methods

​
from_param()

from_param(
    schema,
    fields,
    vector_parts,
    fields_to_exclude
) -> SelectClause
​
schema
IdSchemaObject
required
The schema object that defines the structure of the data.
​
fields
Param | Sequence[str]
required
The parameter or sequence of field names to select.
​
vector_parts
Sequence[Space]
required
The sequence of spaces that define the vector components.
​
fields_to_exclude
Sequence[SchemaField]
required
The sequence of schema fields to exclude from the query results.
Returns: SelectClause - A new select clause instance with the specified configuration.

​
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 selected fields.
Returns: KNNSearchClauseParams - The modified search parameters with the selected fields applied.