ILT KU Leuven

ALGEMEEN

Welkom op de API-pagina van het Instituut voor Levende Talen van de KU Leuven.
Deze API's stellen je in staat om een spellingchecker te bouwen die suggesties teruggeeft voor verkeerd gespelde woorden.
SPELLINGCHECKER API verrijkt je tekst door de verkeerd gespelde woorden aan te duiden.
SUGGESTIES API gaat op zoek naar de correcte vorm van het verkeerd gespelde woord.

Disclaimer

SPELLINGCHECKER API

ALGEMEEN

Url: https://dev.schrijfhulp.be/v1/spellingchecker/

status:
- message
  - type: string
  - wat: geeft statusboodschap terug: 'ok', 'wrong language', 'forbidden', 'too many characters' of 'too many calls'
- code
  - type: integer
  - wat: geeft statuscode terug: 200 (ok), 406 (wrong language), 403 (forbidden), 420 (too many characters) of 429 (too many calls)
settings:
- startmarker
  - type: string
  - wat: fouten zullen in de tekst worden aangeduid d.m.v. een start- en een endmarker.
    vb: als je de startmarker |*start*| meegeeft, zal het woord 'fautje' in de tekst op deze manier aangeduid worden: |*start*|fautje|*end*|
    Als je geen startmarker meegeeft, zal de API de default startmarker |* gebruiken: |*fautje*|.
- endmarker
  - type: string
  - wat: fouten zullen in de tekst worden aangeduid d.m.v. een start- en een endmarker.
    vb: als je de endmarker |*end*| meegeeft, zal het woord 'fautje' in de tekst op deze manier aangeduid worden: |*start*|fautje|*end*|
    Als je geen endmarker meegeeft, zal de API de default endmarker *| gebruiken: |*fautje*|.
- html
  - type: boolean
  - wat: html-tags worden altijd uit de tekst verwijderd, maar als je deze waarde op 1 zet, blijft de witruimte tussen regels behouden door middel van <p>-tags.
    De defaultwaarde is 0.
spellingchecker:
- input
  - type: string
  - wat: geeft de originele tekst onbewerkt terug.
- output
  - context
    - type: array
    - wat: een array die foute patronen bevat. De woorden op zich zijn correct, maar de combinatie van de woorden niet. vb. Hij doet beroep op zijn vriend.
  - mistakes
    - type: array
    - wat: een array die alle fout gespelde woorden bevat.
  - marked
    - type: string
    - wat: geeft de bewerkte tekst terug. Fouten bevinden zich tussen startmarker en endmarker.
debug:
- timeneeded
  - type: integer
  - wat: geeft de totale tijd in seconden terug van de analyse.

OUTPUT

JSON-FORMAAT

{
    status: {
        message: string,
        code: integer
    },
    settings: {
        startmarker: string,
        endmarker: string,
        html: boolean
    },
    spellingchecker: {
        input: string,
        output: {
            context: [
                array
            ],
            mistakes: [
                array
            ],
            marked: string
        }
    },
    debug: {
        timeneeded: integer
    }
}

VOORBEELD

INPUT MET PHP CURL

$data = array(
    'key' => '1234-5678-ABCD-EFGH',
    'input' => 'Op dit tijdsstip is auto rijden gevaalijk.',
    'startmarker' => '|*s*|',
    'endmarker' => '|*e*|',
    'html' => true
);
$url = "https://dev.schrijfhulp.be/v1/spellingchecker/";

$handle = curl_init($url);
curl_setopt($handle, CURLOPT_POST, true);
curl_setopt($handle, CURLOPT_POSTFIELDS, $data);
curl_setopt($handle, CURLOPT_RETURNTRANSFER, true);
return curl_exec($handle);

OUTPUT MET PHP CURL

{
    status: {
        message: "ok",
        code: 200
    },
    settings: {
        startmarker: "|*s*|",
        endmarker: "|*e*|",
        html: true
    },
    spellingchecker: {
        input: "Op dit tijdsstip is auto rijden gevaalijk.",
        output: {
            mistakes: [
                "tijdsstip",
                "auto rijden",
                "gevaalijk"
            ],
            marked: "Op dit |*s*|tijdsstip|*e*| is |*s*|auto rijden|*e*| |*s*|gevaalijk|*e*|."
        }
    },
    debug: {
        timeneeded: 0.2031
    }
}

SUGGESTIES API

ALGEMEEN

Url: https://dev.schrijfhulp.be/v1/suggesties/

status:
- message
  - type: string
  - wat: geeft statusboodschap terug: 'ok', 'wrong language', 'forbidden', 'too many characters' of 'too many calls'
- code
  - type: integer
  - wat: geeft statuscode terug: 200 (ok), 406 (wrong language), 403 (forbidden), 420 (too many characters) of 429 (too many calls)
suggesties:
- input
  - type: string
  - wat: herhaling van de geposte data
- output:
  - suggesties
debug:
- timeneeded
  - type: integer
  - wat: geeft de totale tijd in seconden terug van de zoektocht naar suggesties.

OUTPUT

JSON-FORMAAT

{
    status: {
        message: string,
        code: integer
    },
    suggesties: {
        input: string,
        output: {
            suggesties: array
        }
    },
    debug: {
        timeneeded: integer
    }
}

VOORBEELD

INPUT MET PHP CURL

$data = array(
    'key' => '1234-5678-ABCD-EFGH',
    'input' => 'vicerektor'
);
$url = "https://dev.schrijfhulp.be/v1/suggesties/";

