agorum_ai_agents_library_basic_agorum_core_query_search

Anzeigename: Query search in agorum core

Was macht das Tool?

Dieses Tool ermöglicht die Durchführung von gezielten Suchabfragen in agorum core mittels einer flexiblen Such-Query.
Es durchsucht beliebige Objekte und liefert – je nach Konfiguration – deren UUIDs, Namen, optionale ObjectLinks sowie (wenn gewünscht) spezifische Metadaten zurück. Es können Ergebnislimits, Sortierungen und weitere Rückgabe-Optionen eingestellt werden.

Empfohlener Einsatzzweck

Das Tool eignet sich zur Implementierung komplexer, spezifisch gefilterter Suchvorgänge in agorum core. Es ist ideal, wenn individuelle Felder, Sortierungen oder Einschränkungen gewünscht sind – etwa für Auswertungen, Recherche oder dynamische Ergebnislisten.

Funktionsbeschreibung

Parameter	Beschreibung
query (Pflicht)	Der agorum core Query-String, nach dem gesucht werden soll (z. B. `inpath:9999 classname:fileobject`). Siehe Suchsyntax in Solr verwenden.
limit (optional)	Maximale Anzahl der zurückzugebenden Treffer. Wertebereich: 0–10000. 0: gibt alle Ergebnisse zurück (Achtung auf Performance bei großen Ergebnismengen!) Standard: 10. Maximum: `10000`
withObjectLink (optional)	Gibt zusätzlich für jeden Treffer einen ObjectLink (Direktlink ins System) zurück. `true`: Ein ObjectLink wird pro Ergebnis zurückgegeben `false`: Kein ObjectLink wird zurückgegeben Standard: `true`
sort (optional)	Array mit Sortieranweisungen. Jede Sortieranweisung besteht aus einem Metadatennamen und der Sortierrichtung. Beispiel: `["lastmodifydate desc", "name asc"]` Standard: `["lastmodifydate desc"]`
properties (optional)	Array mit den gewünschten Eigenschaften (Metadatennamen), die pro Ergebnis zurückgegeben werden sollen. Alle Namen müssen in Kleinbuchstaben geschrieben werden. Beispiel: `["uuid", "name", "area", "contentonly"]` Besonderheit: `contentonly` gibt den Textinhalt des Objekts zurück. Standard: `["uuid"]`
total (optional)	Gibt an, ob nur die Gesamtzahl aller Treffer zurückgegeben werden soll. `true`: Es wird nur die Gesamtanzahl (`total`) zurückgegeben, keine Einzelergebnisse `false`: Es werden die Einzelergebnisse zurückgegeben Standard: `false`

Tipps und Tricks

Tipps:

Bei komplexen Suchen empfiehlt es sich, Ergebnisanzahl, Sortierungen und Feldlisten sinnvoll zu begrenzen und zu testen – zu breite/unscharfe Suchen können Performance-Probleme verursachen!
Der Parameter contentonly in properties ermöglicht das Auslesen des Textinhalts eines Dokuments. Dies kann bei großen Dokumenten zu längeren Antwortzeiten führen.
Wenn Sie nur wissen möchten, wie viele Treffer eine Suche hat, setzen Sie total: true. Das ist deutlich performanter als alle Ergebnisse abzurufen.