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

API standard and pre-built SDKs in multi-language

The OpenAPI specification of this product (PaiRecService/2022-12-13) 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
ListInstances	Retrieve Instance List	Gets a list of PAIRec instances.
GetInstance	Obtain Instance Details	Gets the details of a specified PAI-REC instance.

Recall management

API	Title	Description
Recall configuration	Recall configuration
CreateRecallManagementConfig	Create Retrieval Management Configuration	Initializes a Recall Management configuration, including the instance ID, user information, and network configurations.
UpdateRecallManagementConfig	Update Retrieval Management Configuration	Updates the recall management configuration, including the instance ID, password, and network configuration.
GetRecallManagementConfig	Obtain the retrieval management configuration	Retrieves the recall management configuration.
Recall management	Recall management
CreateRecallManagementTable	Create Retrieval Management Table	Creates a recall management table that supports multiple data sources and configuration options.
ListRecallManagementTables	Retrieve the List of Recall Management Tables	Retrieves the recall management tables for a specified instance. Pagination and sorting are supported.
GetRecallManagementTable	Get Recall Management Data Table Detail	Retrieves the details of a specified recall management table, including its table structure and configuration.
PublishRecallManagementTable	Synchronize Recall Management Table	Synchronizes a MaxCompute table with the recall engine. This operation allows you to publish specific partitions and select a synchronization mode.
QueryRecallManagementTableRecords	QueryRecallManagementTableRecords	Retrieves records from a specified recall management table.
Recall management	Recall management
ListRecallManagementJobs	Retrieve the recall management job list	Retrieves a list of recall management tasks that match specified conditions.
Recall management service	Recall management service
Retrieval service	Retrieval service
CreateRecallManagementService	Create Retrieval Management Service	Creates a new recall management service.
ListRecallManagementServices	Retrieve the recall management service list	This API returns a list of recall management services for a specified instance.
DeleteRecallManagementService	DeleteRecallManagementService	Deletes a recall management service.
OfflineRecallManagementService	Unpublish Retrieval Management Service	Takes a specified recall management service offline.
ChangeRecallManagementServiceVersion	ChangeRecallManagementServiceVersion	This API changes the version of a recall management service.
Service rollback	Service rollback
CreateRecallManagementServiceVersion	Create Recall Management Service Version	Creates a new recall management service version that supports configuring multiple recall strategies.
ListRecallManagementServiceVersions	List of Retrieval Management Service Versions	Retrieves a list of all versions for a specified Recall Management Service.
GetRecallManagementServiceVersion	Obtain details of a retrieval management service version	Retrieves the version details of the recall management service.
Recall service version configuration	Recall service version configuration
CreateRecallManagementServiceVersionConfig	Create Retrieval Management Service Version Configuration	Creates a configuration for a specified version of the Recall Manager service, including its recall and merge settings.
GetRecallManagementServiceVersionConfig	Get Retrieval Management Service Version Configuration	This API retrieves the configuration details of a specific recall management service version.

Data resource management

API	Title	Description
ListInstanceResourceSchemas	Retrieve Schemas Under an Instance Resource	Lists all schemas for a specified resource in an instance.
ListInstanceResourceTables	Retrieve the List of Data Tables Under an Instance Resource	Retrieves a list of data tables for a specified instance and data source.
CheckInstanceResources	Check Resource Status	Verifies access to resources configured for an instance.
UpdateInstanceResource	Update Resource Information	Updates a specified resource for a specified instance.
GetInstanceResourceTable	Retrieve table information under a resource	Retrieves the schema of a specified data table within a resource.
ListInstanceResources	List resources	Lists the resources configured for an instance.
GetInstanceResource	Obtain Resource Details	Retrieves the details of a specific resource in a specified instance.
DeleteInstanceResource	Delete resource configuration	Deletes a configuration resource from an instance.
CreateInstanceResource	Create Configuration Resource	Creates a configuration resource for a specified instance.

Scenario management

API	Title	Description
CreateScene	Create Scene	Creates a scene for metric and experiment analysis.
DeleteScene	Delete Scenario	Delete the specified scenario.
UpdateScene	Update Scenario	Updates information for a scene, such as its name and description.
ListScenes	Obtain the scenario list	Retrieves a list of scenes.
GetScene	Obtain Scenario Details	Retrieves the details of a specified scene.

Algorithm customization

