latestSwagger 2.02026-08-2053114259.7 KB

41da8739a690

Dataset Management

Delete selected dataset files

Deletes the specified files from the dataset. Ids that do not belong to the dataset are ignored.

post/api/Dataset/{datasetId}/files/delete_selected

Path parameters

datasetIdstring required

Request body

fileIdsstring[] required

Ids of the dataset files to delete. Ids that do not belong to the dataset are ignored.

Response

Returns the deleted files

fileIdstring

The file ID

fileNamestring

The file name

fileTypestring

The file type, such as csv, txt, pdf, docx

datasetIdstring

The identifier of the dataset that owns the file

numRowsinteger nullable

The number of rows in a csv file.

numColumnsinteger

The number of columns in a csv file

piiTypesstring[]

List of all of the entity types that were detected in the file

wordCountinteger

Total number of words in file

redactedWordCountinteger

Total number of redacted words in the file

uploadedTimestampInstant

A point in time represented as an ISO 8601 timestamp string.

fileSource'Local' | 'Sharepoint' | 'Aws' | 'Sdk' | 'Azure' | 'OneLake'

The original upload location of source files (Local, S3, Azure, SharePoint, OneLake, or SDK).

processingStatusstring

Current status of the file: Queued, Running, Completed, or Failed

processingErrorstring nullable

For a file that failed to process, the processing error

mostRecentCompletedJobIdstring nullable

The identifier of the most recent job that processed the file

fileParseResultIdstring nullable

The identifier of the file parse result

filePathstring nullable

If applicable, the file path of the source file

generatedFileStatusstring nullable

Status of the external-file generation job for this file, if applicable