Skip to content
/ pierre Public

PIERRE — Une IA open source, plurilingue et multicanale au service du mouvement HLM, de ses candidats, locataires et collaborateurs

pierre-ia.org

License

AGPL-3.0 license
1 star 1 fork Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

charnould/pierre

BranchesTags

Repository files navigation

PIERRE – L'IA open source du mouvement HLM

Important

PIERRE est actuellement en version 0.27.x (consulter les releases) avec une qualité de base de connaissances estimée à 10 %. Par ailleurs, la documentation ci-dessous est en cours de rédaction. En cas de difficultés, créer une issue ou envoyer un email à [email protected].

PIERRE ne connait pas les spécificités des bailleurs (ex : taille des parcs, coordonnées des agences, procédures internes, etc.). Ces éléments peuvent néanmoins lui être « enseignés en deux clics ».

PIERRE : kézako ?

PIERRE est une intelligence artificielle (IA) open source, plurilingue et multicanale au service du mouvement HLM, de ses candidats, locataires et collaborateurs.

Plus concrètement, PIERRE c'est à la fois :

  1. Un chatbot (ou mieux : un resolution bot) open source — disponible sur le Web (démonstration) et par SMS — qui répond 24/7/365 à 100 % des questions de « premier niveau » des locataires et demandeurs HLM, et épaule au quotidien les collaborateurs des bailleurs sociaux (processus, données patrimoniales, aide à la rédaction, etc.).

  2. Une base de connaissances en open data (consultation), utilisable indépendamment du chatbot et indispensable à la mise en oeuvre de toutes approches « Retrieval Augmented Generation » (RAG) via un LLM.

→ Télécharger une présentation de PIERRE (PDF · 2,7 Mo)

Sommaire

Contribuer à PIERRE

Contribuer au code-source

Pour contribuer au code-source, créer une issue dans GitHub et suivre les us et coutumes des projets open source. Les releases de PIERRE sont consultables ici.

Contribuer à la base de connaissances

Contribuer à « améliorer la base de connaissances » : kézako ?

Lorsque l'on comprend comment fonctionne PIERRE, on comprend le rôle de la base de connaissances : elle est le coeur de l'intelligence de PIERRE et n'est — ni plus ni moins — que des fichiers-textes transformés. Par exemple, ce fichier contient tout ce que sait PIERRE sur les enquêtes-locataires.

Ce document peut être incomplet ou imprécis, et c'est tout l'enjeu que de l'améliorer, car c'est ce document qu'utilise PIERRE pour répondre aux questions sur ces sujets.

« Améliorer la base de connaissances », ce n'est donc que cela : (1) améliorer le contenu des fichiers-textes existants et (2) créer des fichiers-textes sur les thématiques manquantes.

Thématiques couvertes par la base de connaissances

