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_write_content

Anzeigename: Write the given content into a document

Was macht das Tool?

Dieses Tool ermöglicht das Schreiben und Bearbeiten von Inhalten in agorum core Dokumenten durch blockbasierte Operationen.

Es bietet verschiedene Möglichkeiten, wie der Inhalt eingefügt oder ersetzt werden kann:

 Das Zielobjekt (Dokument) muss bereits existieren, andernfalls wird eine Fehlermeldung zurückgegeben.

Empfohlener Einsatzzweck

Das Tool ist geeignet, um Inhalte auf einfache Weise in existierende Dokumente zu schreiben, zum Beispiel für Protokolle, Logfiles, Bearbeitungsvermerke oder für das gezielte Aktualisieren von Textdokumenten im System. Das Tool eignet sich auch für die flexible Bearbeitung (anhängen, überschreiben, voranstellen) von Informationen in zentral verwalteten Dateien.

Funktionsbeschreibung

Parameter Beschreibung
id
(Pflicht)		 ID, UUID oder Pfad des agorum core Objekts, in das geschrieben werden soll.

Hinweis: Das Dokument muss bereits existieren, sonst wird ein Fehler zurückgegeben.
operations
(Pflicht)		 Ein Array von Operationen, die sequenziell ausgeführt werden. Mindestens eine Operation muss angegeben werden.

Jede Operation ist ein Objekt mit folgenden Eigenschaften:

operation (Pflicht): Der Typ der Operation. Mögliche Werte:
  • update: Ersetzt den gesamten Dokumentinhalt mit dem bereitgestellten Inhalt.
    Benötigte Parameter: 
    - content: Der neue vollständige Inhalt des Dokuments.
  • append: Fügt Inhalt am Ende des Dokuments hinzu.
    Benötigte Parameter: 
    - content: Der anzuhängende Inhalt.
  • prepend: Fügt Inhalt am Anfang des Dokuments hinzu.
    Benötigte Parameter: 
    - content: Der voranzustellende Inhalt.
  • replaceBlock: Findet einen bestimmten Textblock und ersetzt ihn durch einen neuen. Dies ist die empfohlene Methode für die meisten Bearbeitungen.
    Benötigte Parameter: 
    - oldBlock: Der exakte zu ersetzende Textblock (genau aus der Datei kopieren).
    - newBlock: Die vollständige neue Version des Textblocks.
    Optionale Parameter:
    - occurrence: Welches Vorkommen ersetzt werden soll (Standard: 1).
    - fuzzyMatch: Bei true werden führende/nachfolgende Leerzeichen ignoriert (Standard: false).
  • insertAfter: Fügt den Inhalt nach einem bestimmten Anker-Text ein.
    Benötigte Parameter: 
    - anchor: Der Text, nach dem eingefügt werden soll.
    - content: Der einzufügende Inhalt
    Optionale Parameter:
    - occurrence: Nach welchem Vorkommen eingefügt werden soll (Standard: 1).
    - fuzzyMatch: Tolerantes Matching (Standard: false)
  • insertBefore: Fügt den Inhalt vor einem bestimmten Anker-Text ein.
    Benötigte Parameter: 
    - anchor: Der Text, vor dem eingefügt werden soll.
    - content: Der einzufügende Inhalt
    Optionale Parameter:
    - occurrence: Vor welchem Vorkommen eingefügt werden soll (Standard: 1).
    - fuzzyMatch: Tolerantes Matching (Standard: false)
  • deleteBlock: Löscht einen bestimmten Textblock.
    Benötigte Parameter: 
    - anchor: Der zu löschende Text.
    Optionale Parameter:
    - occurrence: Welches Vorkommen gelöscht werden soll (1, 2, 3 oder -1 für alle, Standard: 1).
    - fuzzyMatch: Tolerantes Matching (Standard: false)
  • replaceAll: Ersetzt alle Vorkommen eines Textmusters.
    Benötigte Parameter: 
    - anchor: Der zu ersetzende Text.
    - content: Der Ersetzungstext.
    Hinweis: fuzzyMatch wird bei dieser Operation nicht unterstützt.

content (optional): Der einzufügende Inhalt (erforderlich für update, append, prepend, insertAfter, insertBefore, replaceAll).

Hinweis: Zeilenumbrüche (\n) müssen vom Aufrufer selbst eingefügt werden, das System fügt diese nicht automatisch hinzu.

oldBlock (optional): Der exakte zu findende und zu ersetzende Textblock. Erforderlich für replaceBlock.

newBlock (optional): Der neue Textblock, mit dem ersetzt werden soll. Erforderlich für replaceBlock. Dies ist die vollständige neue Version des Textblocks.

anchor (optional): Text, der als Ankerpunkt für die Suche verwendet wird. Erforderlich für: insertAfter, insertBefore, deleteBlock, replaceAll.

occurrence (optional): Welches Vorkommen soll gefunden werden.
Mögliche Werte:

  • 1: Erstes Vorkommen
  • 2: Zweites Vorkommen
  • 3, 4, 5...: Entsprechendes Vorkommen
  • -1: Alle Vorkommen (nur für deleteBlock und replaceAll)

Standard: 1

fuzzyMatch (optional): Steuert das Matching-Verhalten.
Mögliche Werte:

  • true: Ignoriert führende/nachfolgende Leerzeichen-Unterschiede beim Matching
  • false: Exaktes Matching (Standard)

Standard: false
Hinweis: Wird bei replaceAll nicht unterstützt.

 

Das Tool gibt den neuen Inhalt zurück, damit Sie überprüfen können, ob die Änderungen korrekt durchgeführt wurden. Bei Fehlern wird eine Fehlermeldung zurückgegeben (z. B. wenn ein oldBlock nicht gefunden wird).

Tipps und Tricks

Tipps:

  • Das Zielobjekt muss bereits existieren. Falls das Dokument nicht existiert, wird eine Fehlermeldung ausgegeben. 
  • Für die meisten Bearbeitungen ist replaceBlock die beste Wahl. Lesen Sie zuerst die Datei aus, kopieren Sie den zu ändernden Block exakt in oldBlock, und geben Sie die vollständige neue Version in newBlock an.
  • Sie können mehrere Operationen in einem Aufruf kombinieren. Die Operationen werden sequenziell ausgeführt, wobei jede Operation auf dem Ergebnis der vorherigen arbeitet. Dies ist effizienter als mehrere separate Tool-Aufrufe.
  • Der Occurrence-Parameter ermöglicht es, gezielt das erste, zweite oder ein bestimmtes Vorkommen eines Textes zu bearbeiten. Bei deleteBlock und replaceAll können Sie mit -1 alle Vorkommen auf einmal bearbeiten. Dies ist besonders nützlich bei wiederholten Mustern im Dokument.
  • Der fuzzyMatch-Parameter kann hilfreich sein, wenn Sie sich nicht sicher sind, ob am Anfang oder Ende von Zeilen Leerzeichen stehen. Er normalisiert den Text vor dem Matching, indem führende und nachfolgende Leerzeichen pro Zeile entfernt werden.