Qu’est-ce que Layerum
Layerum est une plateforme RAG hébergée pour les équipes qui doivent ingérer des connaissances, contrôler l’accès par espace de travail et fournir des réponses fiables via API ou SDK.
- Endpoint hébergé : https://api.layerum.com.
- Contrat public : /v1/*.
- Authentification : clés API d’espace de travail (lyr_wk_...).
Modèle d’espace de travail
Chaque équipe travaille dans des espaces isolés. Les permissions, modèles, entités, documents et clés API sont gérés au niveau de l’espace de travail.
- Plusieurs espaces de travail par compte selon l’abonnement.
- Les membres, rôles et limites opérationnelles restent dans l’espace.
- Les clés API peuvent être limitées aux entités et configurations de modèles.
Modèle de données
Les connaissances sont organisées pour assurer la gouvernance et la précision de récupération.
- Les types d’entités définissent les catégories principales.
- Les entités forment la hiérarchie et la portée de récupération.
- Les documents sont associés aux entités et indexés en segments/vecteurs.
Cycle d’ingestion
Les documents suivent un flux prévisible : upload, parsing, découpage, embedding, indexation et suivi du statut.
- Petits fichiers : upload direct via API multipart.
- Gros fichiers : flux presigné (upload/init → S3 POST → upload/complete).
- Statuts : pending, processing, completed, failed.
- Le SDK ingestion.waitUntilReady gère le polling jusqu’à complétion.
Contrôle de capacité
La capacité est définie au niveau du compte selon le plan et distribuée dynamiquement entre espaces. L’application est côté serveur pour UI, API et SDK.
- Utilisation comptabilisée : entités, taille des documents, chunks, fichiers S3 liés, uploads en attente.
- Non comptabilisé : logs, métadonnées API et modèles.
- Uploads presignés sécurisés avec validation et nettoyage des sessions expirées.
Sécurité et gouvernance
L’accès est explicite, limité et révocable à tout moment.
- Les clés API sont créées et gérées dans l’interface Layerum.
- Modèle de capacités : query:read, data:ingest, config:manage.
- Contrôles : portée des entités/modèles, limites RPM, tokens/jour, expiration.
- Rotation et révocation immédiates sans changer l’architecture.
Qualité de récupération
Le comportement des requêtes est conçu pour des réponses contrôlables et explicables.
- Récupération limitée par entité.
- Options Top-K et portée parent pour ajuster.
- Citations pour tracer les réponses aux sources.
- Endpoint debug pour analyse avancée.
Expérience développeur
Intégration possible via SDK typé ou HTTP direct avec le même contrat public.
- SDK : @layerum-team/rag-sdk.
- API publique : https://api.layerum.com/v1.
- Même modèle d’authentification et limites.
import { LayerumClient } from '@layerum-team/rag-sdk';
const client = new LayerumClient({
apiKey: process.env.LAYERUM_API_KEY!,
baseUrl: 'https://api.layerum.com'
});
const source = await client.documents.uploadDirect({
entityId: '<entity_uuid>',
file,
fileName: 'knowledge.pdf',
contentType: 'application/pdf'
});
await client.ingestion.waitUntilReady({
entityId: '<entity_uuid>',
sourceId: source.id
});
const answer = await client.query.run({
entityId: '<entity_uuid>',
modelConfigId: '<model_config_uuid>',
query: 'Résumer les principaux risques et actions'
});Opérations et fiabilité
La plateforme est conçue pour un comportement stable en production et une bonne observabilité.
- Les erreurs d’ingestion sont persistées et accessibles via API/SDK.
- Endpoints de retry pour récupération déterministe.
- Indexation vectorielle liée au cycle de vie des documents.
- Contrôle de capacité pour éviter une croissance incontrôlée.
Cas d’usage typiques
- Assistants de support client internes.
- Recherche documentaire privée.
- Accès aux politiques de conformité avec citations.
- Copilotes d’équipe connectés à des domaines spécifiques.
Démarrer
- 1. Créer un espace de travail et configurer les modèles.
- 2. Créer une clé API et définir les permissions.
- 3. Structurer les entités et uploader les documents.
- 4. Attendre l’ingestion puis lancer des requêtes via SDK ou API.
Voir la section Référence pour les détails complets des endpoints. Référence.