La base de connaissances — en co-construction avec les bailleurs — couvre plusieurs thématiques :

  • global : les connaissances génériques qui s'appliquent uniformément sur tout le territoire (ex : comment gérer un trouble du voisinage ? qu'est-ce que les charges locatives ?).
  • local : les connaissances spécifiques à un territoire donné (ex : les associations d'hébergement d'urgence dans l'Ain, les structures d'aide dans le cadre de violences conjugales dans l'Eure).
  • org : les connaissances relatives à un organisme HLM en particulier (ex : qu'est-ce que Grand Dijon Habitat et quelles sont les coordonnées du service-client et des agences ?).
  • wikipedia : des connaissances importées de Wikipédia (ex : l'histoire du logement social).

Concrétement comment contribuer ?

  1. Consulter la base de connaissances
  2. Et si vous identifiez un manque, une imprécision ou une erreur :
    Option A : Adresser un email à [email protected]
    Option B : Créer une issue sur GitHub (pour les connaisseurs)

Au fur et à mesure de l'amélioration de la base de connaissances, la pertinence de PIERRE s'améliorera automatiquement et profitera à l'ensemble du mouvement HLM.

Fonctionnement + architecture de PIERRE

Comment fonctionne PIERRE ?

  1. Un utilisateur pose une question à PIERRE via le web ou par SMS.
  2. Une première passe de LLM/IA augmente la requête initiale.
  3. Une deuxième passe de LLM/IA s'assure de la validité et sécurité de la requête initiale (ex : impossible d'insulter PIERRE ou d'adresser une question sans lien avec le logement).
  4. La requête validée et augmentée est transformée par un LLM/IA en vecteurs de valeurs numériques qui sont utilisés pour interroger les bases de connaissances de PIERRE.
  5. Les résultats retournés sont rerankés par un LLM/IA pour ne conserver que les plus pertinents.
  6. Une dernière passe de LLM/IA génère une réponse sur la base des résultats retournés, réordonnancés puis rerankés des bases de connaissances.
  7. La réponse est retournée quelques secondes plus tard à l'utilisateur via le web ou par SMS.
  8. La conversation se poursuit jusqu'à satisfaction de l'utilisateur (goto 1).

Note

On comprend ici aisément le rôle des bases de connaissances : elles sont le coeur de l'intelligence de PIERRE ou de toute IA mettant en oeuvre une approche « Retrieval Augmented Generation » (RAG) via un LLM. Ces bases de connaissances sont améliorables et personnalisables ; et c'est simplissime !

Modèles de langage (ou LLM)

PIERRE utilise — à ce jour — plusieurs (passes de) LLM dans cet ordre successif :

  1. Un modèle de génération de textes qui transforme la requête de l'utilisateur en une « requête augmentée » (en utilisant des techniques de type HyDE ou Stepback).

  2. Un modèle de génération d'embeddings qui transforme la « requête augmentée » en vecteurs de valeurs numériques qui sont ensuite utilisés pour rechercher les éléments de réponse les plus pertinents dans les bases de connaissances. PIERRE utilise bge-m3, un modèle open source de la Beijing Academy of Artificial Intelligence (BAAI).

  3. À nouveau, un modèle de génération de textes configuré en reranker qui classifie les résulats retournés par les bases de connaissances pour ne conserver que les éléments les plus pertinents en regard de la question posée par l'utilisateur.

  4. Un modèle de génération de textes qui génére les réponses textuelles aux utilisateurs en utilisant les éléments issus de (3).

Lorsque l'on auto-héberge PIERRE — et sur le principe du « Bring Your Own LLM Key/Model » (BYOK) — il est possible de choisir le modèle utilisé (Mistral, Anthropic, Cohere, OpenAI...) pour (1), (3) et (4) et ce, en modifiant le fichier de configuation (cf. infra).

L'universel SMS pour les échanges de « premier niveau »

Note

PIERRE propose à ce jour deux modalités d'interaction : Text-to-Text via le Web (démonstration) ou par SMS, et Voice-to-Text sur smartphone. À court terme, PIERRE va également investiguer une interaction Voice-to-Voice.

En réponse au nouveau plan de numérotation mis en place par l'ARCEP en 2023 (avec l'introduction des numéros commerciaux 09 3x xx xx xx) et pour proposer aux entreprises une solution universelle pour converser avec leurs clients, les opérateurs téléphoniques français ont lançé en 2023 (déploiement opérationnel en octobre 2024) une nouvelle offre de SMS conversationnel à destination des entreprises (dite Time2chat) qui (i) permet de s'affranchir des plateformes propriétaires (WhatsApp, Telegram, Messenger, etc.) utilisées au maximum par 50 % de la population française et (ii) une instantanéité et délivrabilité exceptionnelles (100 % des téléphones disposent nativement du SMS).

Principales caratéristiques de Time2chat (en savoir plus via l'ARCEP ou via Orange) :

  • Une conversation est une série de SMS entre une entreprise et un utilisateur.
  • Elle dure maximum 24h et le nombre de SMS échangés durant cette période est illimité.
  • Elle peut être initiée par l'entreprise ou l’utilisateur.

Technologies + Services

  • Language: Typescript/Javascript
  • Framework: Hono (with Bun runtime)
  • Local inference: Ollama
  • Database + Vectorstore: SQLite3 (extended with sqlite-vec)
  • Deployment: Kamal (with Docker)
  • LLM: « Bring Your Own LLM Key/Model » (BYOK)
  • GPU (optionnel): Hugging Face (via Inference Endpoints)
  • SMS: CM (via Time2Chat)

Les coûts associés à l'usage de PIERRE

Déployer PIERRE sur un serveur génére des coûts :

  • La location d'un serveur doté d'un GPU (meilleur rapport qualité/prix: GEX44 d'Hetzner) : €200 par mois
  • L'usage d'un LLM pour générer du texte : $0,40 (in) et $1,60 (out) / MTokens (gpt-4.1-mini)
  • (Optionnellement) La location d'un GPU musclé pour vectoriser vos connaissances : €10 par mois
  • (Optionnellement) Les conversations SMS :
    – Location d'un numéro de téléphone : €10 par mois
    – Envoi de SMS : €0.09 par conversation (= SMS illimités par fenêtre de 24h)

Comment déployer PIERRE ?

Faire héberger PIERRE (le plus simple)

Avantages :

  • Ne jamais avoir à se soucier de serveurs et d'API.
  • Bénéficier 24/7/365 de la dernière version.

Adresser un email à [email protected].

Héberger PIERRE (self-hosting)

Faire fonctionner PIERRE en local

Les instructions ci-après sont pour Windows+WSL (sous-système Windows pour Linux).

  1. Installer WSL et vérifier sa bonne installation (instructions).
  2. Installer Ollama (≥ 0.6.5) et vérifier sa bonne installation (instructions), puis saisir dans votre terminal ollama pull bge-m3 pour télécharger le modèle bge-m3.
  3. Installer Bun (≥ 1.2.10) et vérifier sa bonne installation (instructions).
  4. Installer SQlite3 et vérifier sa bonne installation (instructions).
  5. Forker/cloner le présent dépôt.
  6. Lancer bun install dans votre terminal pour installer les dépendances.
  7. Renommer le fichier .env.example en .env.production et compléter le.
  8. Ouvrir deux shell et exécuter dans le premier ollama serve et bun dev dans le second.
  9. Et voilà : PIERRE est accessible à http://localhost:3000 et répond à vos questions !

Note

La vitesse d'inférence peut être faible si votre processeur est peu puissant.

Déployer pour la première fois PIERRE sur un serveur de production

Pour déployer PIERRE sur un serveur, il est indispensable d'être parvenu à le faire fonctionner en local.

  1. Installer Docker Desktop et le lancer (instructions). Docker gérera la conteneurisation.
  2. Lancer gem install kamal pour installer Kamal (≥2.6.0) qui gérera le déploiement (instructions).
  3. Disposer d'un compte GitHub et générer une clef. GitHub sera le registre de conteneurs lors du déploiement.
  4. Disposer d'un VPS avec GPU (par exemple GEX44 d'Hetzner) et être en capacité de s'y connecter via ssh (avec une clef ou mot de passe).
  5. Finaliser les modifications du fichier .env.production que vous avez créé précédemment.
  6. Saississez dans votre terminal bun --env-file=.env.production run kamal setup.
  7. Saississez dans votre terminal bun --env-file=.env.production run kamal server exec "docker exec ollama ollama pull bge-m3".
  8. Et voilà, PIERRE est accessible à l'adresse URL de votre serveur (il faut parfois attendre une dizaine de minutes afin que les certificats SSL soient générés).
  9. Étapes suivantes (optionnelles et décrites ci-dessous) :
    – Créer une seconde instance (de tests) de PIERRE sur le même serveur
    – Personnaliser PIERRE
    – Faire fonctionner PIERRE par SMS
    – Afficher PIERRE sur votre site internet ou extranet-locataire

[!NOTE] > TODO: Détailler la procédure permettant l'usage du GPU par Docker/Ollama : se connecter via ssh au serveur, curl -fsSL https://ollama.com/install.sh | sh, puis suivre les recommandations disponibles ici.

Redéployer PIERRE sur un serveur de production

PIERRE — et notamment sa base de connaissances — évolue régulièrement et suit la convention semver. Pour le mettre à jour :

  1. Saisir bun pierre:version pour connaitre la dernière version disponible.
  2. Consulter les releases pour connaitre les modifications et éventuels breaking changes.
  3. Mettre à jour votre fork/clone.
  4. Saisir bun pierre:config pour vous assurer que config.ts est correctement paramétré.
  5. Saisir bun --env-file=.env.production run kamal deploy dans votre terminal (ou le raccourci bun prod:deploy).

Déployer et redéployer PIERRE sur un serveur de tests

Pour tester en conditions réelles les mises à jour et nouveautés de PIERRE, le plus simple est de déployer une seconde instance de PIERRE sur votre serveur de production.

  1. Dupliquer .env.production en .env.staging et modifier le (a priori uniquement le SERVICE et HOST).
  2. Lancer bun --env-file=.env.staging run kamal setup pour déployer la première fois.
  3. Lancer bun --env-file=.env.staging run kamal deploy pour redéployer (ou le raccourci bun staging:deploy).

Modifier et paramétrer PIERRE (self-hosting)

Note

Dans les instructions ci-dessous, nous considérons un bailleur social fictif nommé Pierre Habitat dont le site institutionnel est accessible à pierre-habitat.fr et qui a déployé sa propre version de PIERRE à l'adresse/IP 180.81.82.83.

Modifier l'interface du chatbot

  1. Dans le répertoire ./assets, supprimer les répertoires demo_client, demo_team et testing_purpose_1, testing_purpose_2, puis dupliquer le dossier default et le nommer pierre-habitat. Les consignes suivantes s'appliquent à ce nouveau répertoire.
  2. Supprimer les sous-répertoires /dist, /files, /scripts, /tailwind.
  3. Créer une icône system.svg et remplacer la précédente. Cette icône est celle qui apparait dans l'interface du chatbot (au dessus de « Bonjour 👋 »).
  4. Générer les icônes qui permettront d'ajouter votre chatbot sur l'écran d'accueil des smartphones de vos utilisateurs et remplacer celles dans le dossier icons (les icônes Windows ne sont pas nécessaires). Conservez la structure du répertoire et le nommage des fichiers (automatique).
  5. Modifier config.ts :
    – id avec pierre-habitat
    – greeting qui est le message d'accueil de votre chatbot
    – examples qui sont les exemples proposés après votre message d'accueil
    – disclaimer qui est le message s'affichant après chaque réponse générée (ex : Une IA peut se tromper, vérifier les informations.).
  6. Modifier dans manifest.json :
    – short_name par le nom souhaité de votre chatbot
    – start_url par https://180.81.82.83/?config=pierre-habitat
  7. Et voilà, votre chabot personnalisé est disponible à http://localhost:3000/?config=pierre-habitat

Tip

Pour vous assurer que config.ts est correctement paramétré, notamment lors des montées de version qui peuvent en modifier la structure, lancer bun pierre:config.

Modifier la personnalité du chatbot

Si vous avez à ce stade personnalisé visuellement votre chatbot (cf. supra), et bien qu'il affiche des icônes et les salutations de votre organisme, il ne se présente PAS encore comme le chatbot de votre organisme (essayez en lui demandant qui il est !).

Pour modifier cela, modifier dans le fichier config.ts :

  • persona qui définit l'identité et le rôle du chatbot
  • audience qui définit le contexte dans lequel le chabot doit considérer son interlocuteur
  • guidelines qui définit la façon dont le chatbot répond aux questions

Note

Pour faciliter la lecture et manipulation du fichier config.ts dans VSCode, ou plus généralement activer le word wrap : utilisez le raccourci Alt + z (Windows) ou ⌥ + z (Mac).

Modifier le modèle de langage utilisé

Important

Il est très fortement recommandé de disposer d'une version fonctionnelle de PIERRE en local avant de changer le modèle de langage (LLM) et ce, pour être en mesure d'effectuer des tests. En effet, modifier le modèle de langage peut avoir quelques effets sur la qualité et vitesse des réponses de PIERRE.

Comment modifier le modèle de langage ?

Pour modifier les modèles, il suffit de :

  • Modifier models dans votre fichier config.ts par la valeur souhaitée. Il est fortement recommandé d'utiliser un modèle peu cher pour le reranker qui est consommateur de tokens (ex : gpt-4o-mini-2024-07-18 d'OpenAI ou équivalent).
  • Renseigner la clef d'API correspondante dans les variables d'environnement (.env.production).

Quels modèles est-il possible d'utiliser ?

PIERRE permet – à ce stade – l'usage des principaux modèles de langage, à savoir : Anthropic, Cohere, Google, Meta, Mistral, et OpenAI.

Pour accélérer l'inférence, c'est-à-dire la vitesse des réponses, il est possible de faire appel à des fournisseurs tels que Cerebras, Groq ou encore TogetherAI.

Installer PIERRE sur votre site web

Important

Pour installer PIERRE sur votre site internet, il est indispensable de disposer d'une version fonctionnelle de PIERRE installée sur un VPS.

Via une fenêtre modale

<script crossorigin="anonymous" src="http://180.81.82.83/assets/default/dist/js/widget.js"></script>
<p
  id="pierre-ia"
  data-url="http://180.81.82.83"
  data-configuration="pierre-habitat"
  style="
        right: 20px;
        bottom: 20px;
        color: #000;
        font-size: 30px;
        font-weight: bold;
        padding: 2px 12px;
        background-color: #fff;
        border-radius: 8px;
        border: 4px solid black;
        box-shadow: 2px 2px 6px #00000080;"
>
  iA?
</p>

avec :

  • iA? : le nom d'affichage du bouton (libre à vous de le modifier)
  • style : le style CSS du bouton (libre à vous de le modifier)
  • 180.81.82.83 dans l'URL du script le domaine/IP du serveur où le script est accessible
  • data-url : le domaine/IP (sans slash de fin) du serveur où PIERRE est accessible
  • data-configuration : le nom de domaine de votre organisme qui est également le nom du répertoire que vous avez créé plus tôt dans ./assets (cf. supra) ou default pour la version par défaut.

Via une iframe

<iframe
  id="pierre"
  title="PIERRE - l'IA de Mouvement HLM"
  style="..."
  width="450"
  height="620"
  src="http://180.81.82.83/?config=pierre-habitat"
>
</iframe>

avec :

  • style : le style CSS de l'iframe (libre à vous de le modifier)
  • src : l'URL d'accès à PIERRE (libre à vous de modifier config)

Paramétrer PIERRE pour l'utiliser par SMS

  1. Obtenir un numéro de téléphone compatible
  2. Paramétrer votre webhook
  3. Modifier phone dans votre fichier config.ts avec votre numéro de téléphone

TODO/À FINALISER

Administrer PIERRE avec une interface graphique

Si vous hébergez PIERRE :

  1. Rendez-vous à l'adresse https://180.81.82.83/a (à remplacer par votre domaine/IP).
  2. Saisissez (la première fois) [email protected] et le mot de passe contenu dans la variable d'environnement AUTH_PASSWORD.
  3. Vous pouvez désormais créer autant d'utilisateurs que nécessaire (n'oubliez pas de transmettre les mots de passe !) qui pourront modifier les utilisateurs ou l'encyclopédie, consulter les conversations ou les statistiques...

Apprendre à PIERRE des connaissances (self-hosting)

PIERRE dispose — en fait — de deux bases de connaissances :

  • Une base (dite communautaire) qui correspond aux connaissances partagées universellement au sein du mouvemement HLM (ex : comment déposer une demande de logement social, qu'est-ce que le SLS, les associations d'hébergement d'urgence dans le Vaucluse, etc.).

  • Une base (dite propriétaire) qui correspond aux connaissances créées par un organisme HLM hébergeant sa propre version de PIERRE et qu'il ne souhaite pas partager avec communautaire ou qu'il souhaite faire apprendre en pleine autonomie à PIERRE (ex : des procédures internes).

Comment faire apprendre des connaissances à PIERRE ?

  1. Se connecter à https://180.81.82.83/a, puis cliquer sur Encyclopédie.
  2. Télécharger _metadata.xlsx, le compléter scrupuleusement et le ré-uploader avec les fichiers associés. Seuls les .docx (Word), .xlsx (Excel) et .md (Markdown) sont acceptés.
  3. Indispensable : Configurer config.ts de manière à permettre l'utilisation des connaissances proprietary et le protéger s'il utilise des données privées/private.
  4. C'est tout. Toutes les nuits aux alentours de 4h du matin, la base de connaissances sera automatiquement reconstruite.

[IMPORTANT] Comment réduire la durée de reconstruction de votre base de connaissances ?

La reconstruction de votre base de connaissances peut être très longue (plusieurs heures) selon la quantité de données à traiter (= transformer vos données en vecteurs de valeurs numériques).

Pour savoir si cette durée est acceptable (PIERRE n'a en effet plus connaissance de vos données durant le processus), il convient à ce stade d'essayer de générer votre base de connaissances en local tout en consultant les logs. Si la durée de reconstruction n'est pas acceptable, il est nécessaire de disposer d'un GPU d'appoint pour cette opération.

Note

PIERRE mettra prochainement en place un moyen simple de savoir si votre base de connaissances nécessite l'usage d'un GPU.

  • Option 1 : Adresser un email à [email protected] pour obtenir directement et simplement un endpoint et token à renseigner dans env.production
  • Option 2 : Louer pendant 5-15 minutes chaque jour un GPU (env. €10/mois). Pour se faire :
    • Créer un compte Hugging Face (🇫🇷) et ajouter un moyen de paiement
    • Créer un endpoint d'inférence bge-m3 en suivant ce lien :
      • Endpoint name: à votre convenance et sans importance
      • Hardware configuration: Nvidia A10G (ou équivalent) localisé au plus proche (Irlande)
      • Security Level: Protected (il vous faudra créer un token)
      • Autoscaling: vous assurer qu'il affiche scale-to-zero after 15 min
      • Cliquer sur Create endpoint.
    • Créer un token pour pouvoir utiliser le endpoint :
    • Renseigner HUGGINGFACE_ENDPOINTet HUGGINGFACE_TOKEN dans .env.production ou .env.staging avec les valeurs correspondantes.

License

Le code-source du présent dépôt est sous license GNU Affero General Public License Version 3. La base de connaissances (dossier /knowledge) est sous license Creative Commons BY-NC-SA 4.0.

Copyright (c) 2024-aujourd'hui, Charles-Henri Arnould/BECKREL ([email protected]) et les contributeurs.

About

PIERRE — Une IA open source, plurilingue et multicanale au service du mouvement HLM, de ses candidats, locataires et collaborateurs

pierre-ia.org

Topics

opensource ai chatbot opendata sms assistant ia france copilot customer-service hlm social-housing

Resources

Readme

License

AGPL-3.0 license

Code of conduct

Code of conduct
Activity

Stars

1 star

Watchers

1 watching

Forks

1 fork
Report repository

Releases 35

v.0.27.0 Latest
Jun 7, 2025
+ 34 releases

Languages