פרמטרים של Playbook

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

הצהרת פרמטרים

אפשר להגדיר פרמטרים של קלט (קריאה) ופרמטרים של פלט (כתיבה).

לפרמטרים יש שם, תיאור ואחד מהסוגים הבאים:

• String
• מספר
• בוליאני
• סוג פרמטר ספציפי לכלי

אפשר גם לציין אם הפרמטר הוא רשימה.

פרמטרים של קלט (קריאה)

לכל פלייבוק אפשר להגדיר פרמטרים של קלט, שנקראים גם פרמטרים של קריאה, שמאפשרים לפלייבוקים להשתמש בערכים שמועברים מתהליכים ומפלייבוקים אחרים. לדוגמה, פלייבוק יכול לקבל את השם המועדף של המשתמש כפרמטר ולהשתמש בו כדי להודות למשתמש באופן אישי, או לקבל מזהה הזמנה כפרמטר ולהשתמש בו כדי לאחזר את פרטי ההזמנה באמצעות כלי.

פרמטרים של קלט מוגדרים לכל playbook, ול-playbooks אין גישה כברירת מחדל לסוגי פרמטרים אחרים של מסוף Dialogflow CX. כשמתבצע מעבר מתרחיש שיחה ל-Playbook, הפרמטרים של הדף והסשן מועברים ל-Playbook אם ב-Playbook היעד יש פרמטר קלט עם אותו שם. כדי להעביר מידע מתהליך ל-Playbook במהלך מעבר, מגדירים פרמטרים של קלט ב-Playbook עם אותו שם כמו פרמטר של סשן או דף שקיים לפני המעבר.

הערה: הפלייבוק שמוגדר כברירת מחדל לא מקבל פרמטרים של קלט כי הוא משמש כנקודת כניסה לשיחות של משתמשים ואין לו דרך לקבל אותם.

צרו דוגמאות כדי לקבוע איך ערך הפרמטר של הקלט ישפיע על הפעולות. לדוגמה, אם פרמטר קלט אמור להשפיע על האופן שבו הנציג מתייחס למשתמש, יוצרים דוגמאות שמגדירות ערך לפרמטר ואז משתמשים באותו ערך בפעולות של אמירות בדוגמה. מידע נוסף זמין במאמר העברת פרמטרים.

פרמטרים של פלט (כתיבה, החזרה)

לכל פלייבוק אפשר להגדיר פרמטרים של פלט, שנקראים גם פרמטרים של כתיבה ופרמטרים של החזרה. הפרמטרים האלה מאפשרים לפלייבוקים להפיק מידע שישמש תהליכים או פלייבוקים אחרים. לדוגמה, פלייבוק יכול לאסוף מספר הזמנה ממשתמש ולשלוח אותו דרך פרמטר פלט, או להשתמש בכלי כדי להזמין טיסה ולשלוח את מספר האישור דרך פרמטר פלט.

יוצרים דוגמאות כדי לקבוע איך הפלייבוקים יקבעו את הערך של כל פרמטר פלט. לדוגמה, אם פרמטר פלט שמייצג מספר אישור מקבל את הערך שלו מפלט של שימוש בכלי, צריך ליצור דוגמאות שבהן הפלט של הכלי תואם לערך של פרמטר הפלט של הפלייבוק.

העברת פרמטרים

הערה: פלייבוק למשימה לא יכול להפעיל פלייבוק לתרחיש חוזר, לכן התרחיש הזה של העברת פרמטרים לא מתואר בקטעים הבאים.

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

פלייבוק לתרחיש חוזר ל-Flow

כדי להעביר פרמטרים מפלייבוק לתרחיש חוזר לתהליך:

• מגדירים פרמטרים לכתיבה בפלייבוק לתרחיש חוזר, שהופכים לפרמטרים של סשן כשהפלייבוק לתרחיש חוזר מסתיים.
• משתמשים בפרמטרים של הסשן בתהליכים.
• לכלול בהוראות ובדוגמאות את השימוש בפרמטרים.

מעבר לפלייבוק לתרחיש חוזר

