cicora.ai
مواصفات APIمخرجات آمنة وفق المخطط

مخرجات منظّمة

اطلب كائن JSON أو JSON Schema عندما ستستهلك البرمجيات الاستجابة بدلًا من شخص.

مرجع التكامل: اختر المعلمات والإمكانات المتاحة من إعدادات API لحسابك ومن كتالوج النماذج لبيئتك.

ضبط response_format

يفيد وضع JSON لكائن بسيط. يضيف JSON Schema اسم مخطط وبنية حقول وخصائص مطلوبة وطريقة لرفض الخصائص الزائدة.

يقلل المخطط الصارم الحاجة إلى التحليل الدفاعي، لكنه لا يحل محل التحقق من جهة التطبيق مطلقًا.

تنسيق الاستجابة بـ JSON Schema
json
{
  "model": "openai/gpt-5.6-sol",
  "messages": [{"role": "user", "content": "Extract an order summary."}],
  "response_format": {
    "type": "json_schema",
    "json_schema": {
      "name": "order_summary",
      "strict": true,
      "schema": {
        "type": "object",
        "properties": {"items": {"type": "array"}, "total": {"type": "number"}},
        "required": ["items", "total"],
        "additionalProperties": false
      }
    }
  }
}

تصميم المخطط

  • أبقِ الحقول والأوصاف موجزة ومحددة للمجال.
  • اضبط additionalProperties: false عندما لا تكون الحقول غير المعروفة مقبولة.
  • ضع أرقام إصدارات للمخططات في تعليماتك البرمجية بدلًا من تغيير عقد الواجهة مع الأنظمة المستهلكة لها من دون إعلان.

معالجة النتيجة

تحقق من JSON المعاد باستخدام المدقق نفسه الذي تستخدمه API أو قاعدة بياناتك.

إذا كان نموذج أو مسار لا يقبل التنسيق المطلوب، فأظهر خطأ مضبوطًا واختر خيارًا متوافقًا عبر كتالوج النماذج.