modelarts-umn/api-ref/source/data_management/data_management_apis.rst

original_name

modelarts_03_0299.html

Data Management APIs

Table 1 Data management APIs

Type	API	Description
Dataset Management	Querying the Dataset List <listdatasets>	Query created datasets by page based on specified conditions.
	Creating a Dataset <createdataset>	Create a new dataset and determine whether to enable team labeling as needed. Enable team labeling. The subsequent operations vary depending on the specified role. If a team is specified to assign labeling tasks, the team labeling task is started after the dataset is created. If a task manager is specified to assign labeling tasks, the manager calls the API in Starting a Team Labeling Task <startworkforcetask> to assign and start the team labeling tasks. Disable team labeling. To enable team labeling later, call the API in Creating a Team Labeling Task <createworkforcetask> to create team labeling tasks for the dataset.
	Querying Details About a Dataset <descdataset>	Query details about a dataset, including the dataset name, type, and version name based on the dataset ID.
	Modifying a Dataset <updatedataset>	Modify basic information about a dataset, such as the dataset name, description, version, or labels. The modification takes effect in the entire dataset, including the samples in the dataset.
	Deleting a Dataset <deletedataset>	Delete a dataset based on the dataset ID to release resources.
	Querying Dataset Statistics <liststats>	Query dataset statistics, such as sample statistics, label statistics, or hard examples based on specified conditions.
	Querying the Monitoring Data of a Dataset <getdatasetmetrics>	Query the monitoring data of a dataset within a specified period, such as the number of labeled samples, number of unlabeled samples, and total number of samples at each time point within the period.
Data Synchronization	Synchronizing a Dataset <syncdatasource>	Synchronize data and labels from the dataset input path to the dataset.
	Querying the Status of a Dataset Synchronization Task <syncdatasourcestate>	Query the status of a data source synchronization task based on the dataset ID.
Labeling Data	Updating Sample Labels in Batches <updatesamples>	Label multiple samples in a dataset in batches. Label unlabeled samples. You can use an existing label or create a new label. Add, modify, or delete labels for labeled samples. You can use an existing label or newly added label to modify an original label. Additionally, you can add an existing label or a new label to a sample. This API uses a new label list to overwrite the original one to update the sample label. For example, if an empty label list is used to overwrite the original one, all sample labels will be deleted.
	Querying the Sample List <listsamples>	Query dataset samples by page based on specified conditions.
	Adding Samples in Batches <uploadsamplesjson>	Add samples to a dataset in batches for data labeling.
	Deleting Samples in Batches <deletesamples>	Delete unused samples from a dataset in batches.
	Querying Details About a Sample <describesample>	Query a single sample based on the sample ID, including the sample status and labels.
	Querying Sample Search Criteria <listsearch>	Obtain sample search criteria, such as the label list and attribute key-value pairs of the dataset based on the dataset ID.
Label Management	Querying the Dataset Label List <listlabels>	Query the labels in a specified dataset version.
	Creating a Dataset Label <createlabels>	During dataset labeling, new labels can be created. This function is available only in datasets of the text classification and named entity types.
	Modifying Labels in Batches <updatelabels>	Modify dataset labels in batches. The modification takes effect in the entire dataset, including the samples in the dataset.
	Deleting Labels in Batches <deletelabels>	Delete dataset labels in batches and ask you to determine whether to delete the samples with the labels.
	Updating a Label by Label Name <updatelabel>	Modify a label in a dataset based on the label name. The modification takes effect in the entire dataset, including the samples in the dataset.
	Deleting a Label and the Files with This Label Only <deletelabelandsamples>	Delete a label in a dataset based on the label name and ask you to determine whether to delete the samples with the label.