כדי להעביר פרמטרים מתהליך לפלייבוק לתרחיש חוזר:

• כותבים את הפרמטרים של הסשן מהתהליך.
• מגדירים פרמטרים לקריאה של הפלייבוק לתרחיש חוזר עם אותם שמות.
• לכלול בהוראות ובדוגמאות את השימוש בפרמטרים.

פלייבוק של משימה לתהליך

כדי להעביר פרמטרים מ-Playbook של משימה לתהליך:

• בהגדרות התהליך, מגדירים פרמטרים של קלט עם אותם שמות.
• לכלול בהוראות ובדוגמאות את השימוש בפרמטרים.

פלייבוק למעבר מתהליך למשימה

כדי להעביר פרמטרים מתהליך לפלייבוק של משימת הורה:

• בהגדרות התהליך, מגדירים פרמטרים להחזרה.
• לכלול בהוראות ובדוגמאות את השימוש בפרמטרים.

כדי להעביר פרמטרים מתהליך לפלייבוק של משימת צאצא:

• מגדירים פרמטרים של קלט למשימה ב-Playbook של המשימה, עם אותו שם כמו הפרמטרים של הסשן בתהליך.
• לכלול בהוראות ובדוגמאות את השימוש בפרמטרים.

פלייבוק לתרחיש חוזר לפלייבוק למשימה

כדי להעביר פרמטרים מפלייבוק לתרחיש חוזר לפלייבוק למשימה:

• מגדירים פרמטרים של קלט לפלייבוק של המשימה באמצעות אותם שמות.
• לכלול בהוראות ובדוגמאות את השימוש בפרמטרים.

דוגמה שכוללת כלים

נניח שיש לכם נציג שמיועד למכירת כרטיסים לאירועים, עם הפלייבוקים הבאים:

• פלייבוק בשם Ticket ordering שמבצע הזמנות באמצעות כלי בשם Ticket sales API.
  • הפלייבוק הזה מקבל פרמטר קלט מסוג number בשם event_id.
  • הכלי Ticket sales API מצפה לבקשה שכוללת event_id.
• פלייבוק בשם Event selection שעוזר למשתמשים לבחור אירוע ואז מפנה אותם אל Ticket ordering עם הפרמטר event_id כדי לרכוש כרטיסים.

בדוגמה הזו, כדי לוודא ש-event_id מועבר באופן מהימן מ-Event selection ל-Ticket ordering ומ-Ticket ordering ל-Ticket sales API, צריך כמה דוגמאות.

הפלייבוק של Ticket ordering צריך לכלול כמה דוגמאות:

• ציינו ערך מציאותי לפרמטר הקלט event_id, שיהיה שונה בכל דוגמה.
• כוללים פעולה של שימוש בכלי עם גוף בקשה שמכיל את אותו ערך event_id מציאותי שצוין בפרמטר הקלט.

הפלייבוק של Event selection צריך לכלול כמה דוגמאות:

• צריך לכלול ביטוי של משתמש שבו נבחר אירוע עם event_id מציאותי, עם מזהה שונה בכל דוגמה.
• מוסיפים הפעלה של Playbook של Ticket ordering שמגדירה את הפרמטר event_id לאותו event_id ריאליסטי שנקבע לפי הבחירה.

בנוסף להוספת דוגמאות, הוסיפו הוראות ספציפיות להוראות, ליעד או לפרטי הכלי שמסבירות איך להשתמש בפרמטרים.

לדוגמה, הפלייבוק Ticket ordering יכול לכלול את ההוראה הבאה:

- Use parameter event_id to send a buy_tickets request with ${TOOL: Ticket sales API}

בעזרת הדוגמאות וההוראות שמתוארות, Event selectionPlaybook מחליט בצורה נכונה על event_id על סמך הבחירה של המשתמש ומעביר אותו כפרמטר קלט בשם event_id אל Ticket ordering Playbook. לאחר מכן, Ticket ordering מעביר את אותו event_id בגוף הבקשה אל Ticket sales API. פלייבוקים מסתמכים על דוגמאות עם ערכי פרמטרים נפרדים כדי להסיק איך משתמשים בפרמטרים.