# Description

La base documentaire que vous allez fournir au chatbot correspond à une fiche Excel contenant toutes les informations nécessaires au bon fonctionnement du bot.

{% file src="/files/-M1jIey8FOm42w-83OVc" %}
Modèle vierge
{% endfile %}

{% hint style="info" %}
Afin de mieux comprendre la suite des explications, nous vous conseillons d'ouvrir le fichier Excel en parallèle.
{% endhint %}

{% hint style="danger" %}
Pour éviter les mauvaises surprises lors de la création du chatbot, merci de ne pas modifier les noms de colonnes. Vous pouvez toutefois changer leur ordre  et filtrer à votre guise, pour le tri faites attention car le chatbot ordonnera les réponses dans l'ordre dans lequel elles sont dans l'excel.
{% endhint %}

## ID

La colonne ID (identifiant) n'est pas une colonne destinée à l'utilisateur final mais est essentielle dans la construction de votre base documentaire.\
En effet c'est cet identifiant qui permettra au chatbot d'associer les questions / réponses.

Pour la compréhension globale de votre base documentaire nous vous recommandons d'utiliser des IDs simples et compréhensibles facilement.\
Exemple: "*Que fait L'usine à Chatbots ?*", un ID possible serait "*explication\_usine*", "*presentation\_usine*" ou bien "*fonctionnement\_usine*" suivant la réponse que vous souhaitez apporter.

{% hint style="warning" %}
Un ID doit être unique. Deux questions différentes ne peuvent avoir le même identifiant.
{% endhint %}

{% hint style="info" %}
Un ID ne doit pas contenir d'espaces ou de caractères spéciaux ou accentués. Seul les caractères alphanumériques et \_ - sont autorisés.\
Exemple invalide : "*présentation usine*"\
Exemple valide: "*presentation\_usine*"
{% endhint %}

{% hint style="warning" %}
Les IDs commençant par *"st*\_" ont un comportement spécial. En effet ceux-ci sont associés à des "Small Talks", des éléments de conversations généraux.\
Ceux-ci sont exclus des certaines statistiques.
{% endhint %}

## Catégorie

Votre base documentaire a de grandes chances de contenir des questions qui peuvent se regrouper en catégories. Si cela est pertinent vous pouvez indiquer un nom de catégorie dans cette colonne.

Le concept de catégorie sera utile si le chatbot n'arrive pas à détecter une question mais arrive à détecter sa catégorie. Dans ce cas là il pourra proposer plusieurs questions qui lui semble appropriées et appartenant à cette catégorie.

{% hint style="info" %}
Un nom de catégorie doit être explicite et simple.
{% endhint %}

{% hint style="warning" %}
Attention à bien copier / coller le nom de la catégorie entre les différentes questions. Si le nom de la catégorie n'est pas exactement le même il sera considéré comme une autre catégorie.
{% endhint %}

## Question

C'est ici que se trouvera la question principale à laquelle le chatbot doit répondre. Ce n'est pas forcément la formulation attendue par l'utilisateur mais celle qui vous parait le plus explicite.

{% hint style="info" %}
La question dans cette colonne est unique.
{% endhint %}

## Type de réponse

Un chatbot peut envoyer plusieurs types de réponses suivant les informations qu'il veut envoyer à l'utilisateur. Dans le cas de L'usine à Chatbots quatre types de réponses sont disponibles (Texte, Image, Lien et Réponse à choix).

Leurs fonctionnements est détaillé dans la partie Tutoriel.

{% content-ref url="/pages/-M1fquKkfBOMeqXaQwYk" %}
[Tutoriel](/fabrique-a-chatbots/base-documentaire/exemples-1.md)
{% endcontent-ref %}

{% hint style="info" %}
Seul ces 4 types de réponses sont autorisés. Si un autre type de réponse est renseigné, celui-ci sera ignoré.
{% endhint %}

## Réponse(s)

C'est ici que se trouvera la réponse associée à la question principale et au type de réponse.

Un chatbot peut envoyer plusieurs réponses d'affilée, pour ce faire il suffit d'insérer une nouvelle ligne dans l'Excel avec le même ID puis de remplir seulement les colonnes "*Type de réponse*" et "*Réponse(s)*". Le chatbot enchaînera les réponses correspondantes au même ID.

Vous verrez comment faire cela dans la partie Tutoriel.

{% content-ref url="/pages/-M1fquKkfBOMeqXaQwYk" %}
[Tutoriel](/fabrique-a-chatbots/base-documentaire/exemples-1.md)
{% endcontent-ref %}

{% hint style="info" %}
Les réponses d'un chatbot doivent être si possible le plus concise possibles. Évitez les paragraphes de plus de 2/3 lignes ou séparez les en plusieurs réponses, cela aérera la conversation.
{% endhint %}

{% hint style="info" %}
Si la question nécessite réellement une explication longue vous pouvez effectuer une réponse concise et ensuite envoyer un lien vers cette explication longue ou une source de référence (voir Tutoriel -> Lien).
{% endhint %}

## Questions synonymes (à séparer par un point-virgule ;)

C'est principalement grâce à cette colonne que le chatbot va pouvoir appréhender les différents types de question.

En effet pour une réponse donnée il peut y avoir une multitude de formulation de questions possibles. Le but ici n'est pas de toutes les référencer mais d'essayer d'en renseigner plusieurs différentes afin que votre chatbot puisse être efficace dès son lancement.

Pour renseigner ces questions il suffit de séparer les différentes formulations par un point-virgule ;.\
Exemple pour la question "*Qui es-tu ?*": "*Tu es qui ?; T'es qui ?; A qui je parle ?; Qui me parle ?; Qui êtes-vous ?*"

{% hint style="info" %}
Nous vous conseillons d'essayer de référencer **au minimum** 5 formulations différentes au départ. Plus il y en a, mieux votre chatbot comprendra.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://fabrique-a-chatbots.gitbook.io/fabrique-a-chatbots/base-documentaire/description.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.