feast: github.com/feast-dev/feast/sdk/go Index | Files | Directories

package feast

import "github.com/feast-dev/feast/sdk/go"

Index

Package Files

auth.go client.go request.go response.go types.go

Variables

var (
    // ErrLengthMismatch indicates that the number of values returned is not the same as the number of values requested
    ErrLengthMismatch = "Length mismatch; number of na values (%d) not equal to number of features requested (%d)."

    // ErrFeatureNotFound indicates that the a requested feature was not found in the response
    ErrFeatureNotFound = "Feature %s not found in response."

    // ErrTypeMismatch indicates that the there was a type mismatch in the returned values
    ErrTypeMismatch = "Requested output of type %s does not match type of feature value returned."
)
var (
    // ErrInvalidFeatureRef indicates that the user has provided a feature reference
    // with the wrong structure or contents
    ErrInvalidFeatureRef = "Invalid Feature Reference %s provided, " +
        "feature reference must be in the format [featureset:]name"
)

func BoolVal Uses

func BoolVal(val bool) *types.Value

BoolVal is a bool type feast value

func BytesVal Uses

func BytesVal(val []byte) *types.Value

BytesVal is a bytes type feast value

func DoubleVal Uses

func DoubleVal(val float64) *types.Value

DoubleVal is a float64 type feast value

func FloatVal Uses

func FloatVal(val float32) *types.Value

FloatVal is a float32 type feast value

func Int32Val Uses

func Int32Val(val int32) *types.Value

Int32Val is a int32 type feast value

func Int64Val Uses

func Int64Val(val int64) *types.Value

Int64Val is a int64 type feast value

func StrVal Uses

func StrVal(val string) *types.Value

StrVal is a string type feast value

type Client Uses

type Client interface {
    GetOnlineFeatures(ctx context.Context, req *OnlineFeaturesRequest) (*OnlineFeaturesResponse, error)
    GetFeastServingInfo(ctx context.Context, in *serving.GetFeastServingInfoRequest) (*serving.GetFeastServingInfoResponse, error)
    Close() error
}

Client is a feast serving client.

type Credential Uses

type Credential struct {
    // contains filtered or unexported fields
}

Credential provides OIDC ID tokens used when authenticating with Feast. Implements credentials.PerRPCCredentials

func NewGoogleCredential Uses

func NewGoogleCredential(audience string) (*Credential, error)

Creates a new Google Credential which obtains credentials from Application Default Credentials

func NewOAuthCredential Uses

func NewOAuthCredential(audience string, clientId string, clientSecret string, endpointURL *url.URL) *Credential

Creates a new OAuth credential witch obtains credentials by making a client credentials request to an OAuth endpoint. clientId, clientSecret - Client credentials used to authenticate the client when obtaining credentials. endpointURL - target URL of the OAuth endpoint to make the OAuth request to.

func NewStaticCredential Uses

func NewStaticCredential(token string) *Credential

Create a Static Authentication Provider that provides a static token

func (*Credential) GetRequestMetadata Uses

func (provider *Credential) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error)

GetRequestMetadata attaches OIDC token as metadata, refreshing tokens if required. This should be called by the GRPC to authenticate each request.

func (*Credential) RequireTransportSecurity Uses

func (provider *Credential) RequireTransportSecurity() bool

Disable requirement of transport security to allow user to configure it explictly instead.

type GrpcClient Uses

type GrpcClient struct {
    // contains filtered or unexported fields
}

GrpcClient is a grpc client for feast serving.

func NewGrpcClient Uses

func NewGrpcClient(host string, port int) (*GrpcClient, error)

NewGrpcClient constructs a client that can interact via grpc with the feast serving instance at the given host:port.

func NewSecureGrpcClient Uses

func NewSecureGrpcClient(host string, port int, security SecurityConfig) (*GrpcClient, error)

NewAuthGrpcClient constructs a secure client that uses security features (ie authentication). host - hostname of the serving host/instance to connect to. port - post of the host to service host/instancf to connect to. securityConfig - security config configures client security.

func (*GrpcClient) Close Uses

func (fc *GrpcClient) Close() error

Close the grpc connection.

func (*GrpcClient) GetFeastServingInfo Uses

func (fc *GrpcClient) GetFeastServingInfo(ctx context.Context, in *serving.GetFeastServingInfoRequest) (
    *serving.GetFeastServingInfoResponse, error)

GetFeastServingInfo gets information about the feast serving instance this client is connected to.

func (*GrpcClient) GetOnlineFeatures Uses

func (fc *GrpcClient) GetOnlineFeatures(ctx context.Context, req *OnlineFeaturesRequest) (
    *OnlineFeaturesResponse, error)

GetOnlineFeatures gets the latest values of the request features from the Feast serving instance provided.

type OnlineFeaturesRequest Uses

type OnlineFeaturesRequest struct {
    // Features is the list of features to obtain from Feast. Each feature can be given as
    // the format feature_set:feature, where "feature_set" & "feature" are feature set name
    // and feature name respectively. The only required components is feature name.
    Features []string

    // Entities is the list of entity rows to retrieve features on. Each row is a map of entity name to entity value.
    Entities []Row

    // Project optionally specifies the project override. If specified, uses given project for retrieval.
    // Overrides the projects specified in Feature References if also specified.
    Project string

    // whether to omit the entities fields in the response.
    OmitEntities bool
}

OnlineFeaturesRequest wrapper on feast.serving.GetOnlineFeaturesRequest.

type OnlineFeaturesResponse Uses

type OnlineFeaturesResponse struct {
    RawResponse *serving.GetOnlineFeaturesResponse
}

OnlineFeaturesResponse is a wrapper around serving.GetOnlineFeaturesResponse.

func (OnlineFeaturesResponse) Float64Arrays Uses

func (r OnlineFeaturesResponse) Float64Arrays(order []string, fillNa []float64) ([][]float64, error)

Float64Arrays retrieves the result of the request as a list of float64 slices. Any missing values will be filled with the missing values provided.

func (OnlineFeaturesResponse) Int64Arrays Uses

func (r OnlineFeaturesResponse) Int64Arrays(order []string, fillNa []int64) ([][]int64, error)

Int64Arrays retrieves the result of the request as a list of int64 slices. Any missing values will be filled with the missing values provided.

func (OnlineFeaturesResponse) Rows Uses

func (r OnlineFeaturesResponse) Rows() []Row

Rows retrieves the result of the request as a list of Rows.

func (OnlineFeaturesResponse) Statuses Uses

func (r OnlineFeaturesResponse) Statuses() []map[string]serving.GetOnlineFeaturesResponse_FieldStatus

Statuses retrieves field level status metadata for each row in Rows(). Each status map returned maps status 1:1 to each returned row from Rows()

type Row Uses

type Row map[string]*types.Value

Row is a map of fields

type SecurityConfig Uses

type SecurityConfig struct {
    // Whether to enable TLS SSL trasnport security if true.
    EnableTLS bool
    // Optional: Provides path to TLS certificate used the verify Service identity.
    TLSCertPath string
    // Optional: Credential used for authentication.
    // Disables authentication if unspecified.
    Credential *Credential
}

SecurityConfig wraps security config for GrpcClient

Directories

PathSynopsis
mocksPackage mock_serving is a generated GoMock package.
protos/feast/core
protos/feast/serving
protos/feast/storage
protos/feast/types
protos/tensorflow_metadata/proto/v0

Package feast imports 19 packages (graph). Updated 2020-10-01. Refresh now. Tools for package owners.