Citações
A API do Magisterium AI está em conformidade com a API da OpenAI, com algumas adições no objeto de resposta. Uma adição é o campo citations (citações).
json
{
"object": "chat.completion",
"created": 1630000000,
"model": "magisterium-1",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "O ensinamento da Igreja Católica sobre fé e moral está profundamente enraizado nas Escrituras [...]",
},
"finish_reason": "stop",
},
],
"citations": [
{
"cited_text": "34. O ensinamento da Igreja em matéria moral funda-se não só na razão e no argumento, mas também na Escritura e na tradição cristã [...]",
"document_title": "Cherishing Life",
"document_index": 0,
"document_author": "Catholic Bishops’ Conference of England and Wales",
"document_reference": "34"
}
]
// outros campos ...
}Streaming
O campo citations também é incluído quando o stream está ativado, mas apenas em um chunk, que é o último chunk que inclui finish_reason.
Por exemplo:
json
{
"object": "chat.completion.chunk",
"choices": [
{
"index": 0,
"delta": {},
"finish_reason": "stop",
},
],
"citations": [
{
"cited_text": "34. O ensinamento da Igreja em matéria moral funda-se não só na razão e no argumento, mas também na Escritura e na tradição cristã [...]",
"document_title": "Cherishing Life",
"document_index": 0,
"document_author": "Catholic Bishops’ Conference of England and Wales",
"document_reference": "34"
}
]
// outros campos ...
}Esquema
O campo citations é um array de objetos com os seguintes campos:
| Nome do Campo | Tipo | Descrição |
|---|---|---|
| cited_text | string | O texto que foi citado. |
| cited_text_heading | string / null | O cabeçalho mais próximo da citação fornecida. |
| document_title | string / null | O título do documento. |
| document_index | integer | O índice do documento no objeto de resposta. O índice é baseado em zero, enquanto a numeração das notas de rodapé inline é baseada em um. |
| document_author | string / null | O autor do documento. |
| document_year | string / null | O ano em que o documento foi publicado. |
| document_reference | string / null | O número de referência da citação. |
| source_url | string | A URL de origem. |