API overview-Platform For AI(PAI)-阿里云帮助中心

API standard and pre-built SDKs in multi-language

The OpenAPI specification of this product (PaiFeatureStore/2023-06-21) follows the ROA standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.

Custom signature

If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).

Before you begin

An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.

Instance management

API	Title	Description
CreateInstance	Create Instance	Creates a FeatureStore instance. This operation is idempotent. If an instance is already running or initializing in the same account, this operation returns the existing instance ID.
ListInstances	Retrieve the instance list	Lists FeatureStore instances in the current account. You can filter the instances by status.
GetInstance	Obtain instance details	Retrieves the details of a FeatureStore instance.
CheckInstanceDatasource	Check the connectivity of a data source	Tests connectivity to a data source.

Data source management

API	Title	Description
CreateDatasource	Create a data source	Registers a datasource in a FeatureStore instance. A datasource provides offline or online storage for a project.
ListDatasources	Retrieve the data source list	Lists the data sources in a FeatureStore instance. You can filter the results by workspace, type, and name.
GetDatasource	Retrieve data source details	Gets the detailed information about a data source, including its type, connection information, and configuration.
UpdateDatasource	Update Data Source	Updates information for a data source. Its type and workspace cannot be changed.
DeleteDatasource	Delete data source	Deletes a datasource from a FeatureStore instance.
ListDatasourceFeatureViews	Obtain information of all feature views under a data source	Retrieve all feature view information from the data source.
ListDatasourceTables	Retrieve the list of data tables under a data source	Lists the tables in a datasource. This operation supports only MaxCompute datasources.
GetDatasourceTable	Obtain the details of a specified table under a data source	Gets the field information for a specified table in a data source. This operation supports only MaxCompute data sources.

LLM configuration management

API	Title	Description
CreateLLMConfig	Create LLM Configuration Information	Creates an LLM configuration that contains the call parameters and API key for an embedding model. During creation, the service validates the ApiKey and Model. For a DashScope model, the EmbeddingDimension must match one of the fixed, valid dimensions supported by the model.
ListLLMConfigs	List Model Configuration Information	Lists LLM call configurations.
GetLLMConfig	Retrieve LLM Configuration Information	Retrieves the details of an LLM call configuration.
UpdateLLMConfig	Update LLM Configuration Information	Updates the large language model (LLM) call configuration. If you do not specify the `ApiKey` parameter, the existing key is retained. After the update, the system revalidates the model's availability and its parameters.
DeleteLLMConfig	Delete LLM Configuration Information	Deletes an LLM call configuration. You cannot delete a configuration referenced by a feature view. You must first delete the associated feature view.

Project Management

API	Title	Description
CreateProject	Create Project	Creates a FeatureStore project. A project is a container for feature entities, feature views, and model features.
UpdateProject	Update project information	Updates the description of a project.
ListProjects	List Projects	Lists projects in a FeatureStore instance, which can be filtered by name, workspace, and owner.
GetProject	Get Project Details	Retrieves the details of a project, including its data source bindings and resource counts.
DeleteProject	Delete Project	Deletes a FeatureStore project.
ListProjectFeatures	Retrieve all feature information under a project	Lists all features in a project. This operation supports filtering by name, alias, and feature view, as well as sorting and pagination. The response includes the data type, parent feature view, and the number of model features that reference each feature.
ListProjectFeatureViews	Obtain feature views and feature lists	Lists all feature views and their available features in a project. Use this operation to select feature views and features for the CreateModelFeature and UpdateModelFeature operations.
GetProjectFeatureEntity	Obtain the details of a specified feature entity under a project	Retrieve details of a feature entity in a project by name.

Feature entity

API	Title	Description
CreateFeatureEntity	Create a feature entity	Creates a feature entity. A feature entity defines a join key that links multiple feature views to it, enabling feature joining.
ListFeatureEntities	Retrieve the list of feature entities	Lists the feature entities in a FeatureStore instance. You can filter the results by project, name, owner, and parent feature entity.
GetFeatureEntity	Obtain detailed information about a feature entity	Retrieves the details of a feature entity.
DeleteFeatureEntity	Delete a feature entity	Deletes a feature entity.

Feature View

API	Title	Description
CreateFeatureView	Create a feature view	You can create three types of feature views: offline, real-time, and behavior sequence. Each feature view uses fields to define its structure and links to a feature entity.
ListFeatureViews	List feature views	Lists feature views.
GetFeatureView	Get feature view details	Gets the details of a feature view, including its field definitions, data source binding, and synchronization status.
DeleteFeatureView	Delete a feature view	Deletes a feature view.
PublishFeatureViewTable	Publish table data under a feature view	Publishes or syncs offline data from a feature view to an online store.
WriteFeatureViewTable	Write a table to the specified feature view.	Writes a table to the specified feature view.
ListFeatureViewOnlineFeatures	Retrieve online feature data under a feature view	Retrieve online feature data from a feature view.
ListFeatureViewRelationships	Retrieve feature view lineage	Retrieves the lineage relationships of a feature view.
ListFeatureViewFieldRelationships	Get Feature Field Lineage	Retrieve feature field lineage relationships.

Label table

API	Title	Description
CreateLabelTable	Create label table	Creates a label table. A label table defines the table structure for label data used by model features.
ListLabelTables	Retrieve the list of label tables	Retrieve a list of label tables.
GetLabelTable	Get label table details	Retrieve details of a label table.
UpdateLabelTable	Update label table	Updates label table information, such as the table name.
DeleteLabelTable	Delete the label table	Deletes a label table.

Model Features

API	Title	Description
CreateModelFeature	Create model feature	Creates a model feature.
ListModelFeatures	List model features	Retrieve model features.
GetModelFeature	Obtain model feature details	Retrieves detailed information about a model feature.
UpdateModelFeature	Update model feature	Updates information for a specified model feature, such as the ID of the associated label table.
DeleteModelFeature	Delete model feature	Deletes a model feature.
ExportModelFeatureTrainingSetTable	Export the train set table of a model feature	Export the training set for the specified model features.
ListModelFeatureAvailableFeatures	Obtain all available features under the model feature when registering FG features.	Lists the available features for a model feature when you register a feature group (FG).
UpdateModelFeatureFGFeature	Update the FG feature configuration information of a model feature	Update the FG feature configuration for a model feature.
GetModelFeatureFGFeature	Obtain the FG feature configuration information of a model feature.	Retrieves the Feature Generation (FG) feature configuration of a model feature.
GetModelFeatureFGInfo	Obtain the configuration information of the fg.json file for a model feature	Retrieves the fg.json file configuration for a model feature.
CheckModelFeatureFGFeature	Check whether the FG configuration of model features is correct	Verify that the FG configuration is correct and meets all rules.

Task Management

API	Title	Description
ListTasks	Retrieve Job List	Retrieves a list of tasks.
GetTask	Obtain job details	Retrieve details about a task.
StopTask	Stop a job	Stop a task.
ListTaskLogs	Retrieve task logs	Retrieves task logs.

Others

API	Title	Description
UpdateFeatureView	UpdateFeatureView	Updates a feature view.