Synthèse

Cette page contient la documentation de l'API pour le module d'interface utilisateur Récapitulatif de la conversation. Ce module permet de générer un résumé d'une conversation.

Utilisation

Importez le module dans votre page HTML à l'aide du code suivant:

<script src="https://www.gstatic.com/agent-assist-ui-modules/v1/summarization.js"></script>

Intégrez le module à l'aide de la balise suivante:

<agent-assist-summarization>

Attributs

Nom de propriété Type Commentaire
show-generate-summary-button BooleanString Indique si le bouton Generate Summary (Générer un résumé) doit s'afficher.

Utilisation

Les attributs sont des propriétés de composant basées sur des chaînes qui peuvent être définies comme suit:

Directement depuis votre modèle HTML:

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

Dans votre code JavaScript:

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

Entrées

Nom de propriété Type Commentaire
onSaveSummary OnSaveSummary Rappel à appeler lorsque le résumé est enregistré. Utilisé par les clients pour envoyer des informations récapitulatives au CRM.

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 de l'é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.

BooleanString

"true" | "false"

OnSaveSummary

type OnSaveSummary = (
  summary: {
    summary: string;
    conversationDetails: ConversationDetails;
  },
  saveCallbacks: {
    setLoading: () => void;
    setSuccess: (message: string) => void;
    setError: (message: string) => void;
  }
) => void;