Citace
Magisterium AI API je v souladu s OpenAI API, s několika přídavky v objektu odpovědi. Jeden z přídavků je pole citations.
json
{
"object": "chat.completion",
"created": 1630000000,
"model": "magisterium-1",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "Učení Katolické církve o víře a morálce je hluboce zakořeněno v Písmu [...]",
},
"finish_reason": "stop",
},
],
"citations": [
{
"cited_text": "34. Učení církve o morálních otázkách je založeno nejen na rozumu a argumentech, ale také na Písmu a křesťanské tradici [...]",
"document_title": "Ochrana života",
"document_index": 0,
"document_author": "Konference katolických biskupů Anglie a Walesu",
"document_reference": "34"
}
]
// other fields ...
}Streaming
Pole citations je také zahrnuto, když je povolen streaming, ale pouze v jednom bloku, což je poslední blok, který zahrnuje finish_reason.
Například:
json
{
"object": "chat.completion.chunk",
"choices": [
{
"index": 0,
"delta": {},
"finish_reason": "stop",
},
],
"citations": [
{
"cited_text": "34. Učení církve o morálních otázkách je založeno nejen na rozumu a argumentech, ale také na Písmu a křesťanské tradici [...]",
"document_title": "Ochrana života",
"document_index": 0,
"document_author": "Konference katolických biskupů Anglie a Walesu",
"document_reference": "34"
}
]
// other fields ...
}Schéma
Pole citations je pole objektů s následujícími poli:
| Název pole | Typ | Popis |
|---|---|---|
| cited_text | string | Text, který byl citován. |
| cited_text_heading | string / null | Nejbližší nadpis dané citace. |
| document_title | string / null | Název dokumentu. |
| document_index | integer | Index dokumentu v objektu odpovědi. Index začíná na nule, zatímco číslování inline poznámek je založeno na jedničce. |
| document_author | string / null | Autor dokumentu. |
| document_year | string / null | Rok, kdy byl dokument publikován. |
| document_reference | string / null | Referenční číslo citace. |
| source_url | string | Zdrojová URL. |