Container V1

בדף הזה מופיעים מאמרי העזרה של ה-API של שיטת הקונטיינר להטמעה של מודולים של ממשק משתמש. אלה התכונות של Agent Assist שאפשר להטמיע כרכיבים במאגר התגים.

מאפיינים

שם המאפיין סוג תגובה
מאפיינים מחרוזת רשימה מופרדת בפסיקים של מפתחות של תכונות הצעות ב-Agent Assist לעיבוד. דוגמה: "SMART_REPLY, CONVERSATION_SUMMARIZATION"
api-headers מחרוזת כותרות נוספות שייכללו בקריאות ל-Dialogflow API. דוגמה: "Content-Type:application/json, Accept:application/json"
conversation-profile מחרוזת השם של פרופיל השיחה שבו רוצים להשתמש.
agent-desktop AgentDesktop תוכנת שולחן עבודה של סוכן לשילוב.
auth-token מחרוזת טוקן אימות לשימוש בקריאות ל-API.
api-key מחרוזת מפתח API אופציונלי לשימוש בקריאות ל-API.
ערוץ CommunicationChannel ערוץ התקשורת שבו נעשה שימוש באפליקציה הזו (צ'אט, קול או רב-ערוצי).
custom-api-endpoint מחרוזת נקודת קצה אופציונלית של API בהתאמה אישית לשימוש (אם מודולי ממשק המשתמש מוגדרים עם שרת proxy).
עיצוב ‫'dark' | 'light' ערכת הצבעים שבה רוצים להשתמש.
show-header BooleanString האם להציג את כותרת ההצעות של Agent Assist.
dark-mode-background מחרוזת צבע הרקע שמשמש למצב כהה. אם לא מציינים אף אחד, המערכת מספקת ברירות מחדל לשולחנות העבודה העיקריים של הסוכנים הנתמכים.
notifier-server-endpoint מחרוזת נקודת הקצה של שרת ההתראות לשימוש בשיחות מבוססות-אירועים.
event-based-transport EventBasedTransport פרוטוקול התעבורה שבו יש להשתמש לשיחות שמבוססות על אירועים.
event-based-library EventBasedLibrary ספרייה לשימוש בשיחות שמבוססות על אירועים.
oauth-client-id מחרוזת מזהה לקוח אופציונלי ב-OAuth לאימות מרומז, שמשמש בחלק מההגדרות של סוכני שולחן עבודה (Genesys Cloud).
redirect-uri מחרוזת כתובת URI אופציונלית להפניה אוטומטית שאליה מנווטים אחרי האימות, בשימוש בחלק מההגדרות של סוכני שירות לקוחות (Genesys Cloud).
genesys-cloud-region מחרוזת אזור אופציונלי ל-Genesys Cloud, ברירת המחדל היא mypurecloud.com.

Usage

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

HTML

js <element-selector property-name="value">

JavaScript

js var el = document.querySelector('element-selector'); el.setAttribute('property-name', 'value');

קלט

שם המאפיין סוג תגובה
socketIoConnectOpts SocketIoConnectOpts אפשרויות חיבור נוספות של Socket.io.
config UiModuleContainerConfig אובייקט הגדרה להגדרת הגדרות ספציפיות למודול.

Usage

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

const el = document.querySelector('element-selector');
el.propertyName = value;

סוגים

בקטע הבא מפורטים הסוגים המותאמים אישית שבהם נעשה שימוש ברכיב.

AgentDesktop

"LivePerson" | "GenesysCloud" | "SalesForce" | "Custom"

CommunicationChannel

"chat" | "voice" | "omnichannel"

BooleanString

"true" | "false"

EventBasedTransport

"websocket" | "polling"

EventBasedLibrary

"SocketIo"

SocketIoConnectOpts

interface SocketIoConnectOpts extends SocketIOClient.ConnectOpts {
  auth: {
    token: string;
  };
  withCredentials?: boolean;
}

UiModuleContainerConfig

interface UiModuleContainerConfig {
  knowledgeAssistConfig?: {
    articleLinkConfig: {
      /**
       * Whether to open the article in a new tab or as a dialog. Defaults to new
       * tab.
       */
      target?: "blank" | "popup";
      /**
       * Options to configure the popup's size and location. See
       * https://developer.mozilla.org/en-US/docs/Web/API/Window/open#window_features.
       */
      popupWindowOptions?: string;
      /**
       * The field name on the document metadata if a separate article link source
       * is provided.
       */
      linkMetadataKey?: string;
    };
  };
  knowledgeAssistV2Config?: {
    articleLinkConfig?: {
      /**
       * Whether to open the article in a new tab or as a dialog. Defaults to new
       * tab.
       */
      target?: "blank" | "popup";
      /**
       * Options to configure the popup's size and location. See
       * https://developer.mozilla.org/en-US/docs/Web/API/Window/open#window_features.
       */
      popupWindowOptions?: string;
      /**
       * The field name on the document metadata if a separate article link source
       * is provided.
       */
      linkMetadataKey?: string;
    };
    showCopyAnswer: boolean;
    showPasteAnswer: boolean;
  };
  summarizationConfig?: {
    /**
     * Optional callback that can be used to save the generated summary to an
     * external source.
     */
    onSaveSummary?: (
      summary: {
        summary: string;
        conversationDetails: ConversationDetails;
      },
      saveCallbacks: {
        setLoading: () => void;
        setSuccess: (message: string) => void;
        setError: (message: string) => void;
      }
    ) => void;

    /** Whether to show the 'Generate summary' button. */
    showGenerateSummaryButton?: "true" | "false";
  };
}