מסמך זה תורגם על ידי בינה מלאכותית. לכל אי דיוק, אנא עיין בגרסה האנגלית
ModelDefinition מגדיר את אפשרויות היצירה עבור מודל זרימה (flow model), המשמש ליצירת מופע מודל (model instance) באמצעות שיטת FlowEngine.createModel(). הוא כולל את התצורה הבסיסית של המודל, מאפיינים, תת-מודלים ומידע נוסף.
סוג: string
נדרש: לא
תיאור: מזהה ייחודי (UID) עבור מופע המודל.
אם לא סופק, המערכת תיצור UID ייחודי באופן אוטומטי.
דוגמה:
סוג: RegisteredModelClassName | ModelConstructor
נדרש: כן
תיאור: מחלקת המודל לשימוש.
יכול להיות מחרוזת של שם מחלקת מודל רשומה, או פונקציית הבנאי של מחלקת המודל.
דוגמה:
סוג: IModelComponentProps
נדרש: לא
תיאור: תצורת המאפיינים עבור המודל.
אובייקט המאפיינים המועבר לפונקציית הבנאי של המודל.
דוגמה:
סוג: StepParams
נדרש: לא
תיאור: תצורת פרמטרים עבור שלבים.
מגדיר פרמטרים עבור כל שלב בתוך תהליך העבודה (flow).
דוגמה:
סוג: Record<string, CreateSubModelOptions[]>
נדרש: לא
תיאור: תצורת תת-מודלים.
מגדיר את תת-המודלים של המודל, ותומך הן במערך והן בתת-מודל יחיד.
דוגמה:
סוג: string
נדרש: לא
תיאור: ה-UID של מודל האב.
משמש ליצירת קשר הורה-ילד בין מודלים.
דוגמה:
סוג: string
נדרש: לא
תיאור: שם המפתח של תת-המודל במודל האב.
משמש לזיהוי מיקום תת-המודל בתוך מודל האב.
דוגמה:
סוג: 'array' | 'single'
נדרש: לא
תיאור: טיפוס תת-המודל.
'array': תת-מודל מסוג מערך, שיכול להכיל מספר מופעים.'single': תת-מודל יחיד, שיכול להכיל מופע אחד בלבד.דוגמה:
סוג: number
נדרש: לא
תיאור: אינדקס מיון.
משמש לשליטה על סדר התצוגה של המודל ברשימה.
דוגמה:
סוג: Record<string, Omit<FlowDefinitionOptions, 'key'>>
נדרש: לא
תיאור: רישום תהליכי עבודה (Flow registry).
רושם הגדרות ספציפיות של תהליכי עבודה עבור מופע המודל.
דוגמה: