التوثيقAPI v1
أقسام التوثيق

المعرفة ومراجعة المستندات

نظّم المستندات وتابع معالجتها وافصل المحتوى المعتمد عن سجلات الأعمال الحية.

أنشئ مجموعة معرفة

تجمع مجموعة المعرفة مستندات مترابطة. يمكن أن تبدأ بسياسة خدمة وإرشادات التعامل مع الاستثناءات. يتطلّب إنشاؤها صلاحية write وIdempotency-Key، بينما تتطلّب قراءتها صلاحية read المنفصلة.

curl -X POST "$MUWKL_BASE_URL/v1/collections" \
  -H "Authorization: Bearer $MUWKL_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $COLLECTION_REQUEST_ID" \
  -d '{"name":"Customer service policies"}'

اختر إعداد معالجة المستند

اقرأ ingestion-options للمجموعة قبل الرفع. استخدم embedding_profile_id وrepresentation من الخيارات المتاحة لبيئتك. التنسيقان المدعومان هما txt وmd؛ يحمل الطلب نصّ المصدر ولا يستخدم رفع ملفات multipart. ويظلّ حدّ حجم طلب الواجهة مطبّقًا.

يقبل POST /v1/collections/{collection_id}/documents عنوانًا وحقول الرفع ويعيد 202 مع مهمة معالجة. يستخدم TXT الحقل text_metadata للغة والصياغة وفئة الدعم والمرجع. اكتمال مهمة المعالجة لا يعتمد المستند.

curl "$MUWKL_BASE_URL/v1/collections/$COLLECTION_ID/ingestion-options" \
  -H "Authorization: Bearer $MUWKL_API_KEY"
الحقلالمعنى
source_formattxt | md
sourceنص المستند في جسم JSON
embedding_profile_idUUID من ingestion-options
representationالتمثيل الذي يدعمه الإعداد
text_metadata.supportspolicy | published_fee | warranty_term | general_information

راجع الإصدار المحدّد

تمرّ الإصدارات بحالات draft وapproved وsuperseded وwithdrawn. اقرأ review-packet للإصدار المقصود مع رقم مراجعة محتواه. تستخدم تعديلات المقاطع content_revision لرفض التعديلات المبنية على نسخة قديمة. تستطيع مفاتيح مساحة العمل إعداد المحتوى، لكنها لا تمنح صلاحية الاعتماد البشري.

استخدم المعرفة للسياسات المراجعة والمعلومات المنشورة. واستعلم من موصّل الأعمال عن الحالة الحالية لطلب أو التوفّر أو السجلات المتغيّرة الأخرى.

curl "$MUWKL_BASE_URL/v1/documents/$DOCUMENT_ID/versions/$VERSION/review-packet" \
  -H "Authorization: Bearer $MUWKL_API_KEY"

نقاط الوصول

MethodPathScope
GET / POST/v1/collectionsread / write
GET / POST/v1/collections/{id}/documentsread / write
GET/v1/collections/{id}/ingestion-optionsread
GET / POST/v1/documents/{id}/versionsread / write
GET/v1/documents/{id}/versions/{version}/review-packetread
GET/v1/documents/{id}/versions/{version}/jobs/{job_id}read
POST/v1/documents/{id}/versions/{version}/withdrawwrite