# Base de données
Les bases de données sont liées au chatbot. Vous pourrez donc retrouvez les mêmes bases de données dans toutes vos versions ou tous vos environnements de chatbots.
# Cas d'usage
Cette fonctionnalité a été développé à la base pour nous permettre de détecter s'il existait déjà des tickets similaires avant que l'utilisateur le créer. Ca nous a permis en interne de réduire le nombre de tickets et d'améliorer la productivité de nos équipes tech.
Cependant, le nombre de cas d'usages possible avec cette fonctionnalité est infini.
Vous pouvez par exemple :
- Détecter les tickets similaires
- Chercher le meilleur article dans un wiki
- Chercher un produit dans une base de données pour demander une précision ou confirmation à l'utilisateur
# Comment l'utiliser
1- Créer une nouvelle base de données
WARNING
Le nom de votre base de données ne doit pas contenir de caractères spéciaux ou d'espace.
2- Editer la base de données et ajouter les champs des "objets" de la base
De base, nous ajoutons un champ vz_id qui nous permettra de juger de l'unicité des objets.
Une fois que nous avons ajouté tous les champs que vous jugez nécessaire, nous allons pouvoir valider les actions liées à cette base de données.
3- Valider les actions
Dans l'onglet Validation
cliquez sur le bouton pour créer les actions.
4- Dans les workflows vous avez 5 nouvelles actions
FindOne: Permet de trouver 1 objet de la base de données à partir de son vz_id
CreateOne: Permet de créer 1 objet dans la base de données
Cette action vous permettra de créer le ticket dans la base "Vizir". Renseignez tous les champs depuis l'éditeur de workflow.
- RemoveOne: Permet de supprimer 1 objet de la base de données
Un fois qu'un ticket est fermé, on peut imaginer le supprimer de la base Vizir également.
- UpdateOne: Permet de mettre à jour un ou plusieurs champs de l'objet.
On peut imaginer un webhook depuis l'outil de ticketing pour mettre à jour les commentaires, le status, ... dans la base Vizir.
- Find: Permet de faire une recherche dans la base
C'est l'action qui vous servira le plus. Elle permet de faire des recherches textuelles dans la base de données sur les champs que vous souhaitez. On peut imaginer plusieurs niveaux de recherche pour les tickets. On cherche en premier dans le title, si on ne trouve rien, on recherche dans la description, ...
5- Ajouter des objets à la base Nous avons dédié une route pour ajouter des objets à la base de données pour vous permettre de la faire via un outil tiers ou un script.
Voici la route à utiliser pour créer des éléments via API dans votre database:
POST https://developers.vizir.co/chatbots/:chatbotID/databases/:database_id
avec un body les champs que vous avez définis:
{
"name": "Lorem ipsum"
}
Voici la route à utiliser pour faire une requête sur la base API:
PUT https://developers.vizir.co/chatbots/:chatbotID/databases/:database_id/search
Avec un body cce que vous souhaitez chercher: Par exemple ici, nous allons cherche le terme lorem dans le champ "name"
{
"name": "Lorem"
}
Voici un exemple de réponse que vous pourrez recevoir avec ce type de requêtes:
{
"count": 1,
"data": [
{
"name": "Lorem ipsum"
}
]
}
Les objets dans data comprendront TOUS les champs que vous avez renseignés quand vous avez créé l'objet.
DANGER
Ces routes sont sécurisées, vous devez donc avez un token valide dans le call API (voir l'aide en ligne pour plus d'info (opens new window))