Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht

Navigation: Dokumentationen agorum core > ALBERT | AI > ALBERT | AI Agents > ALBERT| AI KI-Tools-Dokumentationen


agorum_ai_agents_library_basic_directory_tree

Anzeigename: Retrieves the tree (file structure) of an agorum core directory from a starting folder.

Was macht das Tool?

Dieses Tool liefert die komplette Baumstruktur (Verzeichnisstruktur) eines agorum core Ordners ausgehend von einem festgelegten Startordner zurück. Der Rückgabewert ist ein verschachteltes JSON-Objekt, das alle Ordner (und optional auch Dateien) inklusive deren UUIDs und ausgewählten Metadaten bis zur gewünschten Tiefe aufführt.

Empfohlener Einsatzzweck

Das Tool eignet sich, um eine Übersicht über die Ordnerstruktur eines Bereichs in agorum core zu erhalten. Es kann genutzt werden, um Strukturen zu visualisieren, für automatisierte Auswertungen oder zur Navigation in komplexen Verzeichnisbäumen. 

Funktionsbeschreibung

Parameter Beschreibung
id
(Pflicht)
ID (Pfad, UUID oder ID) des agorum core Objekts, von dem aus die Baumstruktur gelesen werden soll.
depth
(Pflicht)
Tiefe des auszugebenden Baumes. Zahl zwischen 1 und 8. Gibt an, wie viele Ebenen der Baumstruktur abgerufen werden.
withFiles
(Optional)
Gibt an, ob auch Dateien innerhalb der Ordner aufgelistet werden sollen.
Standard: false = nur Ordner
metadataFields
(Optional)
Liste der Metadatenfelder, die zusätzlich zu jedem Ordner/Datei ausgelesen werden sollen.
Standard: ['~', '~~'] (alle Metadaten).
basePathIds
(Optional)
Array von Basispfaden (Pfad, UUID oder ID). Die angegebene id muss unterhalb eines dieser Pfade liegen, sonst wird ein Fehler ausgegeben.
Standard: ["/"]

Tipps und Tricks

Tipps:

  • Um die Performance zu verbessern, sollte die depth möglichst klein gewählt werden. Bei sehr großen Verzeichnisbäumen empfiehlt es sich, gezielt mit basePathIds und metadataFields zu arbeiten, um die Datenmenge zu begrenzen.
  • Über die Option metadataFields können gezielt zusätzliche Informationen, wie zum Beispiel Bereichszuteilungen oder eindeutige Bezeichner, direkt für jeden Ordner/Datei im Baum mit ausgegeben werden – ideal für individuelle Berichte und Auswertungen. Die zurückgegebene Datenmenge kann dadurch allerdings auch sehr groß werden.
  • Die maximale depth beträgt 8. Bei größeren Strukturen ist ggf. eine gestaffelte Abfrage empfohlen.