Get the detected entities for a dataset

Required dataset permission: Must be granted a dataset permission set for the dataset.

To get the detected entities for a dataset, use dataset.get_entity_mappings.

In the response, the detected entities are grouped by file.

For files that have no entities, either because none were detected or the entity type handling was set to Ignore, the entity list is empty.

For each entity, the response includes:

• The entity type.

• The source value.

• The output value if the entity type handling option is Redact.

• The output value if the entity type handling option is Synthesize.

• The assigned entity type handling option for the entity type.

• The output value based on the entity type handling option (Redact or Synthesize). When the entity type handling option is Ignore, the entity is not included in the list.

• For tabular data, the row and column where the entity was detected.

• The confidence score for the detection.