# Get the detected entities for a dataset

{% hint style="info" %}
**Required dataset permission:** Must be granted a dataset permission set for the dataset.
{% endhint %}

To get the detected entities for a dataset, use [`dataset.get_entity_mappings`](https://tonic-textual-sdk.readthedocs-hosted.com/en/latest/datasets/api.html#tonic_textual.classes.dataset.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.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.tonic.ai/textual/tonic-textual-api/datasets-redaction/dataset-get-entity-mappings.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
