featurebyte.Catalog.list_feature_lists¶
list_feature_lists(
include_id: Optional[bool]=True,
primary_entity: Union[str, List[str], NoneType]=None,
entity: Optional[str]=None,
table: Optional[str]=None,
context: Optional[str]=None,
use_case: Optional[str]=None
) -> DataFrameDescription¶
Returns a DataFrame that contains various attributes of the registered feature lists. These attributes include the names of the feature lists, the number of features in each list, their status, whether they have been deployed in production, the percentage of production ready features of their default version, the tables used by the features, their related entities, and creation dates.
The resulting DataFrame can be filtered based on the primary entity of the feature lists or the tables utilized by the feature lists.
Parameters¶
- include_id: Optional[bool]
default: True
Whether to include id in the list. - primary_entity: Union[str, List[str], NoneType]
Specifies the primary entity or entities for filtering results. Retrieve feature lists with the specified primary entity name(s). If multiple entities are provided in a list, the filtered results will include feature lists that have primary entities matching any entity in this list. - entity: Optional[str]
Specifies the entity name for filtering results. Retrieve feature lists containing features with the specified entity name as their primary entity. - table: Optional[str]
Specifies the table name for filtering results. Retrieve feature lists associated with the specified table name. - 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¶
- DataFrame
Table of feature lists.