Zuletzt aktualisiert: 19. August

APIs und Dokumentation für KI-Tools zugänglicher machen

Kevin van Zonneveld

Mitgründer · Amsterdam, Niederlande ·

Transloadit veröffentlicht die Dateien /llms.txt und /llms-full.txt, damit unsere Dokumentation für Tools mit Retrieval-Funktion und KI-Agenten leichter nutzbar wird. Diese Dateien bieten Markdown-orientierte Einstiegspunkte neben der normalen Dokumentations-Website.

Was ist llms.txt?

Im September 2024 schlug Jeremy Howard, Mitgründer von Answer.AI, /llms.txt vor: eine Community-Konvention für die Veröffentlichung eines knappen Markdown-Index wichtiger Seiten. Sie bietet Retrieval-Systemen einen einfacheren Ausgangspunkt als eine gerenderte Website und ermöglicht es Aufrufenden, relevante Quellseiten auszuwählen, bevor diese in den Kontext eines Modells aufgenommen werden.

llms.txt sollte als Retrieval-Schnittstelle verstanden werden, nicht als SEO- oder Answer-Ranking-Mechanismus. Die Veröffentlichung der Datei garantiert nicht, dass Google, ChatGPT oder ein anderes Produkt sie findet, sie nutzt, eine Website anders bewertet oder eine genauere Antwort liefert. Jeder Crawler, Assistent und Agent entscheidet selbst, welche URLs er abruft und wie er die zurückgegebenen Inhalte verwendet.

Die aktuelle Konvention beschreibt einen kleinen Retrieval-Graphen:

Pfadbezogene Dateien im Format llms.txt bieten knappe Übersichten mit strukturierten Links zu wichtigen Ressourcen.
Dokumentationsseiten stellen Markdown-Varianten bereit, während Links mit rel="alternate" und rel="describedby" Clients dabei helfen, die Markdown-Seite und den spezifischsten Index zu finden.

Transloadit stellt außerdem weiterhin /llms-full.txt bereit, einen älteren, implementierungsspezifischen Zusatz-Endpunkt, der einen monolithischen Dokumentationskorpus enthält. Er ist nicht Teil des aktuellen llms.txt-Formats und nicht der empfohlene Ausgangspunkt für Retrieval.

Warum ist das für Entwickler wichtig?

Wenn ein Tool diese Dateien abrufen kann, bietet die Implementierung von Transloadit praktische Vorteile:

Ein vorhersehbarer Einstiegspunkt: Tools können von einem dokumentierten Index ausgehen, statt Links in einer gerenderten Navigation zu entdecken.
Selektive Kontextnutzung: Aufrufende können genau die Seiten abrufen, die für eine Aufgabe relevant sind, statt den gesamten Dokumentationskorpus in einen Prompt zu packen.
Quellenbasierte Antworten: Agenten können aktuelle Seiten zu unseren Robots, Parametern und Workflows zitieren. Die Genauigkeit hängt weiterhin von Retrieval, Modellverhalten und Überprüfung ab.
Geringerer Parsing-Aufwand: Markdown entfernt einen Großteil der Navigation, der Gestaltung und der clientseitigen Oberfläche, die für das Abrufen von Dokumentation irrelevant sind.

Was ist in unserer Implementierung enthalten?

Unsere Datei /llms.txt bietet einen knappen Überblick über die Kernfunktionen von Transloadit, darunter:

eine klare Erläuterung unserer Möglichkeiten zum Upload und zur Verarbeitung von Dateien;
beispielhafte Assembly Instructions, die unsere JSON-basierte Workflow-Konfiguration veranschaulichen;
Links zu wichtigen Dokumentationsressourcen;
eine umfassende Liste der verfügbaren Robots.

Die ausführlichere Datei /llms-full.txt ergänzt dies um:

detaillierte Robot-Parameterschemata;
Codebeispiele für verschiedene Integrationsszenarien;
eine umfassende Dokumentation zu allen Aspekten des Transloadit-Service.

llms.txt mit KI-Tools verwenden

Beginnen Sie mit https://transloadit.com/llms.txt, wählen Sie die Links aus, die zur Aufgabe passen, und rufen Sie diese Seiten ab. Wenn Ihr Tool keine URLs abrufen kann, kopieren Sie das relevante Markdown in den Prompt oder hängen Sie die heruntergeladene Datei an. Vermeiden Sie es, llms-full.txt standardmäßig zu laden: Die gezielt ausgewählten Seiten verbrauchen in der Regel weniger Kontext und lassen sich leichter überprüfen.

Gehen Sie nicht davon aus, dass ein Assistent die URL abruft, nur weil sie erwähnt wird. Prüfen Sie die Retrieval- oder Browsing-Funktionen des Tools und lassen Sie sich die Quellseiten nennen, die es tatsächlich verwendet hat.

Machen Sie mit bei der KI-freundlichen Web-Bewegung

Wir sehen llms.txt als nützliche, leichtgewichtige Konvention für das Abrufen von Dokumentation. Ihr Wert ergibt sich daraus, dass Tools eine stabile Quellenübersicht erhalten und Entwickler steuern können, welche Seiten in den Kontext eines Modells gelangen, nicht aus einem vermuteten Ranking-Vorteil.

Wir ermutigen andere Dienste, sich dieser Bewegung anzuschließen und eigene Dateien im Format llms.txt bereitzustellen. Weitere Informationen zum Vorschlag finden Sie unter llmstxt.org.

Ressourcen

Wir sind gespannt, wie Entwickler diese Retrieval-Schnittstelle mit Transloadit nutzen. Wie immer freuen wir uns über Ihr Feedback und Ihre Fragen in unserem Community Forum.