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 או מסד הנתונים שלכם.

אם מודל או נתיב אינם מקבלים את התבנית המבוקשת, הציגו שגיאה מבוקרת ובחרו אפשרות תואמת דרך קטלוג המודלים.