Importing Data	Querying the Dataset Import Task List <listimporttasks>	Query historical tasks imported to a dataset by page based on the dataset ID.
	Creating a Dataset Import Task <importtask>	Create a dataset import task to import labels and data (such as Manifest files and OBS data) from a storage system to the dataset.
	Querying Details About a Dataset Import Task <descimporttask>	Query details about a dataset import task based on the dataset ID and task ID to learn about the data source, import mode, and task status.
Exporting Data	Querying the Dataset Export Task List <getexporttasksstatusofdataset>	Query historical tasks exported from a dataset by page based on the dataset ID.
	Creating a Dataset Export Task <exporttask>	Export certain data as a new dataset or to OBS.
	Querying the Status of a Dataset Export Task <getexporttaskstatusofdataset>	Query details about a dataset export task based on the dataset ID and task ID to learn about the export type, task status, and number of samples.
Publishing a Dataset	Creating a Dataset Labeling Version <createdatasetversion>	Publish the labeled dataset as a new version for model building.
Managing Dataset Versions	Querying the Dataset Version List <listdatasetversions>	Query the versions of a dataset based on the dataset ID to learn about the dataset version evolution.
	Creating a Dataset Labeling Version <createdatasetversion>	Publish a modified dataset as a new version. The modification includes labeling samples, adding samples, and deleting samples in the dataset.
	Querying Details About a Dataset Labeling Version <describedatasetversion>	Query details about a specified dataset labeling version, including the name, description, number of files, and storage path based on the dataset ID and version ID.
	Deleting a Dataset Labeling Version <deletedatasetversion>	Delete a dataset version based on the dataset ID and version ID.
Auto Labeling	Querying the Auto Labeling Sample List <listautoannotationsamples>	Query the to-be-confirmed auto labeling samples in a dataset by page based on the dataset ID.
	Querying Details About an Auto Labeling Sample <describeautoannotationsample>	Query information of a single auto labeling sample based on the dataset ID and sample ID, such as the sample labels, hard example details, and sample type.
	Querying Auto Labeling Tasks by Page <listtasks>	Query all auto labeling tasks by page based on the dataset ID.
	Starting an Auto Labeling Task <createtask>	Start an auto labeling task for unlabeled data to quickly label the data. After the auto labeling task is complete, call the API in Updating Sample Labels in Batches <updatesamples> to check the labeling result.
	Querying Details About an Auto Labeling Task <autoannotationprogress>	Query details about an auto labeling task based on the dataset ID and task ID to learn about the task configuration, name, and status.
	Stopping an Auto Labeling Task <stopautoannotation>	Stop an ongoing auto labeling task based on the dataset ID and task ID.
Auto Grouping	Querying Auto Grouping Tasks by Page <listtasks>	Query all auto grouping tasks by page based on the dataset ID. In auto grouping, unlabeled images are clustered using a clustering algorithm and then processed based on the clustering result. Images can be labeled by group or cleaned.
	Starting an Auto Grouping Task <createtask>	Execute an auto grouping task based on selected data samples to improve data labeling efficiency.
	Querying Details About an Auto Grouping Task <autoannotationprogress>	Query details about an auto grouping task based on the dataset ID and task ID to learn about the task configuration, name, and status.
	Stopping an Auto Grouping Task <stopautoannotation>	Stop an ongoing auto grouping task based on the dataset ID and task ID.
