Skip to content

Commit 89adeee

Browse files
committed
Add detailed documentation on CyberBuddy architecture and workflows in README
1 parent 165f39a commit 89adeee

1 file changed

Lines changed: 59 additions & 0 deletions

File tree

README.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,65 @@ des messageries [Telegram](https://telegram.org) et [WhatsApp](https://www.whats
143143
> [!WARNING]
144144
> Pour activer cette fonctionnalité dans la version auto-hébergée, vous devrez fournir votre propre clé d'API DeepInfra.
145145
146+
## Fonctionnement
147+
148+
CyberBuddy est au coeur de l'expérience Cywise. Il agit comme un orchestrateur intelligent capable de comprendre vos
149+
demandes en langage naturel et d'y répondre en interrogeant différentes sources de données.
150+
151+
```text
152+
UTILISATEUR MESSAGERIES CYWISE WEBHOOK CYBERBUDDY (IA)
153+
+----------+ +-------------+ +-------------------+ +--------------------------------+
154+
| Mobile | <----> | - Telegram | <----> | - Validation | <--> | - Orchestrateur |
155+
| App | | - WhatsApp | | - Mapping Thread | | - AgentSquad |
156+
+----------+ +-------------+ +-------------------+ | - Thought/Action/Observation |
157+
+---------------+----------------+
158+
|
159+
+------------------------+------------------------+-----------------------------+
160+
| | | |
161+
v v v v
162+
[ DONNÉES STRUCTURÉES ] [ BASE DE CONNAISSANCES ] [ ACTIONS LOCALES ] [ ACTIONS DISTANTES ]
163+
164+
+-----------------------+ +-----------------------+ +--------------------------+ +---------------------------------+
165+
| TABLES ANALYTIQUES | | RECHERCHE HYBRIDE | | API INTERNE JSON-RPC | | APIS EXTERNES JSON-RPC |
166+
| (ClickHouse) | | (MariaDB / RAG) | | (Annotations) | | (HTTP Request) |
167+
+-----------------------+ +-----------------------+ +------------+-------------+ +---------------------------------+
168+
| - Tables de données | | - Collections | | | - URL & Headers |
169+
| - Génération SQL | | - Documents / Chunks | v | - Payload JSON |
170+
| - Résultats TSV | | - Vecteurs (Cosine) | +--------------------------+ | - Response JSON |
171+
+-----------------------+ +-----------------------+ | PROCÉDURES JSON-RPC | +---------------------------------+
172+
+--------------------------+
173+
| - #[RpcMethod] |
174+
| - Payload JsonRequest |
175+
| - Response array |
176+
+--------------------------+
177+
```
178+
179+
Le schéma ci-dessus illustre le flux de traitement d'une demande. Par exemple, si vous envoyez dans votre client de
180+
messagerie « surveille www.example.com », CyberBuddy :
181+
- identifie votre intention ;
182+
- choisit l'action appropriée, ici `assets@create` ;
183+
- appelle la procédure JSON-RPC de création de l'actif avec le domaine fourni ;
184+
- confirme la mise en place de la surveillance après avoir reçu la réponse de la procédure.
185+
186+
Les composants clefs de cette architecture sont :
187+
188+
- **CyberBuddy.** A partir de votre demande en langage naturel, planifie les outils à appeler pour atteindre votre
189+
objectif. Par exemple :
190+
- « Quelles sont mes priorités ce matin ? »
191+
- **Données structurées.** Utilise ClickHouse pour effectuer des analyses complexes et des calculs statistiques sur de
192+
grands volumes de données techniques (fuites de données ou imports de vos données tabulaires). Par exemple :
193+
- « Quels sont mes identifiants fuités ? »
194+
- **Base de connaissance.** Système de RAG (Retrieval Augmented Generation) qui fouille dans vos documents (Chartes
195+
informatiques, PSSI, PDF) par recherche sémantique pour vous renvoyer des réponses factuelles et sourcées. Par exemple :
196+
- « Comment isoler un serveur compromis d'après nos procédures ? »
197+
- **Actions locales.** Permettent de piloter directement les fonctionnalités de Cywise via ses API JSON-RPC. Par exemple :
198+
- « Surveille www.example.com »
199+
- « Envoie-moi un rapport de sécurité tous les mercredi à 11h. »
200+
- **Actions distantes.** Permettent à Cywise d'interagir avec des systèmes tiers (SIEM, outils de ticketing, Cloud) en
201+
consommant leurs API JSON-RPC. Par exemple :
202+
- « Ouvre un ticket Jira pour cette vulnérabilité »
203+
- « Liste mes instances actives sur AWS. »
204+
146205
## Divers
147206

148207
### Fond documentaire

0 commit comments

Comments
 (0)