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

API standards and multilingual preset SDKs

The OpenAPI of this product (PaiRecService/2022-12-13) uses the ROA signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

Custom signature scenarios

If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

Account and security preparation

Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

Instance management

API	Title	Description
ListInstances	Retrieve Instance List	Gets a list of PAIRec instances.
GetInstance	Get instance details	Retrieves the details of a specified PAIRec instance.

Recall management

API	Title	Description
Recall management configuration	Recall management 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	Retrieve recall management configuration	Retrieves the recall management configuration.
Recall management table	Recall management table
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.
UpdateRecallManagementTable	UpdateRecallManagementTable	Updates the configuration of a recall management table specified by its ID.
GetRecallManagementTable	Get Recall Management Data Table Detail	Retrieves the details of a specified recall management table, including its table structure and configuration.
DeleteRecallManagementTable	DeleteRecallManagementTable	This API deletes a recall management table using the specified recall management table ID and instance ID.
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.
ListRecallManagementTableVersions	ListRecallManagementTableVersions	Lists all versions of a specified RecallManagementTable.
QueryRecallManagementTableRecords	QueryRecallManagementTableRecords	Retrieves records from a specified recall management table.
ExportRecallManagementTable	ExportRecallManagementTable	Exports a specified table from the recall engine to a MaxCompute project.
Recall management task	Recall management task
GetRecallManagementJob	GetRecallManagementJob	Retrieves the details of a specific recall management job, including its status and log.
ListRecallManagementJobs	Retrieve the recall management job list	Retrieves a list of recall management tasks that match specified conditions.
Recall management service	Recall management service
Recall service	Recall service
CreateRecallManagementService	Create Retrieval Management Service	Creates a new recall management service.
ListRecallManagementServices	List recall management services	Queries the list of recall management services under a specified instance.
UpdateRecallManagementService	UpdateRecallManagementService	Updates the instance ID and description of a specified recall management service.
GetRecallManagementService	GetRecallManagementService	Retrieves the details of a specified recall management service, including its status and version.
DeleteRecallManagementService	DeleteRecallManagementService	Deletes a recall management service.
OnlineRecallManagementService	OnlineRecallManagementService	This operation brings a specified Recall Management Service online.
OfflineRecallManagementService	Unpublish Retrieval Management Service	Takes a specified recall management service offline.
ChangeRecallManagementServiceVersion	ChangeRecallManagementServiceVersion	This API changes the version of a recall management service.
Recall service version	Recall service version
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.
DeleteRecallManagementServiceVersion	DeleteRecallManagementServiceVersion	Deletes a specified version of a 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.
UpdateRecallManagementServiceVersionConfig	UpdateRecallManagementServiceVersionConfig	Updates the configuration of a specific Recall Management Service version.
GetRecallManagementServiceVersionConfig	Get Retrieval Management Service Version Configuration	This API retrieves the configuration details of a specific recall management service version.
DeleteRecallManagementServiceVersionConfig	DeleteRecallManagementServiceVersionConfig	Deletes the specified recall management service version configuration.

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 list of data tables under a data source.
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.
Algorithm customization	Algorithm customization
GenerateAlgorithmCustomizationScript	Deploy algorithm customization	Generates an algorithm customization script.

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.

Experiment management

API	Title	Description
CreateExperiment	Create Experiment	Creates an experiment in a specified experiment group.
DeleteExperiment	Delete Experiment	Delete the specified experiment.
UpdateExperiment	Update Experiment	Updates the properties of a specified experiment, such as its name.
GetExperiment	Get Experiment Details	Retrieves the details of a specified experiment.
ListExperiments	Retrieve experiment list	Lists the experiments in the specified experiment group.
CloneExperiment	Clone Experiment	Clones a specified experiment.
OfflineExperiment	Unpublish Experiment	Takes an experiment offline.
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.
OnlineExperiment	Publish Experiment	Brings a specified experiment online.

Parameter management

API	Title	Description
CreateParam	Create aBTest parameter	Creates an ABTest parameter for a specific scene in a specified environment.
DeleteParam	Delete Parameter	Delete the specified parameter.
UpdateParam	Update Parameter	Updates information for a specified parameter, such as its value.
ListParams	Retrieve the parameter list	Lists parameters.

Crowd management

API	Title	Description
CreateCrowd	Create Audience	Creates a crowd that represents a group of users.
CreateSubCrowd	Create Sub-audience	Creates a sub-crowd for a specified crowd.
DeleteCrowd	Delete Audience	Delete the specified audience.
DeleteSubCrowd	Delete Sub-Audience	Deletes the specified subcrowd.
UpdateCrowd	Update Audience	Updates a crowd's information, such as its name and description.
ListCrowds	Obtain Audience List	Lists the Crowds in a specified instance.
ListCrowdUsers	Retrieve User List Under an Audience	Retrieves all users within a specified crowd, including those in its sub-crowds.
ListSubCrowds	Obtain the sub-audience list	Lists the subcrowds for a specified crowd.
GetSubCrowd	Obtain Sub-Audience Details	Retrieves the details of a sub-crowd.

