Skip to content

api-spec.md

Latest commit

 

History

History
377 lines (288 loc) · 11.9 KB

api-spec.md

File metadata and controls

377 lines (288 loc) · 11.9 KB
Raw

Feathr Registry API Specifications

Data Models

EntityType

Type: Enum

Value
feathr_workspace_v1
feathr_source_v1
feathr_anchor_v1
feathr_anchor_feature_v1
feathr_derived_feature_v1

ValueType

Type: Enum

Value
UNSPECIFIED
BOOL
INT32
INT64
FLOAT
DOUBLE
STRING
BYTES

VectorType

Type: Enum

Value
TENSOR

TensorCategory

Type: Enum

Value
DENSE
SPARSE

FeatureType

Type: Object

Field Type
type VectorType
tensorCategory TensorCategory
dimensionType array<ValueType>
valType ValueType

TypedKey

Type: Object

Field Type
key_column string
key_column_type ValueType
full_name string, optional
description string, optional
key_column_alias string, optional

ExpressionTransformation

Type: Object

Field Type
transform_expr string

WindowAggregationTransformation

Type: Object

Field Type
def_expr string
agg_func string, optional
window string, optional
group_by string, optional
filter string, optional
limit number, optional

UdfTransformation

Type: Object

Field Type
name string

EntityReference

Type: Object

Field Type Comments
guid Guid
typeName EntityType
uniqueAttributes map<string, string> Contains qualifiedName only so far

ProjectAttributes

Type: Object

Field Type
qualifiedName string
name string
anchors array<EntityReference>
sources array<EntityReference>
anchor_features array<EntityReference>
derived_features array<EntityReference>
tags map<string, string>

SourceAttributes

Type: Object

Field Type
qualifiedName string
name string
path string
preprocessing string, optional
eventTimestampColumn string, optional
timestampFormat string, optional
type string
tags map<string, string>

AnchorAttributes

Type: Object

Field Type
qualifiedName string
name string
features array<EntityReference>
source EntityReference
tags map<string, string>

AnchorFeatureAttributes

Type: Object

Field Type
qualifiedName string
name string
type FeatureType
transformation ExpressionTransformation
or WindowAggregationTransformation
or UdfTransformation
key array<TypedKey>
tags map<string, string>

DerivedFeatureAttributes

Type: Object

Field Type
qualifiedName string
name string
type FeatureType
transformation ExpressionTransformation
or WindowAggregationTransformation
or UdfTransformation
key array<TypedKey>
input_anchor_features array<EntityReference>
input_derived_features array<EntityReference>
tags map<string, string>

EntityStatus

Type: Enum

Value
ACTIVE

Entity

Type: Object

Field Type
guid Guid
lastModifiedTS string
status EntityStatus
displayText string
typeName EntityType
attributes ProjectAttributes
or SourceAttributes
or AnchorAttributes
or AnchorFeatureAttributes
or DerivedFeatureAttributes

RelationshipType

Type: Enum

Value
BelongsTo
Contains
Produces
Consumes

Relationship

Type: Object

Field Type
relationshipId Guid
relationshipType RelationshipType
fromEntityId Guid
toEntityId Guid

ProjectDefinition

Type: Object

Field Type
qualifiedName string
tags map<string, string>

SourceDefinition

Type: Object

Field Type
qualifiedName string
name string
path string
preprocessing string, optional
eventTimestampColumn string, optional
timestampFormat string, optional
type string
tags map<string, string>

AnchorDefinition

Type: Object

Field Type
qualifiedName string
name string
source_id Guid
tags map<string, string>

AnchorFeatureDefinition

Type: Object

Field Type
qualifiedName string
name string
featureType FeatureType
transformation ExpressionTransformation
or WindowAggregationTransformation
or UdfTransformation
key array<TypedKey>
tags map<string, string>

DerivedFeatureDefinition

Type: Object

Field Type
qualifiedName string
name string
featureType FeatureType
transformation ExpressionTransformation
or WindowAggregationTransformation
or UdfTransformation
key array<TypedKey>
input_anchor_features array<Guid>
input_derived_features array<Guid>
tags map<string, string>

EntitiesAndRelationships

Type: Object

Field Type
guidEntityMap map<Guid, Entity>
relations array<Relationship>

Feathr Registry API

GET /projects

List names of all projects.

Response Type: array<string>

GET /projects-ids

Dictionary of id to names mapping of all projects.

Response Type: dict

GET /projects/{project}

Get everything defined in the project

GET /dependent/{entity}

Gets downstream/dependent entities for given entity

Response Type: EntitiesAndRelationships

GET /projects/{project}/datasources

Get all sources defined in the project.

Response Type: array<Entity>

GET /projects/{project}/features

Get all anchor features and derived features in the project, or only features meet the search criteria in the project.

Query Parameters:

Field Type
keyword string
size number
offset number

Response Type: Object

Field Type
features array<Entity>

GET /features/:feature

Get feature details.

Response Type: Object

Field Type Comments
entity Entity
referredEntities map<string, object> For compatibility, not used

DELETE /entity/{entity}

Deletes entity

POST /projects

Create new project

Field Type
guid Guid

POST /projects/{project}/datasources

Create new source in the project

Field Type
guid Guid

POST /projects/{project}/anchors

Create new anchor in the project

Field Type
guid Guid

POST /projects/{project}/anchors/{anchor}/features

Create new anchor feature in the project under specified anchor

Field Type
guid Guid

POST /projects/{project}/derivedfeatures

Create new derived feature in the project

Field Type
guid Guid