API	Title	Description
Data diagnostics	Data diagnostics
CreateDataDiagnosis	Create Data Diagnosis Job	Creates a data diagnosis task. This API supports various analysis types.
ListDataDiagnoses	Obtain the data diagnosis list	Lists the data diagnostic tasks for the specified instance.
UpdateDataDiagnosis	Update Data Diagnosis Information	Updates the configuration of a specified data diagnosis task.
GetDataDiagnosis	Obtain data diagnosis details	Retrieves details of a data diagnosis task using its data diagnosis task ID and instance ID.
DeleteDataDiagnosis	Delete data diagnosis	Deletes a data diagnosis configuration using the specified DataDiagnosisId and InstanceId.
CreateDataDiagnosisJobs	Create a Data Diagnosis Job	Creates a data diagnosis (rerun) job for a specified time period.
ListDataDiagnosisJobs	Retrieve the list of data diagnosis jobs	Queries data diagnosis jobs for a specified instance.
ListDataDiagnosisReports	Retrieve data diagnostic report	Specify parameters to retrieve data diagnosis reports for a specific time range.
QueryDataDiagnosisStatistics	Data Diagnosis Statistics Query	Retrieves statistics for a specified data diagnosis task within a time range.

Lab management

API	Title	Description
CreateLaboratory	Create Lab	Creates a laboratory. A laboratory isolates a segment of traffic for running experiments.
DeleteLaboratory	Delete Lab	Delete the specified Lab.
UpdateLaboratory	Update Laboratory	Updates a laboratory's information, such as its name.
ListLaboratories	Obtain the Lab List	Retrieves the laboratories in a specified scene.
GetLaboratory	Obtain Lab Details	Retrieves the details of a specified laboratory.
OnlineLaboratory	Publish Lab	Publishes a specified laboratory for experimental analysis.
OfflineLaboratory	Unpublish Lab	Takes the specified laboratory offline.
CloneLaboratory	Clone Lab	Clones a specified laboratory to a designated environment. You can specify whether to clone the experiment groups within the laboratory.

Layer management

API	Title	Description
CreateLayer	Create Layer	Creates a layer in a specified laboratory for layered experiments. Layers are orthogonal to each other, allowing experiments to run independently and preventing traffic starvation.
DeleteLayer	Delete Layer	Delete the specified layer.
UpdateLayer	Update Layer	Updates the name and description of a specified layer.
ListLayers	Retrieve the layer list	Retrieves a list of layers in a specified laboratory.
GetLayer	Obtain Layer Details	Retrieves the details of a specified layer.

Experiment group management

API	Title	Description
CreateExperimentGroup	Create Experiment Group	Creates an experiment group in a specified layer. You can use experiment groups to categorize experiments and observe their overall performance.
DeleteExperimentGroup	Delete experiment group	Delete the specified experiment group.
UpdateExperimentGroup	Update Experiment Group	Updates information for a specified experiment group, such as its name and description.
ListExperimentGroups	Retrieve experiment group list	Returns a list of experiment groups.
GetExperimentGroup	Obtain experiment group details	Retrieves details for a specified experiment group.
CloneExperimentGroup	Clone Experiment Group	Clones an experiment group to a specified environment.
OnlineExperimentGroup	Publish Experiment Group	Brings a specified experiment group online.
OfflineExperimentGroup	Unpublish experiment group	Takes a specified experiment group offline.

A/B metric management

API	Title	Description
UpdateABMetric	Update AB Metrics	Update A/B testing metrics.
CreateABMetric	Create AB Metric	Creates an AB metric.
ListABMetrics	Obtain the AB Metrics List	Lists A/B testing metrics.
GetABMetric	Obtain AB Metric Details	Gets the details of an A/B metric.
DeleteABMetric	Delete AB Metric	Deletes the specified A/B test metric.

AB metric groups

API	Title	Description
ReportABMetricGroup	Query metric group report	Retrieve a metric group's report.
UpdateABMetricGroup	Update Metric Group	Updates an A/B test metric group.
CreateABMetricGroup	Create Metric Group	Creates an A/B metric group.
ListABMetricGroups	Retrieve the Metric Group List	Retrieves a list of A/B metric groups.
GetABMetricGroup	Retrieve Metric Group Details	Retrieves the details of an A/B testing metric group.
DeleteABMetricGroup	Delete a metric group	Deletes an A/B test metric group.

Compute task management

API	Title	Description
ListCalculationJobs	Obtain the Script Task List	Lists calculation jobs.
GetCalculationJob	Obtain Script Task	Gets the details of a specified calculation job.
CreateCalculationJobs	Create Script Task	Creates multiple calculation jobs.

Feature consistency check tasks

