GET
/api/v1/faq
Erzeugt aus einem Text eine Liste von Frage-Antwort-Paaren (FAQ).
Autorisierung
notwendig
Parameter
| Name | Datentyp | Beschreibung |
|---|---|---|
| model | string | zu verwendendes LLM, mögliche Optionen siehe GET /api/v1/models |
| url | string |
URL einer Website Die übergebene URL muss öffentlich aufrufbar sein und den HTTP-Status 200 zurückgeben. Die Funktion versucht, den Hauptinhalt aus der Seite als Text zu extrahieren und nebensächliche Inhalte (Navigationen, Medieninhalte, Marginalien etc.) zu entfernen. Für mehr Kontrolle über den übergebenen Text gibt es POST /api/v1/faq. |
| language | string | Sprache (de, en), Default: de bzw. die Sprache der übergebenen Website |
Beispiel
GET /api/v1/faq?url=https%3A//www.wegewerk.com/de/tools/wwedit-agentur/
Antwort-Status
{
"remote-ip": "127.0.0.1",
"status": "OK",
"faq": "[\n {\n \"question\": \"Was ist ww.edit?\",\n \"answer\": \"ww.edit ist ein eigenes Content-Management-System, das von wegewerk seit 2001 entwickelt wird. Es ist speziell auf die Betreuung von Online-Kampagnen zugeschnitten und bietet Individualit\u00e4t zu g\u00fcnstigen Konditionen.\"\n },\n {\n \"question\": \"Welche Vorteile bietet ww.edit gegen\u00fcber OpenSource-Software?\",\n \"answer\": \"Mit ww.edit machen Sie sich unabh\u00e4ngig von den Interessen einer anonymen Entwicklergemeinde. Es erfordert keine st\u00e4ndigen Updates und erm\u00f6glicht eine schnelle Umsetzung individueller Online-Auftritte.\"\n },\n {\n \"question\": \"Welche Funktionen bietet ww.edit f\u00fcr Online-Kampagnen?\",\n \"answer\": \"ww.edit bietet Tools wie Newsletter, Unterst\u00fctzerlisten, E-Cards, Abgeordneten-Mailings und Aktionskalender, die schnell einsatzbereit sind.\"\n },\n {\n \"question\": \"Wie einfach ist die Bedienung von ww.edit?\",\n \"answer\": \"ww.edit ist auf intuitive Bedienung ausgelegt und verzeiht redaktionelle Fehler leicht, was den Supportaufwand gering h\u00e4lt.\"\n },\n {\n \"question\": \"Ist ww.edit barrierefrei?\",\n \"answer\": \"Ja, mit ww.edit wurde die erste CMS-basierte Website auf der 95plus-Liste des Projektes 'Barrierefrei Informieren und Kommunizieren' (BIK) umgesetzt.\"\n },\n {\n \"question\": \"Welche Referenzprojekte hat wegewerk mit ww.edit umgesetzt?\",\n \"answer\": \"Referenzprojekte umfassen das Infoportal des Jugendrotkreuzes, die Kampagne 'Tarifrebell*innen' der ver.di Jugend, die Petitionswebsite 'Save Bees and Farmers!', die Website der Evangelischen Akademie zu Berlin und das Dialogportal der IG Metall.\"\n }\n]",
"duration": 29.256528962
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "Unauthorized"
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "Not enough credits",
"credits": {
"total": "200",
"remaining": "0",
"valid_from": "2025-01-01",
"valid_until": "2025-01-30"
}
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "Authentication required"
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "Authorization malformatted"
}
null
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "missing parameter: [url]"
}
POST
/api/v1/faq
Erzeugt aus einem Text eine Liste von Frage-Antwort-Paaren (FAQ).
Autorisierung
notwendig
Parameter
| Name | Datentyp | Beschreibung |
|---|---|---|
| model | string | zu verwendendes LLM, mögliche Optionen siehe GET /api/v1/models |
| text | string | zu verarbeitender Text (plain text) |
| language | string | Sprache (de, en), Default: de |
Beispiel
{
"model": "mistral-small3.2:latest",
"text": "Weit hinten, hinter den Wortbergen, fern der L\u00e4nder Vokalien und Konsonantien leben die Blindtexte. Abgeschieden wohnen sie in Buchstabhausen an der K\u00fcste des Semantik, eines gro\u00dfen Sprachozeans. Ein kleines B\u00e4chlein namens Duden flie\u00dft durch ihren Ort und versorgt sie mit den n\u00f6tigen Regelialien. Es ist ein paradiesmatisches Land, in dem einem gebratene Satzteile in den Mund fliegen. Nicht einmal von der allm\u00e4chtigen Interpunktion werden die Blindtexte beherrscht \u2013 ein geradezu unorthographisches Leben. Eines Tages aber beschlo\u00df eine kleine Zeile Blindtext, ihr Name war Lorem Ipsum, hinaus zu gehen in die weite Grammatik.\r\n\r\nDer gro\u00dfe Oxmox riet ihr davon ab, da es dort wimmele von b\u00f6sen Kommata, wilden Fragezeichen und hinterh\u00e4ltigen Semikoli, doch das Blindtextchen lie\u00df sich nicht beirren. Es packte seine sieben Versalien, schob sich sein Initial in den G\u00fcrtel und machte sich auf den Weg. Als es die ersten H\u00fcgel des Kursivgebirges erklommen hatte, warf es einen letzten Blick zur\u00fcck auf die Skyline seiner Heimatstadt Buchstabhausen, die Headline von Alphabetdorf und die Subline seiner eigenen Stra\u00dfe, der Zeilengasse. Wehm\u00fctig lief ihm eine rhetorische Frage \u00fcber die Wange, dann setzte es seinen Weg fort. Unterwegs traf es eine Copy.\r\n\r\nDie Copy warnte das Blindtextchen, da, wo sie herk\u00e4me w\u00e4re sie zigmal umgeschrieben worden und alles, was von ihrem Ursprung noch \u00fcbrig w\u00e4re, sei das Wort \"und\" und das Blindtextchen solle umkehren und wieder in sein eigenes, sicheres Land zur\u00fcckkehren. Doch alles Gutzureden konnte es nicht \u00fcberzeugen und so dauerte es nicht lange, bis ihm ein paar heimt\u00fcckische Werbetexter auflauerten, es mit Longe und Parole betrunken machten und es dann in ihre Agentur schleppten, wo sie es f\u00fcr ihre Projekte wieder und wieder mi\u00dfbrauchten. Und wenn es nicht umgeschrieben wurde, dann benutzen Sie es immernoch.",
"language": "de"
}
Antwort-Status
{
"remote-ip": "127.0.0.1",
"status": "OK",
"faq": "[\n {\n \"question\": \"Was sind Blindtexte und wo leben sie?\",\n \"answer\": \"Blindtexte leben in Buchstabhausen an der K\u00fcste des Semantik, einem gro\u00dfen Sprachozean. Sie wohnen abgeschieden in einem paradiesmatischen Land, das von einem B\u00e4chlein namens Duden durchflossen wird.\"\n },\n {\n \"question\": \"Wer ist Lorem Ipsum und was tut sie?\",\n \"answer\": \"Lorem Ipsum ist eine kleine Zeile Blindtext, die beschlie\u00dft, ihr sicheres Zuhause zu verlassen und in die weite Grammatik hinauszugehen, trotz Warnungen des gro\u00dfen Oxmox.\"\n },\n {\n \"question\": \"Was passiert mit Lorem Ipsum auf ihrer Reise?\",\n \"answer\": \"Auf ihrer Reise trifft Lorem Ipsum eine Copy, die sie warnt, umzukehren. Doch Lorem Ipsum l\u00e4sst sich nicht beirren und wird schlie\u00dflich von Werbetextern betrunken gemacht und in ihre Agentur verschleppt, wo sie f\u00fcr Projekte missbraucht wird.\"\n }\n]",
"duration": 19.167938864
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "submitted data is not valid JSON"
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "Unauthorized"
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "Not enough credits",
"credits": {
"total": "200",
"remaining": "0",
"valid_from": "2025-01-01",
"valid_until": "2025-01-30"
}
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "Authentication required"
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "Authorization malformatted"
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "[language] must be one of: {de,en}"
}
{
"remote-ip": "127.0.0.1",
"status": "Error",
"message": "missing parameter: [text]"
}