$handle = curl_init($url);
curl_setopt($handle, CURLOPT_POST, true);
curl_setopt($handle, CURLOPT_POSTFIELDS, $data);
curl_setopt($handle, CURLOPT_RETURNTRANSFER, true);
return curl_exec($handle);

OUTPUT MET PHP CURL

{
    status: {
        message: "ok",
        code: 200
    },
    suggesties: {
        input: "vicerektor",
        output: {
            suggesties: [
                "vicerector,vicerectoren"
            ]
        }
    },
    debug: {
        timeneeded: 0.2031
    }
}

AANEENSCHRIJVEN OF NIET API

ALGEMEEN

Url: https://dev.schrijfhulp.be/v1/aaneen/

status:
- message
  - type: string
  - wat: geeft statusboodschap terug: 'ok', 'wrong language', 'forbidden', 'too many characters' of 'too many calls'
- code
  - type: integer
  - wat: geeft statuscode terug: 200 (ok), 406 (wrong language), 403 (forbidden), 420 (too many characters) of 429 (too many calls)
aaneen:
- input
  - type: string
  - wat: herhaling van de geposte data
- output:
  - marked
    - type: string
    - wat: geeft de bewerkte tekst terug. Fouten bevinden zich tussen startmarker en endmarker.
  - opmerkingen
    - type: array
    - wat: index, gevonden fout, opmerking
debug:
- timeneeded
  - type: integer
  - wat: geeft de totale tijd in seconden terug van de zoektocht naar suggesties.

OUTPUT

JSON-FORMAAT

{
    status: {
        message: string,
        code: integer
    },
    aaneen: {
        input: string,
        output: {
            marked: string,
            opmerkingen: [
                array
            ]
        }
    },
    debug: {
        timeneeded: integer
    }
}

VOORBEELD

INPUT MET PHP CURL

$data = array(
    'key' => '1234-5678-ABCD-EFGH',
    'input' => 'De coalitie vorming zit in het slop.'
);
$url = "https://dev.schrijfhulp.be/v1/aaneen/";

$handle = curl_init($url);
curl_setopt($handle, CURLOPT_POST, true);
curl_setopt($handle, CURLOPT_POSTFIELDS, $data);
curl_setopt($handle, CURLOPT_RETURNTRANSFER, true);
return curl_exec($handle);

OUTPUT MET PHP CURL

{
    status: {
        message: "ok",
        code: 200
    },
    aaneen: {
        input: "De coalitie vorming zit in het slop.",
        output: {
            marked: "De |*s_0*|coalitie vorming|*e_0*| zit in het slop.",
            opmerkingen: [0, "coalitie vorming", "Dit zou een samenstelling kunnen zijn. Indien wel, schrijf:
coalitievorming"]
            ],
        }
    },
    debug: {
        timeneeded: 0.2031
    }
}

WERKWOORDSFOUTEN API

ALGEMEEN

Url: https://dev.schrijfhulp.be/v1/werkwoord/

status:
- message
  - type: string
  - wat: geeft statusboodschap terug: 'ok', 'wrong language', 'forbidden', 'too many characters' of 'too many calls'
- code
  - type: integer
  - wat: geeft statuscode terug: 200 (ok), 406 (wrong language), 403 (forbidden), 420 (too many characters) of 429 (too many calls)
aaneen:
- input
  - type: string
  - wat: herhaling van de geposte data
- output:
  - marked
    - type: string
    - wat: geeft de bewerkte tekst terug. Fouten bevinden zich tussen startmarker en endmarker.
  - opmerkingen
    - type: array
    - wat: index, opmerking
debug:
- timeneeded
  - type: integer
  - wat: geeft de totale tijd in seconden terug van de zoektocht naar suggesties.

OUTPUT

JSON-FORMAAT

{
    status: {
        message: string,
        code: integer
    },
    werkwoord: {
        input: string,
        output: {
            marked: string,
            opmerkingen: [
                array
            ]
        }
    },
    debug: {
        timeneeded: integer
    }
}

VOORBEELD

INPUT MET PHP CURL

$data = array(
    'key' => '1234-5678-ABCD-EFGH',
    'input' => 'De man starte zijn auto.'
);
$url = "https://dev.schrijfhulp.be/v1/werkwoord/";

$handle = curl_init($url);
curl_setopt($handle, CURLOPT_POST, true);
curl_setopt($handle, CURLOPT_POSTFIELDS, $data);
curl_setopt($handle, CURLOPT_RETURNTRANSFER, true);
return curl_exec($handle);

OUTPUT MET PHP CURL

{
    status: {
        message: "ok",
        code: 200
    },
    aaneen: {
        input: "De man starte zijn auto.",
        output: {
            marked: "De man |*s0_0*|starte|*e0_0*| de auto.",
            opmerkingen: [0, "Foutieve werkwoordsvorm: onvoltooid verleden tijd is startte."]
            ],
        }
    },
    debug: {
        timeneeded: 0.2031
    }
}

VOORBEELDEN

VOORBEELD 1: SUGGESTIES VOOR 1 WOORD

VOORBEELD 2: SPELLINGCHECKER MET SUGGESTIES

Opgelet: in deze testversie mag je tekst niet langer zijn dan 400 karakters

Status: wachten op input

VOORBEELD 3: AANEENSCHRIJVEN OF NIET

Opgelet: in deze testversie mag je tekst niet langer zijn dan 400 karakters

Status: wachten op input

VOORBEELD 4: WERKWOORDSFOUTEN

Opgelet: in deze testversie mag je tekst niet langer zijn dan 400 karakters

Status: wachten op input

CONTACT

Indien je interesse hebt om een API uit te proberen, stuur gerust een mail naar geert.peeters@kuleuven.be of ken.sevenants@kuleuven.be.