API	Title	Description
CreateFeatureConsistencyCheckJobConfig	Create a feature consistency check job configuration	Configure a feature consistency check task.
CreateFeatureConsistencyCheckJob	Create a feature consistency check job	Creates a feature consistency check job.
UpdateFeatureConsistencyCheckJobConfig	Update Feature Consistency Check Job Configuration	Update the configuration for a feature consistency check task, such as its name.
ListFeatureConsistencyCheckJobConfigs	Retrieve the list of feature consistency check job configurations	Retrieves a list of feature consistency check task configurations.
GetFeatureConsistencyCheckJobConfig	Obtain the configuration details of a feature consistency check job.	Retrieves the configuration details of a feature consistency check task.
ListFeatureConsistencyCheckJobs	Retrieve the feature consistency check job list	Retrieves a list of feature consistency check jobs.
GetFeatureConsistencyCheckJob	Retrieve the details of a feature consistency check job	Gets the details of a feature consistency check job.
ListFeatureConsistencyCheckJobFeatureReports	Obtain the feature report of a feature consistency check job.	Lists feature reports for a feature consistency check job.
ListFeatureConsistencyCheckJobScoreReports	Obtain the feature consistency check job score report	Retrieves the score difference reports for a feature consistency check job.
CloneFeatureConsistencyCheckJobConfig	Clone the feature consistency check job configuration	Clones a feature consistency check job configuration.
TerminateFeatureConsistencyCheckJob	Cancel the running job for the specified feature consistency check	Terminates a feature consistency check job.
BackflowFeatureConsistencyCheckJobData	Feature Consistency Check Data Backflow	Performs data backflow for the latest job of a specified feature consistency check job configuration.
SyncFeatureConsistencyCheckJobReplayLog	Replay logs for the synchronous feature consistency check job.	Syncs the replay log for a feature consistency check job.

Engine configuration

API	Title	Description
DeleteEngineConfig	Delete Engine Configuration	Deletes the specified engine config.
UpdateEngineConfig	Update DPI engine configuration	Updates an engine configuration.
ListEngineConfigs	List Engine Configurations	Retrieves a list of engine configurations.
GetEngineConfig	Retrieve the details of an engine configuration	Gets the details of an engine configuration.
CreateEngineConfig	Create Engine Configuration	Creates an engine config.
CloneEngineConfig	Clone DPI Engine Configuration	Clones an engine configuration.
ApplyEngineConfig	Publish DPI engine configuration	Applies an engine configuration.

Service management

API	Title	Description
GetService	Get service details	Retrieves the details of a service.

Traffic management

API	Title	Description
Traffic control	Traffic control
CheckTrafficControlTaskExpression	Validate Traffic Regulation Job Expression	Validates a traffic control task expression.
GetTrafficControlTaskTraffic	Retrieve Reported Traffic for a Traffic Control Job	Retrieves traffic allocation details for a specific traffic control task.
Throttling target	Throttling target
SplitTrafficControlTarget	Split the target values of traffic control	Splits the target values for a traffic control target into time intervals.

Other

API	Title	Description
UpdateTrafficControlTarget	Update Traffic Control Target	Updates the configuration of a traffic control target, including its control period, conditions, and value.
StartTrafficControlTarget	Enable Traffic Control Job	Starts a traffic control task for a specific traffic control target.
GenerateTrafficControlTaskCode	Generate Traffic Control Job Code	Generates Flink code for a specified traffic control task ID and instance information.
StopTrafficControlTarget	Stop a traffic control target	Stops a specific traffic control target.
ListTrafficControlTargetTrafficHistory	Retrieve traffic control task history	Retrieves the historical traffic records for a specific traffic control target.
CreateTrafficControlTarget	Create Traffic Control Target	Creates a new traffic control target and sets its parameters, such as the item condition, event, and value.
DeleteTrafficControlTarget	Delete traffic control target	Deletes the specified traffic control target.
GetTrafficControlTarget	Retrieve traffic regulation target details	Gets the details of a traffic throttling objective by its ID.
UpdateTrafficControlTaskTraffic	Update Traffic for a Traffic Control Job	Updates the traffic parameters for a specified traffic control task, including target traffic and actual traffic.
GetTrafficControlTask	Retrieve traffic control Job details	Query the detailed information of a traffic control job with the specified ID.
StartTrafficControlTask	Enable traffic control job	Starts a traffic control task with a specified ID for instances in different environments.
UpdateTrafficControlTask	Update Traffic Control Job	Updates the configuration and target of a specified traffic control task.
CloneTrafficControlTask	Clone Traffic Control Job	Clones a specified traffic control task to a new instance.
ReleaseTrafficControlTask	Publish traffic control job	Releases a traffic control task for the specified instance and environment.
StopTrafficControlTask	Stop a traffic control job	Stops a traffic control task for a specific instance and environment.
ListTrafficControlTasks	Retrieve the traffic control job list	Lists traffic control tasks that meet specified conditions.
CreateTrafficControlTask	Create Traffic Control Job	Creates a new traffic control task with multiple conditions and target configurations.
DeleteTrafficControlTask	Delete traffic control job	Deletes a specified traffic control task.
QueryTrafficControlTargetItemReportDetail	Query details of a single item in the traffic control target report	Retrieves the traffic control details of a target item for a given environment and date range.
QueryTrafficControlTaskItemReport	Query item-level report for traffic control job	Retrieves a detailed report on item control for a specified traffic control task.
DeployTrafficControlTaskCode	Deploy traffic control job code	Deploys Flink code for a traffic control task in a specified environment.
QueryTrafficControlTaskDeployResult	Query the Deployment Result of a Traffic Control Job	Retrieves the deployment status and related information for a specified traffic control task in a specific environment.