Team Labeling	Querying Statistics for a Team Labeling Task <listworkforcetaskstats>	Query statistics for a team labeling task on the data labeling platform, such as the sample statistics, label statistics, and hard example set based on the dataset ID and team labeling task ID.
	Querying Statistics for the Member Labeling Progresses in a Team Labeling Task <getworkforcetaskmetrics>	Query statistics for the member labeling progresses in a team labeling task based on the dataset ID and team labeling task ID.
	Querying the Team Labeling Task List of a Dataset <listworkforcetasks>	Query the team labeling tasks of a dataset based on the dataset ID.
	Creating a Team Labeling Task <createworkforcetask>	Create a team labeling task based on an existing dataset so that multiple members can concurrently label the dataset. If a team is specified to assign labeling tasks, the team labeling task is started after the task is created. If a task manager is specified to assign labeling tasks, the manager calls the API in Starting a Team Labeling Task <startworkforcetask> to assign and start the team labeling tasks.
	Querying Details About a Team Labeling Task <descworkforcetask>	Query details about a team labeling task based on the dataset ID and team labeling task ID, including the task name, data, and team information.
	Starting a Team Labeling Task <startworkforcetask>	The team labeling task manager assigns and starts a team labeling task on the data labeling platform based on the dataset ID and team labeling task ID.
	Updating a Team Labeling Task <updateworkforcetask>	Update the description, name, and team information of a team labeling task based on the dataset ID and team labeling task ID.
	Deleting a Team Labeling Task <deleteworkforcetask>	Delete a team labeling task based on the dataset ID and team labeling task ID.
	Creating a Team Labeling Acceptance Task <startworkforcesamplingtask>	Initiate an acceptance task for a team labeling task based on the dataset ID and team labeling task ID.
	Querying the Acceptance Report of a Team Labeling Task <getworkforcesamplingtask>	Query the acceptance report and statistics for a team labeling task based on the dataset ID and team labeling task ID.
	Updating the Status of a Team Labeling Acceptance Task <updateworkforcesamplingtask>	Determine the acceptance scope for a team labeling task, including all labeled data, and update the sample data accordingly.
	Querying the Sample List of a Team Labeling Task by Page <listworkforcetasksamples>	Query the samples of a team labeling task on the data labeling platform by page based on the dataset ID and team labeling task ID.
	Querying Details About a Team Labeling Sample <describeworkforcetasksample>	Query details about a sample in a team labeling task on the data labeling platform based on the dataset ID, team labeling task ID, and sample ID.
	Querying Team Labeling Tasks by Team Member <listworkertasks>	Members in a team labeling task query all team labeling tasks on the data labeling platform by page.
	Submitting Sample Review Comments for Acceptance <acceptsamples>	During the acceptance of a team labeling task, provide review comments on samples, including the review result and score.
	Reviewing Team Labeling Results <reviewsamples>	The manager of a team labeling task reviews the team labeling task on the data labeling platform based on the dataset ID and team labeling task ID, determines the review result, and provides review comments.
	Updating Labels of Team Labeling Samples in Batches <updateworkforcetasksamples>	Update sample labels on the data labeling platform in batches, including adding, modifying, and deleting the sample labels. Ensure that only the labels in the dataset can be added or modified.
Labeling Team	Querying the Labeling Team List <listworkforces>	Query all labeling teams by page.
	Creating a Labeling Team <createworkforce>	Add a labeling team.
	Querying Details About a Labeling Team <descworkforce>	Query details about a labeling team, including the team name, description, and total number of members based on the team ID.
	Updating a Labeling Team <updateworkforce>	Update the name and description of a labeling team based on the team ID.
	Deleting a Labeling Team <deleteworkforce>	Delete a labeling team based on the team ID.
	Sending an Email to Labeling Team Members <sendemails>	Enable automatic email sending to members in a labeling team to notify them of starting the team labeling task after the task is created.
	Querying All Labeling Team Members <listallworkers>	Query all labeling team members by page based on specified conditions.
	Querying Members in a Labeling Team <listworkers>	Query members in a labeling team by page based on the team ID.
	Creating a Labeling Team Member <createworker>	Add new members to a labeling team.
	Deleting Labeling Team Members in Batches <deleteworkers>	Delete multiple members from a labeling team in batches.
	Querying Details About a Labeling Team Member <descworker>	Query details about a member in a labeling team, including the member description, email address, and role based on the team ID and member ID.
	Updating Labeling Team Members <updateworker>	Update the description and role of a member in a labeling team based on the team ID and member ID.
	Deleting a Labeling Team Member <deleteworker>	Delete a member from a labeling team based on the team ID and member ID.