Skip to main content

FeatureService API (1.0)

License: Proprietary

Tecton provides a low latency feature server that exposes HTTP endpoints to retrieve feature values and metadata from the online store. This is typically used during model predictions. The feature servers retrieve data from the online store and perform any additional aggregations and filtering as necessary.

GetFeatures

FeatureService_GetFeatures

Get Features API to retrieve feature values from Tecton's online store

Authorizations:
Tecton_API_Key
Request Body schema: application/json
object (GetFeaturesParameters)

Parameters for get-features.

Exactly one of feature_service_name and feature_service_id must be set.

feature_service_id
string

FeatureService ID. Exactly one of this field and feature_service_name must be set.

feature_service_name
string

FeatureService name. Exactly one of this field and feature_service_id must be set.

workspace_name
string
object

Join keys used for table-based FeatureViews.

The key of this map is the join key name and the value is the join key value for this request. The values are encoded as follows:

  • For string keys, the value should be a string.
  • For int64 keys, the value should be a string of the decimal representation of the integer.
object

Request context used for OnDemand FeatureViews.

The key of this map is the request context key name and the value is the request context value for this request. The values are encoded as follows:

  • For string values, the value should be a string.
  • For int64 values, the value should be a string of the decimal representation of the integer.
  • For double values, the value should be a number.
object (MetadataOptions)

Options for retrieving additional metadata about the feature values.

allow_partial_results
boolean
Default: "false"

Whether incomplete results should be returned when the Online Feature Store size limit has been exceeded for this request. If this is not true, then the response will be an error in this case.

This is an advanced option and should only be set after consulting with the Tecton team.

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Metadata

FeatureService_ServiceMetadata

Get Metadata about the feature service from Tecton

Authorizations:
Tecton_API_Key
Request Body schema: application/json
object (FeatureServiceLocator)
feature_service_id
string

FeatureService ID. Exactly one of this field and feature_service_name must be set.

feature_service_name
string

FeatureService name. Exactly one of this field and feature_service_id must be set.

workspace_name
string

Workspace name.

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "featureServiceType": "DEFAULT",
  • "inputJoinKeys": [
    ],
  • "feature_values": [
    ]
}