מחברים של אירועים מותאמים אישית ומודולים מותאמים אישית של ממשק משתמש

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

לדוגמה, כשמתקבלת הצעה מ-Agent Assist, שירות מחבר של מודול ממשק משתמש ישלח אירוע analyze-content-received למודולים של ממשק המשתמש, והמודולים רשומים לאירועים כאלה.

פרטים של אירועים בהתאמה אישית

רשימה מלאה של אירועים במודול ממשק המשתמש והמטען הייעודי (payload) שלהם מופיעה במאמרי העזרה בנושא UI module events API.

כדי לשלוח אירוע מותאם אישית באופן ידני, משתמשים בתחביר הבא:

    dispatchAgentAssistEvent('event_name', {
      detail: event_payload,
    });

בדוגמה הבאה אפשר לראות איך שולחים את האירוע analyze-content-received:

if (newMessageFromHumanAgent) {
  dispatchAgentAssistEvent('analyze-content-received', {
    detail: {
      participantRole: 'HUMAN_AGENT',
      request: {
        textInput: {text: newMessageFromHumanAgent},
        messageSendTime: new Date().toISOString()
      }
    }
  });
}

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

    this.api.analyzeContent(...).then(function (response) {
      dispatchAgentAssistEvent('analyze-content-response-received', {
       detail: {response: response}});
    });

במודול יוצגו האפשרויות הבאות:

    addAgentAssistEventListener('analyze-content-response-received', function (event) {
      // Use the AnalyzeContent response to render suggestions in the UI.
    });

כדי להירשם לאירוע מותאם אישית באופן ידני, משתמשים בתחביר הבא:

    addAgentAssistEventListener('event_name', function (event) {
      // `event.detail` contains the event payload.
    });

בדוגמה הבאה מוצג מינוי לאירוע בהתאמה אישית:

addAgentAssistEventListener('smart-reply-selected', function (event) {
  var chipContent = event.details;
  // Populate the agent chat box with the selected Smart Reply chip.
});

מחברים של מודולים של ממשק משתמש בהתאמה אישית

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

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

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

  1. שליחת אירוע כדי לבחור את השיחה הפעילה. הפעולה הזו תפעיל את השיחה עם המשתתפים. שם האירוע: active-conversation-selected
  2. לשיחות בצ'אט, שליחת אירוע בכל פעם שנרשמת אמירה חדשה מהסוכן או מהלקוח. שם האירוע: analyze-content-requested
  3. הודעה למערכת המודולים כשמפעילים או משביתים את 'מצב כהה' באפליקציה הראשית. שם האירוע: dark-mode-toggled
  4. שליחת אירוע כדי לבקש לסמן את השיחה כהושלמה בשרת העורפי. שם האירוע: complete-conversation-requested

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

  1. במקרה של Smart Reply, מעדכנים את שדה להזנת קלט של הנציג בכל פעם שנבחר צ'יפ של Smart Reply. שם האירוע: smart-reply-selected.
  2. במקרה של הצעות לתשובות ב-Agent Assist, צריך לעדכן את שדה הקלט של הסוכן בכל פעם שמדביקים תשובה של Agent Assist בתיבת הקלט. שם האירוע: knowledge-assist-v2-answer-pasted.

אתחול של כמה מופעים של מודולים של ממשק משתמש באמצעות namespace

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

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

const connector = new UiModulesConnector();
const config = {};
// ...other UI module connector config options
config.uiModuleEventOptions = { namespace: this.recordId }

const companionAgentElement = document.createElement("agent-assist-companion-agent");
// ...other UI modules HTML attributes
companionAgentElement.setAttribute("namespace", this.recordId);