Citaties
Magisterium AI API voldoet aan de OpenAI API, met enkele aanvullingen in het antwoordobject. Een aanvulling is het citations-veld.
json
{
"object": "chat.completion",
"created": 1630000000,
"model": "magisterium-1",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "De leer van de rooms-katholieke kerk over geloof en moraal is diep geworteld in de Schrift [...]",
},
"finish_reason": "stop",
},
],
"citations": [
{
"cited_text": "34. De leer van de kerk over morele zaken is niet alleen gebaseerd op rede en argument, maar ook op de Schrift en de christelijke traditie [...]",
"document_title": "Het Leven Eren",
"document_index": 0,
"document_author": "Centrale Conferentie van Bisschoppen van Engeland en Wales",
"document_reference": "34"
}
]
// andere velden ...
}Streaming
Het citations-veld is ook opgenomen wanneer streaming is ingeschakeld, maar alleen in één chunk, namelijk de laatste chunk die finish_reason bevat.
Bijvoorbeeld:
json
{
"object": "chat.completion.chunk",
"choices": [
{
"index": 0,
"delta": {},
"finish_reason": "stop",
},
],
"citations": [
{
"cited_text": "34. De leer van de kerk over morele zaken is niet alleen gebaseerd op rede en argument, maar ook op de Schrift en de christelijke traditie [...]",
"document_title": "Het Leven Eren",
"document_index": 0,
"document_author": "Centrale Conferentie van Bisschoppen van Engeland en Wales",
"document_reference": "34"
}
]
// andere velden ...
}Schema
Het citations-veld is een array van objecten met de volgende velden:
| Veldnaam | Type | Beschrijving |
|---|---|---|
| cited_text | string | De tekst die werd geciteerd. |
| cited_text_heading | string / null | De dichtstbijzijnde kop van de gegeven verwijzing. |
| document_title | string / null | De titel van het document. |
| document_index | integer | De index van het document in het antwoordobject. Index is nul-gebaseerd, terwijl inline voetnoten nummering één-gebaseerd is. |
| document_author | string / null | De auteur van het document. |
| document_year | string / null | Het jaar waarin het document is gepubliceerd. |
| document_reference | string / null | Het referentienummer van de verwijzing. |
| source_url | string | De bron-URL. |