Citazioni
L'API di Magisterium AI si conforma all'API di OpenAI, con alcune aggiunte nell'oggetto di risposta. Un'aggiunta è il campo citations.
json
{
"object": "chat.completion",
"created": 1630000000,
"model": "magisterium-1",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "L'insegnamento della Chiesa cattolica sulla fede e la morale è profondamente radicato nella Scrittura [...]",
},
"finish_reason": "stop",
},
],
"citations": [
{
"cited_text": "34. L'insegnamento della Chiesa su questioni morali si basa non solo sulla ragione e sull'argomentazione, ma anche sulla Scrittura e sulla tradizione cristiana [...]",
"document_title": "Cherishing Life",
"document_index": 0,
"document_author": "Conferenza dei Vescovi Cattolici d'Inghilterra e Galles",
"document_reference": "34"
}
]
// other fields ...
}Streaming
Il campo citations è incluso anche quando lo streaming è abilitato, ma solo su un chunk, che è l'ultimo chunk che include finish_reason.
Ad esempio:
json
{
"object": "chat.completion.chunk",
"choices": [
{
"index": 0,
"delta": {},
"finish_reason": "stop",
},
],
"citations": [
{
"cited_text": "34. L'insegnamento della Chiesa su questioni morali si basa non solo sulla ragione e sull'argomentazione, ma anche sulla Scrittura e sulla tradizione cristiana [...]",
"document_title": "Cherishing Life",
"document_index": 0,
"document_author": "Conferenza dei Vescovi Cattolici d'Inghilterra e Galles",
"document_reference": "34"
}
]
// other fields ...
}Schema
Il campo citations è un array di oggetti con i seguenti campi:
| Nome del Campo | Tipo | Descrizione |
|---|---|---|
| cited_text | string | Il testo citato. |
| cited_text_heading | string / null | Il titolo più vicino della citazione fornita. |
| document_title | string / null | Il titolo del documento. |
| document_index | integer | L'indice del documento nell'oggetto di risposta. L'indice è basato su zero, mentre la numerazione delle note a piè di pagina in linea è basata su uno. |
| document_author | string / null | L'autore del documento. |
| document_year | string / null | L'anno di pubblicazione del documento. |
| document_reference | string / null | Il numero di riferimento della citazione. |
| source_url | string | L'URL di origine. |