المراجع
واجهة برمجة التطبيقات Magisterium AI تتوافق مع واجهة برمجة تطبيقات 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": "Cherishing Life",
"document_index": 0,
"document_author": "مجلس الأساقفة الكاثوليك في إنجلترا وويلز",
"document_reference": "34"
}
]
// other fields ...
}تدفق البيانات
يتم تضمين حقل citations أيضًا عند تمكين التدفق، ولكن فقط في جزء واحد، وهو الجزء الأخير الذي يتضمن finish_reason.
على سبيل المثال:
json
{
"object": "chat.completion.chunk",
"choices": [
{
"index": 0,
"delta": {},
"finish_reason": "stop",
},
],
"citations": [
{
"cited_text": "34. تعليم الكنيسة في المسائل الأخلاقية ليس فقط مؤسسًا على العقل والحجة، ولكن أيضًا على الكتاب المقدس والتقاليد المسيحية [...]",
"document_title": "Cherishing Life",
"document_index": 0,
"document_author": "مجلس الأساقفة الكاثوليك في إنجلترا وويلز",
"document_reference": "34"
}
]
// other fields ...
}المخطط
حقل citations هو مصفوفة من الكائنات تحتوي على الحقول التالية:
| اسم الحقل | النوع | الوصف |
|---|---|---|
| cited_text | string | النص الذي تم اقتباسه. |
| cited_text_heading | string / null | العنوان الأقرب للاقتباس المعطى. |
| document_title | string / null | عنوان الوثيقة. |
| document_index | integer | فهرس الوثيقة في كائن الاستجابة. الفهرس يبدأ من 0، بينما ترقيم الهوامش التوضيحية يبدأ من 1. |
| document_author | string / null | مؤلف الوثيقة. |
| document_year | string / null | السنة التي تم نشر الوثيقة فيها. |
| document_reference | string / null | رقم المرجع للاقتباس. |
| source_url | string | عنوان URL المصدر. |