lboka/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/modelarts/api-ref/DeleteSamples.html
Lai, Weijian 2f0818cf3d ModelArts API 22.3.0 version-20240311 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Lai, Weijian <laiweijian4@huawei.com>
Co-committed-by: Lai, Weijian <laiweijian4@huawei.com>
2024-04-05 09:35:42 +00:00

10 KiB
Raw Blame History

Deleting Samples in Batches

Function

This API is used to delete samples in batches.

URI

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.

Request Parameters

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.

Response Parameters

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.

Example Requests

Deleting Samples in Batches

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

Example Responses

Status code: 200

OK

{
  "success" : true
}

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.

Parent topic: Sample Management