Metis · Librarian — Remove Library Item
remove_library_itemRemove a library item from the index, with an option to delete the associated file from disk.
Instructions
Remove a library item from the Metis index, optionally deleting the file.
De-indexes a paper or document by deleting its row from library_seeded. By
default the file on disk is left untouched (index-only removal); set
delete_file=True to also delete the file, which is guarded so only paths
inside the PKM root can be removed. To hide rather than remove an item, use
archive_library_item instead.
Args:
relative_path: The relative_path primary key identifying the row in the
library_seeded table.
delete_file: If True, also delete the underlying file from disk (subject
to the within-PKM-root safety check); if False (default), only the
index row is removed.
Returns:
A confirmation message of what was removed, or a not-found / error
message if the item or table is missing.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| delete_file | No | ||
| relative_path | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |