Deleting Samples in Batches¶

Function¶

This API is used to delete samples in batches.

POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples/delete

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
dataset_id	Yes	String	Dataset ID.
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

**Table 2** Request body parameters¶
Parameter	Mandatory	Type	Description
delete_source	No	Boolean	Whether to delete the source file. This field is valid for non-text datasets. (A text dataset is the entire text file. Therefore, deleting a piece of data from the text file does not affect the source text.) The options are as follows: false: Do not delete the source file. (Default value) true: Delete the source file. (Note: This operation may affect the dataset versions or other datasets that have used these files. As a result, the page display, training, or inference is abnormal.)
samples	No	Array of strings	Sample ID list.

Status code: 200

**Table 3** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
results	Array of BatchResponse objects	Response list for deleting a sample in batches.
success	Boolean	Check whether the operation is successful. The options are as follows: true: The operation is successful. false: The operation is failed.

**Table 4** BatchResponse¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
success	Boolean	Check whether the operation is successful. The options are as follows: true: The operation is successful. false: The operation is failed.

Deleting Samples in Batches

{
  "samples" : [ "9cb9bc9b34bf53b6ec9a84998b1711bf", "9ea63ef78d8c9037c9bcb12b477821bf" ]
}

Status code: 200

{
  "success" : true
}

last updated: 2024-06-20 00:39