Elke aanvraag aan de Debot API moet worden geauthenticeerd door middel van een API-sleutel. Deze sleutel dient meegegeven te worden in de request headers. Gebruik hiervoor de Debot-API-Key header. Aanvragen zonder geldige API-sleutel worden geweigerd.

De basis URL voor alle API-aanroepen is https://debot.lodder.dev/.

In deze API-documentatie gebruiken we bepaalde termen met specifieke betekenissen:

• De term "party" verwijst binnen onze API naar politieke partijen, individuen, of fracties die betrokken zijn bij debatten of discussies.
• De term "post" duidt op het specifieke overheidsonderdeel of bestuursorgaan waaraan een bewindslied is verbonden.

Aan het einde van dit document worden voor zowel "party" als "post" whitelisted waarden vermeld. Hoewel onze modellen in staat zijn om diverse input te verwerken, anticiperen we op optimale resultaten wanneer de aangegeven terminologie wordt aangehouden, waar mogelijk.

Het model zou bijvoorbeeld kunnen herkennen dat "PvdD" en "Partij voor de Dieren" dezelfde entiteit vertegenwoordigen. Echter, gezien de consistentie waarmee "PvdD" in de trainingsdata voorkomt, is het aannemelijk dat het model sterker reageert op deze specifieke afkorting.

Centraal binnen onze API is het SessieObject. De API faciliteert het genereren van debatten via een specifiek endpoint, dat werkt met een structuur genaamd DebateRequest. Dit object speelt een cruciale rol door de vereisten voor een debat te specificeren.

DebateRequest beschrijft de input voor het /debat endpoint. Het geeft aan welk SessieObject betrokken is, welke deelnemers willen worden meegenomen in de volgende berichten, of de response dummy-data moet teruggeven (debug=True), met welk model (Alpaca of Bloom) het debat gegenereerd moet worden, en of het model een enkel (single_message=True), of een onbepaald aantal berichten mag genereren.

{
    "session": "<SessieObject>"
    "debug": bool,
    "single_message": bool,
    "desired_speakers": ["<SprekerObject>", ...],
    "model": "String (alpaca | bloom)"

}

Let op: Wanneer debug uitstaat worden de requests doorgestuurd naar de GPU servers. Gelieve tijdens ontwikkelen van de frontend debug op True houden.

De desired_speakers bieden een manier om de gewenste deelnemers aan het debat met het model te communiceren. Deze worden meegenomen in de context prompt aan het model, zodat het weet welke deelnemers het debat heeft. Echter is dit geen garantie dat het model ook daadwerkelijk deze deelnemers meeneemt in de berichten die het genereert. Vooral als er reeds berichten zijn, zou het goed kunnen dat het model de interactie voortzet tussen de sprekers die reeds gesproken hebben.

Met behulp van single_message kan worden gevraagd aan het model om een enkel bericht te genereren. De API zal zodoende ook

Dit endpoint is ontworpen om zowel de aanmaak als de voortzetting van debatten te faciliteren. Het verwerkt de volgende datastructuur als input:

{
    "session": "<SessionObject>",
    "desired_speakers": ["<SprekerObject>", ...],
    "debug": bool,
    "single_message": bool,
    "model": "String (alpaca | bloom)",
}

Na verwerking retourneert het een bijgewerkt session, waarbij de lijst van berichten is uitgebreid.

Indien debug=True, ontvangt u dummy-data als respons; in het andere geval wordt gebruik gemaakt van het opgegeven model om het debat te genereren.

Indien single_message=True, geeft de API een enkel nieuw bericht terug.

Het systeem bepaalt de huidige deelnemerslijst van het debat op basis van de sprekers in de berichten van het geretourneerde session_object.

Lege berichtenlijsten triggeren de aanmaak van initiële berichten, terwijl een reeds gevulde lijst zal resulteren in de generatie van vervolgberichten door het model.

desired_speakers specificeert de beoogde nieuwe deelnemers voor de volgende fase van het debat. Samen met de bestaande sprekers in de berichten, helpt dit het model te bepalen wie aan het debat deelnemen.

De volgende RegeringObjects zijn mogelijk:

governments = [
    {"name": "Balkenende IV", "status": "governing"},
    {"name": "Balkenende IV", "status": "demissionair"},
    {"name": "Rutte I", "status": "governing"},
    {"name": "Rutte I", "status": "demissionair"},
    {"name": "Rutte II", "status": "governing"},
    {"name": "Rutte II", "status": "demissionair"},
    {"name": "Rutte III", "status": "governing"},
    {"name": "Rutte III", "status": "demissionair"},
    {"name": "Rutte IV", "status": "governing"},
    {"name": "Rutte IV", "status": "demissionair"},
]