JSON Schema for tools

Studiennotizen: JSON Schema für Tool-Funktionen

• Zweck des JSON Schema:
• Es dient dazu, die Tool-Funktion und insbesondere die erwarteten Argumente (Parameter) zu beschreiben.
• Dieses Schema wird in der Anfrage an das LLM (z. B. Claude) gesendet, damit das Modell die Funktion korrekt nutzen kann.
• Allgemeine Anwendung:
• JSON Schema ist keine LLM-spezifische Erfindung, sondern eine allgemeine Technik zur Datenvalidierung.
• Struktur des Schemas:
• Das Schema besteht aus zwei Hauptbereichen:
• Name und Beschreibung (allgemeine Beschreibung des Tools).
• Das JSON-Objekt (detaillierte Definition der Argumente/Properties).
• Schritte zur Erstellung (Beispiel: process_data):
• Argument definieren: Erstelle ein Wörterbuch (Dictionary) mit allen Schlüsselargumenten und Beispieldaten.
• Konvertieren: Wandle das Wörterbuch in JSON um (Achtung: Python True wird zu JSON true).
• Schema generieren: Nutze einen Online-Konverter (JSON → JSON Schema), um das notwendige Schema zu erzeugen.
• Beschreiben: Füge jedem Property (Argument) eine detaillierte Beschreibung hinzu.
• Best Practices für Beschreibungen:
• Tool-Beschreibung (Gesamt): Soll 3 bis 4 Sätze lang sein und erklären, was das Tool tut, wann es verwendet werden sollte und welche Art von Daten es zurückgibt.
• Argument-Beschreibungen: Müssen sehr detailliert sein, um genau zu definieren, was das Argument tut und wie es in die Gesamtfunktion passt.
• Tipp: Bei Schwierigkeiten kann der Funktionscode selbst kopiert und an das LLM gesendet werden, um die Argumentbeschreibungen zu generieren.
• Nächster Schritt:
• Nach Erstellung des Schemas muss dieses zusammen mit der Anfrage an Claude gesendet werden, damit das LLM die Verfügbarkeit des Tools erkennt.

Takeaways

• JSON Schema dient dazu, die Tool-Funktion und die erwarteten Argumente (Parameter) für die korrekte Nutzung durch das LLM zu beschreiben.
• Die Struktur besteht aus einer allgemeinen Beschreibung des Tools und einem detaillierten JSON-Objekt, das die Argumente definiert.
• Die Erstellung umfasst die Definition der Argumente, die Konvertierung in JSON und die Hinzufügung sehr detaillierter Beschreibungen für Tool und Properties.
• Nach der Generierung muss das Schema zusammen mit der Anfrage an das LLM gesendet werden, damit es die Verfügbarkeit des Tools erkennt.