Mon édition
Module supplémentaire Agents IA - avancé

Dans le créateur d’intégration, les paramètres de demande vous permettent de récupérer les données (paramètres de conversation) des conversations des agents IA et de les transférer à des points de terminaison externes. Dans certains cas, vous devrez peut-être transformer ou reformater ces données avant de les envoyer dans une demande API sous la forme d’une requête URL ou dans le corps de la demande. Pour ce faire, vous pouvez utiliser JSONata, un langage de requête et de transformation puissant.

Cet article aborde les sujets suivants :

  • Reformatage de la valeur d’un paramètre de requête
  • Exemples de cas d’utilisations courants pour le reformatage des valeurs

Articles connexes :

  • Ressources pour le créateur d’intégration

Reformatage de la valeur d’un paramètre de requête

Vous pouvez reformater la valeur d’un paramètre de demande en utilisant JSONata.

Pour reformater la valeur d’un paramètre de requête

  1. Dans Agents IA - avancé, en haut à droite, utilisez le champ déroulant Agent IA pour sélectionner votre agent IA.
  2. Dans le menu principal sur la gauche, cliquez sur Intégrations API.
  3. Sélectionnez ou créez une intégration.
  4. À la page Paramètres de la requête, sélectionnez ou créez le paramètre de requête pour lequel vous voulez reformater la valeur.
  5. Dans le champ Valeur test, sélectionnez l’icône Reformatage de valeur ().
  6. Dans la boîte de dialogue Reformatage de la valeur, dans le champ Reformatage de JSONata, utilisez JSONata pour transformer ou reformater la valeur associée à la clé de paramètre de demande sélectionnée.
    Dans votre requête de données JSONata, utilisez « $ » pour représenter la clé dont vous reformatez la valeur.
    Le champ Tester l’aperçu de la valeur vous permet de consulter les résultats de votre requête en temps réel.
  7. Cliquez sur Terminé.
  8. (Facultatif) Si vous ajoutez le paramètre de demande au corps d’une demande API :
    1. Sous l'en-tête Environnement à gauche, sélectionnez l'environnement approprié.
    2. Sélectionnez l’onglet Corps.
    3. Ajoutez votre objet JSON en utilisant le paramètre de demande comme valeur entre accolades doubles.

Utilisations courantes du reformatage des valeurs

Dans le créateur d’intégration, vous pouvez définir les paramètres de requête en les affectant à des clés spécifiques. Même si ces valeurs peuvent fonctionner en l’état, dans certains cas, elles doivent être transformées ou reformatées pour satisfaire aux exigences du système externe.

Vous pouvez par exemple vouloir :

  • Reformater les dates : Changez le format d’une date de MM/JJ/AAAA à AAAA-MM-JJ ou ISO 8601 pour satisfaire aux exigences de l’API.
  • Effectuer des opérations sur les chaînes : Manipulez des chaînes, par exemple ajoutez ou supprimez des caractères, combinez plusieurs champs ou transformez des chaînes pour qu’elles contiennent du code HTML.
  • Appliquer une logique conditionnelle : Appliquez des conditions, par exemple vérifier si un champ est vide ou affecter une valeur par défaut si nécessaire.

Cette section contient les exemples suivants :

  • Scénario : Reformatage des dates
  • Scénario : Reformatage des URL pour rendre les liens cliquables
  • Scénario : Reformatage de la transcription d’un chat pour une meilleure lisibilité

Scénario : Reformatage des dates

Dans ce scénario, votre point de terminaison doit vérifier une date au format AAAA-MM-JJ ou au format ISO 8601. Cependant, pour votre conversation, vous voulez que les dates s’affichent dans un format plus convivial (JJ/MM/AAAA).

Voici la requête JSONata que vous utiliseriez dans ce scénario :

$substring($, 6, 10) & "-" & $substring($, 3, 2) & "-" & $substring($, 0, 2)

Scénario : Reformatage des URL pour rendre les liens cliquables

Dans ce scénario, vous souhaitez convertir les URL en liens cliquables en recherchant du texte (une sous-chaîne) qui commence par http:// ou https:// suivi d’un certain nombre de caractères autres que des espaces blancs. Vous devez ensuite remplacer cette sous-chaîne en utilisant la fonction JSONata $replace, par une chaîne qui entoure l’URL correspondante dans un marqueur HTML <a>, ce qui crée un lien cliquable.

Voici la requête JSOata que vous utiliseriez dans ce scénario :

(
$text := "Chat transcript unavailable. Here is a link:https://www.zendesk.com. Here is another link: https://www.w3schools.com.";

$replace($text, /(https?:\/\/[^\s]+)/, '<a href="$1">$1</a>'
)

Scénario : Reformatage de la transcription d’un chat pour une meilleure lisibilité

Dans ce cas, vous souhaitez ajouter une transcription de chat à un ticket. Cependant, dans son formulaire par défaut, la transcription du chat n’est pas très lisible :

  • Transcription de chat - 2024-10-12 (13:04:10) Agent IA : Bienvenue sur l'Agent IA de l'ingénierie client ! (13:04:10) Agent IA : Choisissez l’intégration à tester : (13:04:10) Visiteur : test c.id: d501304d-da09-4485-a4c7-1c708ec0005d Toutes les heures en UTC

Vous souhaitez le transformer en un format plus convivial en segmentant chaque message sur une nouvelle ligne. Comme chaque nouveau message commence par une parenthèse ouverte ( ( ), vous pouvez utiliser JSONata pour remplacer chaque occurrence de ( par un saut de ligne suivi de (.

La conversation reformatée ressemblerait alors à ce qui suit :

  • Transcription du chat - 2024-10-12
    (13:04:10) Agent IA : Bienvenue dans l'agent IA du créateur d'intégration !
    (13:04:10) Agent IA : Choisissez l’intégration à tester :
    (13:04:10) Visiteur : test c.id: d501304d-da09-4485-a4c7-1c708ec0005d Toutes les heures en UTC

Voici la requête JSOata que vous utiliseriez dans ce scénario :

$replace($, “(“, “\n(“)

En outre, vous devez ajouter ce paramètre à la section corps de votre environnement pour qu’il soit envoyé avec la demande :

{
"chatTranscript": "{{chatTranscript}}"
}

Réalisé par Zendesk