المصطلحات القياسية

مصطلحات موحدة وقواعد التسمية لوثائق Rememberizer

يقدم هذا المستند مرجعًا للمصطلحات المفضلة للاستخدام عند مناقشة ميزات ومفاهيم برنامج Rememberizer. يساعد اتباع هذه المعايير في الحفاظ على الاتساق عبر الوثائق.

المصطلحات والتعريفات المفضلة

المصطلح المفضل	المصطلحات البديلة	التعريف
متجر المتجهات	قاعدة بيانات المتجهات	المصطلح المفضل لتنفيذ قاعدة بيانات المتجهات الخاصة بـ Rememberizer هو "متجر المتجهات". بينما "قاعدة بيانات المتجهات" دقيقة من الناحية التقنية، يجب استخدام "متجر المتجهات" من أجل التناسق.
تضمينات المتجهات	التضمينات	المصطلح الكامل "تضمينات المتجهات" مفضل في المحتوى التعليمي، بينما "التضمينات" مقبول في السياقات التقنية وأمثلة الشيفرة.
مصدر البيانات	مصدر المعرفة، التكامل	"مصدر البيانات" هو المصطلح المفضل للإشارة إلى أصول البيانات (Slack، Google Drive، إلخ).
المعرفة المشتركة	المعرفة المتبادلة	استخدم "المعرفة المشتركة" عند الإشارة إلى الميزة التي تسمح بمشاركة المعرفة مع مستخدمين وتطبيقات أخرى.
ميمنتو	فلتر ميمنتو	استخدم "ميمنتو" كالمصطلح الأساسي، على الرغم من أن "فلتر ميمنتو" مقبول في سياقات واجهة المستخدم.
تكامل الذاكرة	الذاكرة المشتركة، الذاكرة	"تكامل الذاكرة" هو الاسم الكامل المفضل للميزة؛ "الذاكرة المشتركة" مقبول في المحتوى الموجه للمستخدمين.
مصادقة OAuth2	OAuth	استخدم المصطلح الكامل "مصادقة OAuth2" في الوثائق الرسمية، على الرغم من أن "OAuth" مقبول في السياقات الأقل رسمية.
ابحث في معرفتك	البحث في Rememberizer	يجب استخدام "ابحث في معرفتك" عند الإشارة إلى اسم الميزة في العناوين والتنقل.
احفظ	متجر	استخدم "احفظ" لنقطة النهاية الخاصة بواجهة برمجة التطبيقات واسم الوظيفة، بينما يمكن استخدام "متجر" في السياقات التفسيرية.
X-API-Key	x-api-key	استخدم "X-API-Key" بحروف كبيرة في الوثائق، على الرغم من أن الحروف الصغيرة مقبولة في أمثلة الشيفرة.

تقاليد واجهة برمجة التطبيقات

دليل توثيق واجهة البرمجة

المسار الرسمي لتوثيق واجهة البرمجة هو /en/developer/api-docs/. يجب التخلص من المسار القديم /en/developer/api-documentations/.

رؤوس واجهة برمجة التطبيقات

يجب استخدام التقاليد التالية للرؤوس بشكل متسق:

• رأس التفويض: Authorization: Bearer YOUR_JWT_TOKEN

• رأس مفتاح واجهة برمجة التطبيقات: X-API-Key: YOUR_API_KEY

• رأس نوع المحتوى: Content-Type: application/json

تنسيق نقاط نهاية واجهة برمجة التطبيقات

يجب تنسيق نقاط نهاية واجهة برمجة التطبيقات بشكل متسق:

• عنوان URL الأساسي: https://api.rememberizer.ai/api/v1/

• مسارات النقاط النهائية بحروف صغيرة مع استخدام الشرطات حسب الحاجة: /documents/search/

• مسارات تخزين المتجهات مع عنصر نائب للمعامل: /vector-stores/{vector_store_id}/documents/search

قواعد تسمية الميزات

أسماء التكامل

يجب أن تتبع أسماء التكامل النمط التالي:

• تكامل Rememberizer {اسم التكامل} (على سبيل المثال، "تكامل Rememberizer Slack")

تسمية خادم MCP

يجب تمييز أنواع خوادم MCP بوضوح:

• خادم MCP Rememberizer: خادم متعدد الأغراض

• خادم MCP لمخزن المتجهات Rememberizer: خادم مخصص لعمليات مخزن المتجهات

تقاليد عناوين الوثائق

يجب أن تتبع عناوين الوثائق هذه التقاليد:

• كتابة الكلمات المهمة بحروف كبيرة (حالة العنوان)

• استخدام مصطلحات متسقة للميزات

• تجنب الاختصارات في العناوين ما لم تكن معروفة على نطاق واسع (مثل API)

• الحفاظ على العناوين مختصرة ووصفية

استخدام هذا الدليل

عند إنشاء أو تحديث الوثائق، يرجى الرجوع إلى هذا الدليل لضمان استخدام مصطلحات متسقة. عند مواجهة مصطلحات متغيرة في الوثائق، يجب إعطاء الأولوية لتحديثها إلى المصطلحات المفضلة المدرجة هنا عند إجراء تغييرات أخرى على تلك الوثائق.

تذكر أن الحفاظ على سلامة الروابط وأسماء الملفات أمر بالغ الأهمية، لذا ركز على تحديث المصطلحات داخل النص مع الحفاظ على عناوين URL وهياكل الملفات.