Others

API	Title	Description
ChatConversation	ChatConversation	Sends a conversation message to an agent to start a new conversation or continue an existing one. This operation supports Server-Sent Events (SSE).
CloneExperiment	Clone Experiment	Clones a specified experiment.
CreateCrowd	Create Audience	Creates a crowd that represents a group of users.
CreateExperiment	Create Experiment	Creates an experiment in a specified experiment group.
CreateParam	Create Parameter	Create a parameter. By managing parameters, you can modify the variables that the service reads without modifying the DPI engine configuration or publishing changes, thereby improving flexibility.
CreateSubCrowd	Create Sub-audience	Creates a sub-crowd for a specified crowd.
CreateTableMeta	Create Data Table	Creates a data table.
DeleteCrowd	Delete Audience	Delete the specified audience.
DeleteExperiment	Delete Experiment	Delete the specified experiment.
DeleteParam	Delete Parameter	Delete the specified parameter.
DeleteRecallManagementServiceVersion	DeleteRecallManagementServiceVersion	Deletes a specified version of a recall management service.
DeleteRecallManagementServiceVersionConfig	DeleteRecallManagementServiceVersionConfig	Deletes the specified recall management service version configuration.
DeleteRecallManagementTable	DeleteRecallManagementTable	This API deletes a recall management table using the specified recall management table ID and instance ID.
DeleteSubCrowd	Delete Sub-Audience	Deletes the specified subcrowd.
DeleteTableMeta	Delete a Data Table	Deletes a data table.
ExportRecallManagementTable	ExportRecallManagementTable	Exports a specified table from the recall engine to a MaxCompute project.
GenerateAlgorithmCustomizationScript	Deploy algorithm customization	Generates an algorithm customization script.
GetExperiment	Get Experiment Details	Retrieves the details of a specified experiment.
GetRecallManagementJob	GetRecallManagementJob	Retrieves the details of a specific recall management job, including its status and log.
GetRecallManagementService	GetRecallManagementService	Retrieves the details of a specified recall management service, including its status and version.
GetSubCrowd	Obtain Sub-Audience Details	Retrieves the details of a sub-crowd.
GetTableMeta	Retrieve Data Table	Returns the details of a table.
ListCrowdUsers	Retrieve User List Under an Audience	Retrieves all users within a specified crowd, including those in its sub-crowds.
ListCrowds	Obtain Audience List	Lists the Crowds in a specified instance.
ListExperiments	Retrieve experiment list	Lists the experiments in the specified experiment group.
ListParams	Retrieve the parameter list	Lists parameters.
ListRecallManagementTableVersions	ListRecallManagementTableVersions	Lists all versions of a specified RecallManagementTable.
ListSubCrowds	Obtain the sub-audience list	Lists the subcrowds for a specified crowd.
ListTableMetas	Obtain Data Table List	Retrieves a list of data tables.
OfflineExperiment	Unpublish Experiment	Takes an experiment offline.
OnlineExperiment	Publish Experiment	Brings a specified experiment online.
OnlineRecallManagementService	OnlineRecallManagementService	This operation brings a specified Recall Management Service online.
PushAllExperiment	Roll Out Experiment to Full Traffic	If an experiment is stable and performs well, you can push all traffic to it. This action retires the original experiment group and creates a new one that contains only this experiment. The new group receives 100% of the traffic.
UpdateCrowd	Update Audience	Updates a crowd's information, such as its name and description.
UpdateExperiment	Update Experiment	Updates the properties of a specified experiment, such as its name.
UpdateParam	Update Parameter	Updates information for a specified parameter, such as its value.
UpdateRecallManagementService	UpdateRecallManagementService	Updates the instance ID and description of a specified recall management service.
UpdateRecallManagementServiceVersionConfig	UpdateRecallManagementServiceVersionConfig	Updates the configuration of a specific Recall Management Service version.
UpdateRecallManagementTable	UpdateRecallManagementTable	Updates the configuration of a recall management table specified by its ID.
UpdateTableMeta	Update Data Table	Updates a data table.