agorum_ai_agents_library_basic_write_content

Anzeigename: Write the given content into a document

Was macht das Tool?

Mit diesem Tool kann beliebiger Textinhalt in ein bestehendes agorum core Dokument geschrieben werden.

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

update: Überschreibt den alten Inhalt vollständig mit dem neuen Inhalt.
append: Hängt den neuen Inhalt am Ende des vorhandenen Inhalts an.
prepend: Fügt den neuen Inhalt am Anfang des bestehenden Inhalts ein.
insertAt: Fügt Inhalt an einer spezifischen Zeilenposition ein.
deleteLines: Löscht einen Zeilenbereich.

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 durch den angegebenen Inhalt append: Fügt Inhalt am Ende des Dokuments hinzu prepend: Fügt Inhalt am Anfang des Dokuments hinzu insertAt: Fügt Inhalt an einer spezifischen Zeilenposition ein deleteLines: Löscht einen Zeilenbereich content (Optional): Der einzufügende Inhalt (erforderlich für update, append, prepend, insertAt). Hinweis: Zeilenumbrüche (\n) müssen vom Aufrufer selbst eingefügt werden, das System fügt diese nicht automatisch hinzu. line (Optional): Die Zeilennummer für insertAt-Operationen (ab 1, bezieht sich auf das Originaldokument) (erforderlich für insertAt). Minimum: 1 Der Inhalt wird VOR der angegebenen Zeile eingefügt. startLine (Optional): Startzeilennummer für deleteLines-Operationen (ab 1, inklusive, bezieht sich auf das Originaldokument) (erforderlich für deleteLines). Minimum: 1 endLine (Optional): Endzeilennummer für deleteLines-Operationen (ab 1, inklusive, bezieht sich auf das Originaldokument) (erforderlich für deleteLines). Minimum: 1

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 durch den angegebenen Inhalt
append: Fügt Inhalt am Ende des Dokuments hinzu
prepend: Fügt Inhalt am Anfang des Dokuments hinzu
insertAt: Fügt Inhalt an einer spezifischen Zeilenposition ein
deleteLines: Löscht einen Zeilenbereich

content (Optional): Der einzufügende Inhalt (erforderlich für update, append, prepend, insertAt).

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

line (Optional): Die Zeilennummer für insertAt-Operationen (ab 1, bezieht sich auf das Originaldokument) (erforderlich für insertAt).
Minimum: 1
Der Inhalt wird VOR der angegebenen Zeile eingefügt.

startLine (Optional): Startzeilennummer für deleteLines-Operationen (ab 1, inklusive, bezieht sich auf das Originaldokument) (erforderlich für deleteLines).
Minimum: 1

endLine (Optional): Endzeilennummer für deleteLines-Operationen (ab 1, inklusive, bezieht sich auf das Originaldokument) (erforderlich für deleteLines).
Minimum: 1

Das Tool gibt den neuen Inhalt zurück, damit Sie überprüfen können, ob die Änderungen korrekt durchgeführt wurden.

Tipps und Tricks

Tipps:

Das Zielobjekt muss bereits existieren. Falls das Dokument nicht existiert, wird eine Fehlermeldung ausgegeben.
Beachten Sie, dass beim Modus update der gesamte vorherige Inhalt verloren geht.
Um eine bestimmte Zeile zu ersetzen, löschen Sie sie zuerst mit deleteLines und fügen dann mit insertAt neuen Inhalt ein.
Alle Zeilennummern in einem Batch beziehen sich IMMER auf das ursprüngliche Dokument vor allen Operationen. Das System verfolgt intern die Verschiebungen durch vorherige Operationen.