Skip to content

Commit 44a4820

Browse files
committed
Update Feast Java SDK documentation to support project namespacing
1 parent c5e1bd9 commit 44a4820

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

sdk/java/src/main/java/com/gojek/feast/v1alpha1/FeastClient.java

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,13 @@ public GetFeastServingInfoResponse getFeastServingInfo() {
5959
/**
6060
* Get online features from Feast.
6161
*
62-
* <p>See {@link #getOnlineFeatures(List, List, boolean)}
62+
* <p>See {@link #getOnlineFeatures(List, List, str)}
6363
*
6464
* @param features list of string feature references to retrieve, feature reference follows this format
6565
* [project]/[name]:[version]
6666
* @param rows list of {@link Row} to select the entities to retrieve the features for
67+
* @param defaultProject {@link String} Default project to find features in if not provided in
68+
* feature reference.
6769
* @return list of {@link Row} containing features
6870
*/
6971
public List<Row> getOnlineFeatures(List<String> features, List<Row> rows, String defaultProject) {
@@ -73,21 +75,23 @@ public List<Row> getOnlineFeatures(List<String> features, List<Row> rows, String
7375
/**
7476
* Get online features from Feast.
7577
*
76-
* <p>Example of retrieving online features for driver feature set, version 1, with features
77-
* driver_id and driver_name
78+
* <p>Example of retrieving online features for the driver project, with features
79+
* driver_id and driver_name, both version 1
7880
*
7981
* <pre>{@code
8082
* FeastClient client = FeastClient.create("localhost", 6566);
81-
* List<String> requestedFeatureIds = Arrays.asList("driver:1:driver_id", "driver:1:driver_name");
83+
* List<String> requestedFeatureIds = Arrays.asList("driver/driver_id:1", "driver/driver_name:1");
8284
* List<Row> requestedRows =
8385
* Arrays.asList(Row.create().set("driver_id", 123), Row.create().set("driver_id", 456));
8486
* List<Row> retrievedFeatures = client.getOnlineFeatures(requestedFeatureIds, requestedRows);
8587
* retrievedFeatures.forEach(System.out::println);
8688
* }</pre>
8789
*
88-
* @param featureIds list of feature id to retrieve, feature id follows this format
89-
* [feature_set_name]:[version]:[feature_name]
90+
* @param featureRefStrings list of feature refs to retrieve, feature refs follow this format
91+
* [project]/[name]:[version]
9092
* @param rows list of {@link Row} to select the entities to retrieve the features for
93+
* @param defaultProject {@link String} Default project to find features in if not provided in
94+
* feature reference.
9195
* @param omitEntitiesInResponse if true, the returned {@link Row} will not contain field and
9296
* value for the entity
9397
* @return list of {@link Row} containing features

0 commit comments

Comments
 (0)