Fess API-Leitfaden

Einführung

Einführung

• Zielgruppe
• Bevor Sie beginnen
• Voraussetzungen für die API-Nutzung
• Online-Zugriff
• Kontakt für technischen Support
• Hinweise zu Drittanbieter-Websites
• Übermittlung von Kommentaren und Vorschlägen

API-Schnellstart

• In 5 Minuten starten
• Postman verwenden
• Codebeispiele nach Programmiersprache
• API-Versionskompatibilität
• Fehlerbehebung
• Nächste Schritte

Gemeinsame Spezifikation

API-Übersicht

• Von Fess bereitgestellte APIs
• Basis-URL
• Antwort-Envelope
• Fehlerantwort
• Authentifizierung und Sitzung
• Streaming-Format
• API-Typen

Such-API

Such-API

• Dokumente suchen
• Alle Dokumente abrufen (Scroll-Suche / NDJSON)

Label-API

• Labels abrufen
• Verwendungsbeispiel
• Fehlerantwort

Beliebte-Wörter-API

• Liste beliebter Wörter abrufen
• Verwendungsbeispiel
• Fehlerantwort

Vorschlags-API

• Vorschlagswörterliste abrufen
• Verwendungsbeispiel
• Fehlerantwort

Verwandte-Abfragen- und Verwandte-Inhalte-API

• Verwandte Abfragen abrufen
• Verwandten Inhalt abrufen

Health-API

• Status abrufen
• Verwendungsbeispiel
• Antwort und Fehlerantwort

Authentifizierung und UI

Authentifizierungs- und Sitzungs-API

• Übersicht
• Gemeinsame Benutzerinformationen (UserPayload)
• Authentifizierungsstatus abrufen
• Anmelden
• Abmelden
• Passwort ändern

UI-Konfigurations-API

• Übersicht
• UI-Konfiguration abrufen

Benutzerfunktionen-API

Favoriten-API

• Favoritendokumente auflisten
• Favoritenstatus abrufen
• Dokument als Favorit speichern

Klickprotokoll-API

• Klick protokollieren

Cache-API

• Gecachtes Dokument abrufen

KI-Chat-API

Chat-API

• Übersicht
• Voraussetzungen
• Authentifizierung und CSRF
• Rate-Limiting
• POST /chat
• POST /chat/stream
• DELETE /chat/sessions/{session_id}
• Sicherheit
• Referenzinformationen

Verwaltungs-API

Admin API Referenz

• Admin API Übersicht
• WebConfig API
• FileConfig API
• DataConfig API
• Documents API
• CrawlingInfo API
• FailureUrl API
• Backup API
• Scheduler API
• JobLog API
• User API
• Role API
• Group API
• AccessToken API
• LabelType API
• KeyMatch API
• BoostDoc API
• ElevateWord API
• BadWord API
• RelatedContent API
• RelatedQuery API
• Suggest API
• General API
• SystemInfo API
• Stats API
• Log API
• Storage API
• Plugin API
• Dict API
• SearchLog API