Conteneur V1

Cette page contient la documentation de l'API pour la méthode de conteneur d'implémentation des modules d'UI. Voici les fonctionnalités d'Assistance de l'agent que vous pouvez implémenter en tant que composants dans votre conteneur.

Attributs

Nom de propriété Type Commentaire
fonctionnalités string Liste de clés de fonctionnalités de suggestions Agent Assist à afficher, séparées par une virgule. Exemple : "SMART_REPLY, CONVERSATION_SUMMARIZATION"
api-headers string En-têtes supplémentaires à inclure dans les appels d'API Dialogflow. Exemple : "Content-Type:application/json, Accept:application/json"
conversation-profile string Nom du profil de conversation à utiliser.
agent-desktop AgentDesktop Logiciel de bureau de l'agent à intégrer.
auth-token string Jeton d'authentification à utiliser pour les appels d'API.
api-key string Clé API facultative à utiliser pour les appels d'API.
channel CommunicationChannel Canal de communication utilisé pour cette application (chat, voix ou omnicanal).
custom-api-endpoint string Point de terminaison d'API personnalisé facultatif à utiliser (si les modules d'interface utilisateur sont configurés avec un serveur proxy).
thème 'dark' | 'light' Thème de couleur à utiliser.
show-header BooleanString Indique s'il faut afficher l'en-tête des suggestions de l'assistance de l'agent.
dark-mode-background string Couleur d'arrière-plan à utiliser pour le mode sombre. Si aucun n'est spécifié, des valeurs par défaut sont fournies pour les principaux postes de travail des agents compatibles.
notifier-server-endpoint string Point de terminaison du serveur de notification à utiliser pour les conversations basées sur des événements.
event-based-transport EventBasedTransport Protocole de transport à utiliser pour les conversations basées sur des événements.
event-based-library EventBasedLibrary Bibliothèque à utiliser pour les conversations basées sur des événements.
oauth-client-id string ID client OAuth facultatif pour l'authentification implicite, utilisé dans certaines configurations d'agent desktop (Genesys Cloud).
redirect-uri string URI de redirection facultatif vers lequel accéder après l'authentification, utilisé dans certaines configurations d'agent de bureau (Genesys Cloud).
genesys-cloud-region string Région facultative pour Genesys Cloud, définie par défaut sur mypurecloud.com.

Utilisation

Les attributs sont des propriétés de composant basées sur des chaînes qui peuvent être définies de différentes manières :

HTML

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

JavaScript

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

Entrées

Nom de propriété Type Commentaire
socketIoConnectOpts SocketIoConnectOpts Options de connexion Socket.io supplémentaires.
config UiModuleContainerConfig Objet de configuration permettant de définir des configurations spécifiques au module.

Utilisation

Les entrées sont généralement des objets JavaScript ou d'autres types de propriétés complexes qui doivent être attribués directement à l'instance d'élément :

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

Types

Consultez la section suivante pour connaître les types personnalisés utilisés par le composant.

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";
  };
}