OpenAPI وllms.txt
أوصاف للـ API قابلة للقراءة آليًا.
ملفان يصفان الـ API بصيغة قابلة للقراءة آليًا: openapi.json لمولّدات الكود وعملاء الـ API، وllms.txt لوكلاء الذكاء الاصطناعي.
openapi.json
تصف المواصفة بصيغة OpenAPI 3.0 نقاط النهاية مع معاملاتها الرئيسية والاستجابات والأخطاء والمصادقة. وتغطي أيضًا الأحداث التي ترسلها webhooks. وفي كل تفصيل يكون هذا التوثيق هو المرجع.
URL
https://handelsregister.ai/openapi.json
كيف تستخدمها:
- بمولّد مثل OpenAPI Generator تنشئ عميلًا محدد الأنواع للغتك.
- استورد الملف إلى Postman أو Insomnia أو Bruno لتكون جميع الطلبات في متناولك فورًا.
- تبني أطر عمل الوكلاء من الملف تعريفات أدوات لنموذج لغوي.
افتح الـ URL في متصفحك، واحفظ الملف، واستورده.
ضمن الإصدار 1 تُضاف حقول وقيم جديدة وتبقى الموجودة. ابنِ عميلك بحيث يتجاهل الحقول غير المعروفة. المزيد في سجل التغييرات.
llms.txt
يلخّص llms.txt الـ API كنص قصير للنماذج اللغوية: نقاط النهاية والمعاملات والميزات والأسعار وأهم القواعد.
URL
https://handelsregister.ai/llms.txt
أعطِ الـ URL لوكيل الذكاء الاصطناعي قبل أن يكتب كودًا للـ API. وبذلك يعرف الأسماء الحقيقية للمعاملات وحقول الاستجابة.