Skip to content
Snippets Groups Projects
Commit ffd676b3 authored by David Dorchies's avatar David Dorchies :zany_face:
Browse files

docs: update README

parent ae4eca27
Branches
No related tags found
No related merge requests found
......@@ -11,7 +11,9 @@ en exploitant des données structurées.
## Description
Ce projet implémente un système RAG (Retrieval Augmented Generation) permettant d'interroger le référentiel G-EAU via une interface chatbot. Il se compose de deux modules principaux :
Ce projet implémente un système RAG (Retrieval Augmented Generation) permettant
d'interroger le référentiel G-EAU via une interface chatbot. Il se compose de
deux modules principaux :
1. **Indexation** : Script qui indexe le contenu du site YesWiki dans une base ChromaDB
2. **Chatbot** : Service web permettant d'interroger le référentiel via une interface conversationnelle
......@@ -56,12 +58,12 @@ HOST_PORT="8086"
JSON_SOURCE_URL="https://yeswiki.net/?api/pages|https://yeswiki.net/?api/entries"
```
Seuls, `OLLAMA_API_URL` et `MODEL_NAME` doivent obligatoirement être définis par
l'utilisateur.
`PERSIST_DIRECTORY="./db"` et `HOST_PORT="8086"` correspondent aux valeurs par
défaut respectives de ces paramètres si non définis.
`OLLAMA_API_URL` et `MODEL_NAME` doivent être définis par
l'utilisateur pour renseigner respectivement l'URL de l'API OpenAI-compatible et le nom du modèle utilisé.
`JSON_SOURCE_URL` contient les URL des endpoints de l'API à interroger (ici les
pages et les fiches Bazaar de https://yeswiki.net).
`PERSIST_DIRECTORY="./db"` et `HOST_PORT="8086"` correspondent aux valeurs par
défaut respectives de ces paramètres si non définis.
# Utilisation
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment