Feature Serving Endpoint

class databricks.ml_features.entities.feature_serving_endpoint.FeatureServingEndpoint(name: str, creator: str, creation_time_millis: int, state: Dict[str, str])

Bases: _FeatureStoreObject

Note

Aliases: databricks.feature_engineering.entities.feature_serving_endpoint.FeatureServingEndpoint, databricks.feature_store.entities.feature_serving_endpoint.FeatureServingEndpoint

__init__(name: str, creator: str, creation_time_millis: int, state: Dict[str, str])
property state: Dict[str, str]

The state of the endpoint. Value could be READY, FAILED or IN_PROGRESS.

class databricks.ml_features.entities.feature_serving_endpoint.ServedEntity(*, feature_spec_name: str, name: str = '', workload_size: str = 'Small', scale_to_zero_enabled: bool = True, instance_profile_arn: str = None)

Bases: _FeatureStoreObject

Note

Aliases: databricks.feature_engineering.entities.feature_serving_endpoint.ServedEntity, databricks.feature_store.entities.feature_serving_endpoint.ServedEntity

__init__(*, feature_spec_name: str, name: str = '', workload_size: str = 'Small', scale_to_zero_enabled: bool = True, instance_profile_arn: str = None)

A ServedEntity represents a FeatureSpec to be served and related configurations. :param feature_spec_name: The name of a FeatureSpec in UC. :param workload_size: Allowed values are Small, Medium, Large. :param scale_to_zero_enabled: If enabled, the cluster size will scale to 0 when there is no traffic for certain amount of time. :param instance_profile_arn: The ARN of the IAM instance profile to use for the cluster.

class databricks.ml_features.entities.feature_serving_endpoint.Servable(features: List[Union[FeatureLookup, FeatureFunction]], workload_size: str = 'Small', scale_to_zero_enabled: bool = True, extra_pip_requirements: Optional[List[str]] = None)

Bases: _FeatureStoreObject

Note

Aliases: databricks.feature_engineering.entities.feature_serving_endpoint.Servable, databricks.feature_store.entities.feature_serving_endpoint.Servable

__init__(features: List[Union[FeatureLookup, FeatureFunction]], workload_size: str = 'Small', scale_to_zero_enabled: bool = True, extra_pip_requirements: Optional[List[str]] = None)

A Servable is a group of features to be served and related configurations. :param features: A list of FeatureLookups and FeatureFunctions. :param workload_size: Allowed values are Small, Medium, Large. :param scale_to_zero_enabled: If enabled, the cluster size will scale to 0 when there is no traffic for certain amount of time. :param extra_pip_requirements: The requirements needed by FeatureFunctions.

class databricks.ml_features.entities.feature_serving_endpoint.EndpointCoreConfig(servables: Servable = None, *, served_entities: ServedEntity = None, auto_capture_config: AutoCaptureConfig = None)

Bases: _FeatureStoreObject

Note

Aliases: databricks.feature_engineering.entities.feature_serving_endpoint.EndpointCoreConfig, databricks.feature_store.entities.feature_serving_endpoint.EndpointCoreConfig

__init__(servables: Servable = None, *, served_entities: ServedEntity = None, auto_capture_config: AutoCaptureConfig = None)
Parameters

  • servables – Deprecated. Please use served_entities instead.

  • served_entities – A ServedEntity specified in this config.

  • auto_capture_config – The config for auto-capturing.

class databricks.ml_features.entities.feature_serving_endpoint.AutoCaptureConfig(*, catalog_name: str, schema_name: str, table_name_prefix: str, enabled: bool = True)

Bases: _FeatureStoreObject

Note

Aliases: databricks.feature_engineering.entities.feature_serving_endpoint.AutoCaptureConfig, databricks.feature_store.entities.feature_serving_endpoint.AutoCaptureConfig

__init__(*, catalog_name: str, schema_name: str, table_name_prefix: str, enabled: bool = True)
Parameters

  • catalog_name – The catalog name of the auto-capturing tables

  • schema_name – The schema name of the auto-capturing tables

  • table_name_prefix – The prefix of the table names