Data table management

API	Title	Description
UpdateTableMeta	Update Data Table	Updates a data table.
ListTableMetas	Obtain Data Table List	Retrieves a list of data tables.
GetTableMeta	Retrieve Data Table	Returns the details of a table.
DeleteTableMeta	Delete a Data Table	Deletes a data table.
CreateTableMeta	Create Data Table	Creates a data table.

ABTest metric management

API	Title	Description
UpdateABMetric	Update aBTest metric	Modifies the metric configuration of an existing ABTest experiment.
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.

ABTest metric group management

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 task management

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 task configuration	Updates the configuration details of a feature consistency check task, such as the name.
ListFeatureConsistencyCheckJobConfigs	Retrieve feature consistency check task configurations	Retrieves the 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 management

API	Title	Description
DeleteEngineConfig	Delete an engine configuration	Deletes a specified engine configuration.
UpdateEngineConfig	Update engine configuration	Updates a specific engine configuration.
ListEngineConfigs	Retrieve engine configuration list	Retrieves a list of engine configurations.
GetEngineConfig	Get engine configuration details	Retrieves the details of an engine configuration.
CreateEngineConfig	Create an engine configuration	Creates an engine configuration.
CloneEngineConfig	Clone DPI engine configuration	Clones a DPI 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 control

API	Title	Description
Traffic control task	Traffic control task
CreateTrafficControlTask	Create Traffic Control Job	Creates a new traffic control task with multiple conditions and target configurations.
ListTrafficControlTasks	Retrieve the traffic control job list	Lists traffic control tasks that meet specified conditions.
UpdateTrafficControlTask	Update Traffic Control Job	Updates the configuration and target of a specified traffic control task.
GetTrafficControlTask	Get traffic control task details	Queries the details of a traffic control task with a specified ID.
DeleteTrafficControlTask	Delete traffic control job	Deletes a specified traffic control task.
CloneTrafficControlTask	Clone Traffic Control Job	Clones a specified traffic control task to a new instance.
CheckTrafficControlTaskExpression	Validate Traffic Regulation Job Expression	Validates a traffic control task expression.
ReleaseTrafficControlTask	Publish traffic control job	Releases a traffic control task for the specified instance and environment.
StartTrafficControlTask	Enable traffic control job	Starts a traffic control task with a specified ID for instances in different environments.
StopTrafficControlTask	Stop a traffic control job	Stops a traffic control task for a specific instance and environment.
GenerateTrafficControlTaskCode	Generate Traffic Control Job Code	Generates Flink code for a specified traffic control task ID and instance information.
GetTrafficControlTaskTraffic	Retrieve Reported Traffic for a Traffic Control Job	Retrieves traffic allocation details for a specific traffic control task.
UpdateTrafficControlTaskTraffic	Update Traffic for a Traffic Control Job	Updates the traffic parameters for a specified traffic control task, including target traffic and actual traffic.
DeployTrafficControlTaskCode	Deploy traffic control job code	Deploys Flink code for a traffic control task in a specified environment.
QueryTrafficControlTaskDeployResult	Query traffic control task deployment result	Retrieves the deployment status and related information of a specified traffic control task in a specific environment.
QueryTrafficControlTaskItemReport	Query item-level report for traffic control job	Retrieves a detailed report on item control for a specified traffic control task.
StopTrafficControlFlinkTask	Stop a traffic control flink task	Stops a traffic control Flink task with the specified ID.
Traffic control target	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.
UpdateTrafficControlTarget	Update Traffic Control Target	Updates the configuration of a traffic control target, including its control period, conditions, and value.
GetTrafficControlTarget	Retrieve traffic regulation target details	Gets the details of a traffic throttling objective by its ID.
DeleteTrafficControlTarget	Delete traffic control target	Deletes the specified traffic control target.
StartTrafficControlTarget	Enable Traffic Control Job	Starts a traffic control task for a specific traffic control target.
StopTrafficControlTarget	Stop a traffic control target	Stops a specific traffic control target.
SplitTrafficControlTarget	Split the target values of traffic control	Splits the target values for a traffic control target into time intervals.
ListTrafficControlTargetTrafficHistory	Retrieve traffic control task history	Retrieves the historical traffic records for a specific traffic control target.
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.

AIChat

API	Title	Description
ShoppingAssistant	AI shopping assistant chat	Conducts a conversation with a user through an AI shopping assistant to provide product recommendation services.

Others

API	Title	Description
ChatConversation	Send conversation message	Sends a conversation message to an agent. Supports Server-Sent Events (SSE). Creates a new session or continues a conversation in an existing session.