Remove a field
remove_fieldPermanently delete a single false-positive field from the active workspace by its field_id.
Permanence & unknown-id behavior: immediately removes `field_id` from
`workspace_id` and returns `{"removed": 1, "fields_remaining": <count>}` (or
`{"removed": 0, "fields_remaining": <count>, "unknown_field_ids": [field_id]}`
if `field_id` is not found). Deletion is permanent within the active
workspace — to restore a deleted field, re-add it with `add_field` or re-open
the document with `open_pdf`. Saved account templates are unaffected unless
`save_template` is called afterward.
When to use:
- Use `remove_field` to delete one specific false-positive field box (e.g. a
stray box over printed text).
- Use `remove_fields` to delete 2 or more known `field_id`s in a single batch
call.
- Use `prune_fields` for rule-based bulk filtering by `confidence_below`,
`width_below`, `height_below`, `field_type`, or `page_index`.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"workspace_id": "<workspace_id>",
"field_id": "<field_id>"
},
"name": "remove_field"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| field_id | Yes | ID of the field to permanently delete from the workspace (from `open_pdf` or `list_fields`, e.g. `'p0_f3'`). | |
| workspace_id | Yes | Active workspace ID returned by `open_pdf` (`summary.workspace_id`). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||