Python
Metadata
Generate
Classify specified files with the provided tags. To run sensitivity detection, use tags with a strategy of SENSITIVITY or a group which includes the magic word “Sensitivity”
Request Body
| Field | Type | Description |
|---|---|---|
data_connector_name | str | Name of the data connector (vector database profile) to use for classification. |
file_names | Optional[List[str]] | Names of specific files to classify. |
tag_names | Optional[List[str]] | Names of tags to use for classification (if tag_datas not provided). |
tag_datas | Optional[Dict] | Tag data to use for classification. |
overwrite | bool | Whether to overwrite existing tags. Default: false |
job_id | Optional[str] | Custom job ID for tracking the classification task. |
soft_run | bool | If true, classification will not save to Deasy and will return results. Default: false |
hierarchy_name | Optional[str] | Name of the hierarchy/graph to use (if hierarchy_data not provided). |
hierarchy_data | Optional[Dict] | Hierarchy/graph data to use for classification. Default: {} |
dataslice_id | Optional[str] | ID of the dataslice to use for file filtering. |
Response
- 200: Classification completed or job started successfully
- Returns:
{ "message": str, "job_id": str, "results": Optional[Dict] }
- Returns:
- 500: Internal Server Error
Example
{
"data_connector_name": "my-connector",
"file_names": ["document1.pdf", "document2.pdf"],
"tag_names": ["category", "sentiment"],
"overwrite": false,
"soft_run": false
}
POST
Python
Body
application/json