Citations
L'API Magisterium AI est conforme à l'API OpenAI, avec quelques ajouts dans l'objet de réponse. Un ajout est le champ citations.
json
{
"object": "chat.completion",
"created": 1630000000,
"model": "magisterium-1",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "L'enseignement de l'Église catholique sur la foi et la morale est profondément ancré dans l'Écriture [...]",
},
"finish_reason": "stop",
},
],
"citations": [
{
"cited_text": "34. L'enseignement de l'Église sur les questions morales est fondé non seulement sur la raison et l'argumentation, mais aussi sur l'Écriture et la tradition chrétienne [...]",
"document_title": "Chérir la vie",
"document_index": 0,
"document_author": "Conférence des Évêques Catholiques d'Angleterre et du pays de Galles",
"document_reference": "34"
}
]
// autres champs ...
}Streaming
Le champ citations est également inclus lorsque le streaming est activé, mais uniquement dans un morceau, qui est le dernier morceau contenant finish_reason.
Par exemple :
json
{
"object": "chat.completion.chunk",
"choices": [
{
"index": 0,
"delta": {},
"finish_reason": "stop",
},
],
"citations": [
{
"cited_text": "34. L'enseignement de l'Église sur les questions morales est fondé non seulement sur la raison et l'argumentation, mais aussi sur l'Écriture et la tradition chrétienne [...]",
"document_title": "Chérir la vie",
"document_index": 0,
"document_author": "Conférence des Évêques Catholiques d'Angleterre et du pays de Galles",
"document_reference": "34"
}
]
// autres champs ...
}Schéma
Le champ citations est un tableau d'objets avec les champs suivants :
| Nom du champ | Type | Description |
|---|---|---|
| cited_text | string | Le texte qui a été cité. |
| cited_text_heading | string / null | Le titre le plus proche de la citation donnée. |
| document_title | string / null | Le titre du document. |
| document_index | integer | L'index du document dans l'objet de réponse. L'index commence à zéro, tandis que la numérotation des notes de bas de page en ligne commence à un. |
| document_author | string / null | L'auteur du document. |
| document_year | string / null | L'année de publication du document. |
| document_reference | string / null | Le numéro de référence de la citation. |
| source_url | string | L'URL source. |