com.gojek.feast

Class FeastClient

java.lang.Object

com.gojek.feast.FeastClient

All Implemented Interfaces:

AutoCloseable

public class FeastClient
extends Object
implements AutoCloseable

Method Summary

Modifier and Type	Method and Description
void	close()
static FeastClient	create(String host, int port) Create a client to access Feast
ServingAPIProto.GetFeastServingInfoResponse	getFeastServingInfo()
List<Row>	getOnlineFeatures(List<String> featureIds, List<Row> rows) Get online features from Feast.
List<Row>	getOnlineFeatures(List<String> featureIds, List<Row> rows, boolean omitEntitiesInResponse) Get online features from Feast.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static FeastClient create(String host,
                                 int port)

Create a client to access Feast

Parameters:

host - hostname or ip address of Feast serving GRPC server

port - port number of Feast serving GRPC server

Returns:

FeastClient

getFeastServingInfo

public ServingAPIProto.GetFeastServingInfoResponse getFeastServingInfo()

getOnlineFeatures

public List<Row> getOnlineFeatures(List<String> featureIds,
                                   List<Row> rows)

Get online features from Feast.

See getOnlineFeatures(List, List, boolean)

Parameters:

featureIds - list of feature id to retrieve, feature id follows this format [feature_set_name]:[version]:[feature_name]

rows - list of Row to select the entities to retrieve the features for

Returns:

list of Row containing features

getOnlineFeatures

public List<Row> getOnlineFeatures(List<String> featureIds,
                                   List<Row> rows,
                                   boolean omitEntitiesInResponse)

Get online features from Feast.

Example of retrieving online features for driver feature set, version 1, with features driver_id and driver_name

 FeastClient client = FeastClient.create("localhost", 6566);
 List<String> requestedFeatureIds = Arrays.asList("driver:1:driver_id", "driver:1:driver_name");
 List<Row> requestedRows =
         Arrays.asList(Row.create().set("driver_id", 123), Row.create().set("driver_id", 456));
 List<Row> retrievedFeatures = client.getOnlineFeatures(requestedFeatureIds, requestedRows);
 retrievedFeatures.forEach(System.out::println);
 

Parameters:

featureIds - list of feature id to retrieve, feature id follows this format [feature_set_name]:[version]:[feature_name]

rows - list of Row to select the entities to retrieve the features for

omitEntitiesInResponse - if true, the returned Row will not contain field and value for the entity

Returns:

list of Row containing features

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception