Cytaty
API Magisterium AI jest zgodne z API OpenAI, z kilkoma dodatkowymi elementami w obiekcie odpowiedzi. Jednym z dodatków jest pole citations.
json
{
"object": "chat.completion",
"created": 1630000000,
"model": "magisterium-1",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "Nauczanie Kościoła katolickiego w kwestiach wiary i moralności ma swoje głębokie korzenie w Piśmie Świętym [...]",
},
"finish_reason": "stop",
},
],
"citations": [
{
"cited_text": "34. Nauczanie Kościoła w kwestiach moralnych opiera się nie tylko na rozumie i argumentach, ale także na Piśmie Świętym i tradycji chrześcijańskiej [...]",
"document_title": "Cenienie Życia",
"document_index": 0,
"document_author": "Konferencja Episkopatu Anglii i Walii",
"document_reference": "34"
}
]
// other fields ...
}Streaming
Pole citations jest również dołączane, gdy streaming jest włączony, ale tylko w jednym kawałku, którym jest ostatni kawałek zawierający finish_reason.
Na przykład:
json
{
"object": "chat.completion.chunk",
"choices": [
{
"index": 0,
"delta": {},
"finish_reason": "stop",
},
],
"citations": [
{
"cited_text": "34. Nauczanie Kościoła w kwestiach moralnych opiera się nie tylko na rozumie i argumentach, ale także na Piśmie Świętym i tradycji chrześcijańskiej [...]",
"document_title": "Cenienie Życia",
"document_index": 0,
"document_author": "Konferencja Episkopatu Anglii i Walii",
"document_reference": "34"
}
]
// other fields ...
}Schemat
Pole citations jest tablicą obiektów zawierających następujące pola:
| Nazwa pola | Typ | Opis |
|---|---|---|
| cited_text | string | Tekst, który został zacytowany. |
| cited_text_heading | string / null | Najbliższy nagłówek danego cytatu. |
| document_title | string / null | Tytuł dokumentu. |
| document_index | integer | Indeks dokumentu w obiekcie odpowiedzi. Indeks zaczyna się od zera, podczas gdy numeracja przypisów wewnętrznych zaczyna się od jednego. |
| document_author | string / null | Autor dokumentu. |
| document_year | string / null | Rok publikacji dokumentu. |
| document_reference | string / null | Numer referencyjny cytatu. |
| source_url | string | URL źródłowy. |