Skip to content

featurebyte.Catalog.get_feature_list

get_feature_list(
name: str,
version: Optional[str]=None,
context: Optional[str]=None,
use_case: Optional[str]=None
) -> FeatureList

Description

Gets a FeatureList object from the catalog by specifying the feature list's name and, optionally, its version name. If the version name is not provided, the default version of the feature list will be returned.

Parameters

  • name: str
    Feature list name.

  • version: Optional[str]
    Version of the feature list. If None, the default version will be returned.

  • context: Optional[str]
    Name of context used to filter results. If provided, results include both regular features and features specific to that context. If not provided, context-specific features
    (e.g. from user-provided columns) are excluded.

  • use_case: Optional[str]
    Name of use case used to filter results. The context associated with the use case will be used for filtering. Cannot be specified together with context.

Returns

  • FeatureList
    Feature list object.

Examples

>>> feature_list = catalog.get_feature_list("invoice_feature_list")