Trích Dẫn
API Magisterium AI tuân thủ API của OpenAI, với một vài bổ sung trong đối tượng phản hồi. Một bổ sung là trường citations.
json
{
"object": "chat.completion",
"created": 1630000000,
"model": "magisterium-1",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "Giáo huấn của Giáo hội Công giáo về đức tin và đạo đức được sâu sắc gắn liền với Kinh Thánh [...]",
},
"finish_reason": "stop",
},
],
"citations": [
{
"cited_text": "34. Giáo huấn của Giáo hội về các vấn đề đạo đức không chỉ dựa trên lý do và lập luận, mà còn dựa trên Kinh Thánh và truyền thống Kitô giáo [...]",
"document_title": "Trân quý sự sống",
"document_index": 0,
"document_author": "Hội nghị Giám mục Công giáo Anh và xứ Wales",
"document_reference": "34"
}
]
// other fields ...
}Phát trực tiếp
Trường citations cũng được bao gồm khi phát trực tiếp được bật, nhưng chỉ ở một phần, đó là phần cuối cùng chứa finish_reason.
Ví dụ:
json
{
"object": "chat.completion.chunk",
"choices": [
{
"index": 0,
"delta": {},
"finish_reason": "stop",
},
],
"citations": [
{
"cited_text": "34. Giáo huấn của Giáo hội về các vấn đề đạo đức không chỉ dựa trên lý do và lập luận, mà còn dựa trên Kinh Thánh và truyền thống Kitô giáo [...]",
"document_title": "Trân quý sự sống",
"document_index": 0,
"document_author": "Hội nghị Giám mục Công giáo Anh và xứ Wales",
"document_reference": "34"
}
]
// other fields ...
}Sơ đồ
Trường citations là một mảng các đối tượng với các trường sau:
| Tên trường | Loại | Mô tả |
|---|---|---|
| cited_text | string | Văn bản đã được trích dẫn. |
| cited_text_heading | string / null | Tiêu đề gần nhất của trích dẫn đã cho. |
| document_title | string / null | Tiêu đề của tài liệu. |
| document_index | integer | Chỉ số của tài liệu trong đối tượng phản hồi. Chỉ số bắt đầu từ 0, trong khi đánh số chú thích inline bắt đầu từ 1. |
| document_author | string / null | Tác giả của tài liệu. |
| document_year | string / null | Năm tài liệu được xuất bản. |
| document_reference | string / null | Số tham chiếu của trích dẫn. |
| source_url | string | URL nguồn. |