Цитирование
API Magisterium AI соответствует API OpenAI с несколькими добавлениями в объект ответа. Одно из добавлений - поле citations.
json
{
"object": "chat.completion",
"created": 1630000000,
"model": "magisterium-1",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "Учение Католической Церкви о вере и морали глубоко укоренено в Писании [...]",
},
"finish_reason": "stop",
},
],
"citations": [
{
"cited_text": "34. Учение Церкви по моральным вопросам основано не только на разуме и доводах, но также на Писании и христианской традиции [...]",
"document_title": "Любя жизнь",
"document_index": 0,
"document_author": "Конференция католических епископов Англии и Уэльса",
"document_reference": "34"
}
]
// другие поля ...
}Потоковая передача
Поле citations также включено, когда включена потоковая передача, но только в одном фрагменте, который является последним фрагментом, содержащим finish_reason.
Например:
json
{
"object": "chat.completion.chunk",
"choices": [
{
"index": 0,
"delta": {},
"finish_reason": "stop",
},
],
"citations": [
{
"cited_text": "34. Учение Церкви по моральным вопросам основано не только на разуме и доводах, но также на Писании и христианской традиции [...]",
"document_title": "Любя жизнь",
"document_index": 0,
"document_author": "Конференция католических епископов Англии и Уэльса",
"document_reference": "34"
}
]
// другие поля ...
}Схема
Поле citations является массивом объектов со следующими полями:
| Имя поля | Тип | Описание |
|---|---|---|
| cited_text | string | Текст, который был процитирован. |
| cited_text_heading | string / null | Ближайший заголовок данного цитирования. |
| document_title | string / null | Заголовок документа. |
| document_index | integer | Индекс документа в объекте ответа. Индекс начинается с нуля, тогда как нумерация сносок внутри текста начинается с единицы. |
| document_author | string / null | Автор документа. |
| document_year | string / null | Год публикации документа. |
| document_reference | string / null | Номер ссылки на цитату. |
| source_url | string | URL источника. |