feat: Added CLI for features, get historical and online features#5197

ntkathole

What this PR does / why we need it:

This PR adds CLI for listing and describing features, getting online and historical feature values.
As a user, I should be able to perform "querying of an entity" from the feast CLI.
As a user, I should be able to export all my features into json format.

Misc

Features

# feast features --help Usage: feast features [OPTIONS] COMMAND [ARGS]... Access features Options: --help Show this message and exit. Commands: describe Describe a specific feature by name list List all features

# feast features list Feature Feature View Data Type conv_rate driver_hourly_stats_fresh Float32 acc_rate driver_hourly_stats_fresh Float32 avg_daily_trips driver_hourly_stats_fresh Int64 conv_rate driver_hourly_stats Float32 acc_rate driver_hourly_stats Float32 avg_daily_trips driver_hourly_stats Int64 conv_rate_plus_val1 transformed_conv_rate_fresh Float64 conv_rate_plus_val2 transformed_conv_rate_fresh Float64 conv_rate_plus_val1 transformed_conv_rate Float64 conv_rate_plus_val2 transformed_conv_rate Float64

Exporting features in json

feast features list --output json > file.json

# feast features describe conv_rate [ { "Feature Name": "conv_rate", "Feature View": "driver_hourly_stats_fresh", "Data Type": "Float32", "Description": "", "Online Store": true, "Source": { "type": "BATCH_FILE", "timestampField": "event_timestamp", "createdTimestampColumn": "created", "fileOptions": { "uri": "data/driver_stats.parquet" }, "name": "driver_hourly_stats_source" } }, { "Feature Name": "conv_rate", "Feature View": "driver_hourly_stats", "Data Type": "Float32", "Description": "", "Online Store": true, "Source": { "type": "BATCH_FILE", "timestampField": "event_timestamp", "createdTimestampColumn": "created", "fileOptions": { "uri": "data/driver_stats.parquet" }, "name": "driver_hourly_stats_source" } } ]

Online Feature data

# feast get-online-features --help Usage: feast get-online-features [OPTIONS] Fetch online feature values for a given entity ID Options: -e, --entities TEXT Entity key-value pairs (e.g., driver_id=1001) [required] -f, --features TEXT Features to retrieve. feater-view:feature-name ex: driver_hourly_stats:conv_rate [required] --help Show this message and exit.

# feast get-online-features --entities driver_id=1001 --features driver_hourly_stats:conv_rate { "driver_id": [ 1001 ], "conv_rate": [ 0.1379641592502594 ] }

Historical Feature data

# feast get-historical-features --help Usage: feast get-historical-features [OPTIONS] Fetch historical feature values for a given entity ID Options: -d, --dataframe TEXT JSON string containing entities and timestamps. Example: '[{"event_timestamp": "2025-03-29T12:00:00", "driver_id": 1001}]' [required] -f, --features TEXT Features to retrieve. feature-view:feature-name ex: driver_hourly_stats:conv_rate [required] --help Show this message and exit.

# feast get-historical-features --dataframe '[{"event_timestamp": "2025-03-29T12:00:00", "driver_id": 1001}]' --features driver_hourly_stats:conv_rate [ { "event_timestamp":1743249600000, "driver_id":1001, "conv_rate":0.851655364 } ]

franciscojavierarceo

Small questions but this lgtm

?

It was not added as a part of templates in #5194 so infra/scripts/compile-templates.py was removing it. Added to the templates now.

franciscojavierarceo

Thank you!

ntkathole requested a review from a team as a code owner March 30, 2025 10:05

franciscojavierarceo approved these changes Mar 30, 2025

View reviewed changes

ntkathole force-pushed the feature_cli branch from 20ca0f9 to af69b3e Compare March 30, 2025 11:26

feat: Added CLI for features, get_historical_features, get_online_fea… …

7fd8f8a

…tures Signed-off-by: ntkathole <nikhilkathole2683@gmail.com>

ntkathole force-pushed the feature_cli branch from af69b3e to 7fd8f8a Compare March 30, 2025 11:55

franciscojavierarceo approved these changes Mar 30, 2025

View reviewed changes

franciscojavierarceo merged commit 4ab9f74 into feast-dev:master Mar 30, 2025

jfw-ppi pushed a commit to jfw-ppi/feast that referenced this pull request Jun 7, 2025

feat: Added CLI for features, get historical and online features (fea… …

65372ea

…st-dev#5197) Signed-off-by: Jacob Weinhold <29459386+j-wine@users.noreply.github.com>

               Please refer to the official documentation at [Documentation](https://docs.feast.dev/)
                * [Quickstart](https://docs.feast.dev/getting-started/quickstart)
                * [Tutorials](https://docs.feast.dev/tutorials/tutorials-overview)
-               * [Examples](https://github.com/feast-dev/feast/tree/master/examples)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Added CLI for features, get historical and online features#5197