Interface en Ligne de Commande Breign API

Un outil CLI puissant pour interagir avec la plateforme Agentic souveraine made in Luxembourg.

Installation

Installation depuis NPM

# Installation globale depuis npm
npm install -g breign-cli

Utilisation

# Afficher l'aide
breign --help

# Afficher la configuration actuelle
breign config

# Définir l'adresse du serveur API (par défaut https://api-dev.avatar.lu)
breign config:set apiUrl https://api-dev.avatar.lu

# Se connecter à l'API (avec l'URL du serveur par défaut)
breign login

# Se connecter à l'API avec une URL de serveur personnalisée
breign login --server https://api-dev.avatar.lu

# Lister tous vos brains
breign brains

# Obtenir les détails d'un brain spécifique
breign brain <brainId>

# Créer un nouveau brain (persona requis)
breign brain:create --name "Mon Nouveau Brain" --engine openai --config '{"model":"gpt-4o-mini"}' --persona "Ceci est un assistant IA qui aide à l'analyse de données."

# Mettre à jour un brain (le persona peut être modifié)
breign brain:update <brainId> --name "Nom de Brain Mis à Jour" --persona "Nouvelle description du persona"

# Supprimer un brain
breign brain:delete <brainId>

# Configurer un brain pour les conversations (utilise un ID de flux fonctionnel connu)
breign flow:create <brainId> --promptInit "Vous êtes un assistant utile"

# Ajouter un module de connaissance à un brain
breign module:add <brainId> --name "ContextualKnowledgeWeaviate" --config '{"indexName":"my_index"}'

# Mettre à jour un module (activer/désactiver ou modifier la configuration)
breign module:update <brainId> <moduleId> --enabled false

# Lister les gardiens pour un brain
breign guardians <brainId>

# Créer un nouveau gardien
breign guardian:create <brainId> --role WORDCHECK --name "Filtre de grossièretés"

# Démarrer une session de chat interactive avec un brain
breign chat <brainId>

# Démarrer une nouvelle conversation avec un brain
breign chat:create <brainId> --message "Bonjour, comment pouvez-vous m'aider aujourd'hui ?"

# Continuer une conversation existante
breign chat:send <conversationId> --message "Dites-m'en plus à ce sujet"

# Voir tous les messages d'une conversation
breign chat:messages <conversationId>

# Convertir du texte en parole
breign tts --text "Bonjour, ceci est un test" --output discours.mp3

# Convertir de la parole en texte
breign stt --file enregistrement.mp3

# Télécharger un fichier dans la base de connaissances d'un brain
breign file:upload <brainId> --file document.pdf

# Lister tous les fichiers dans la base de connaissances d'un brain
breign files <brainId>

# Obtenir les détails d'un fichier spécifique
breign file <brainId> <fileId>

# Supprimer un fichier
breign file:delete <brainId> <fileId>

# Exécuter des tests de diagnostic pour la connectivité API
breign diagnostic

# Activer le mode verbose avec n'importe quelle commande pour le débogage
breign -v <command>

Configuration

Le CLI stocke la configuration dans un fichier local :

• Clé API (obtenue lors de la connexion)
• URL API (par défaut https://api-dev.avatar.lu)
• Adresse e-mail

Vous pouvez modifier la configuration en utilisant les commandes config :

# Voir la configuration actuelle
breign config

# Définir l'URL du serveur API
breign config:set apiUrl https://votre-serveur-personnalise.com

# Effacer toute la configuration
breign config:set clear true

Alternativement, vous pouvez modifier la configuration directement en éditant le fichier situé à :

• macOS/Linux : ~/.config/brain-api-cli/config.json
• Windows : %APPDATA%\brain-api-cli\config.json

Note : Le chemin réel peut inclure breign au lieu de brain-api-cli selon l'installation.

Spécifier le Serveur API

Vous pouvez spécifier le serveur API de plusieurs façons :

1. Le définir globalement pour toutes les commandes :

   breign config:set apiUrl https://votre-serveur-api.com

2. Le spécifier lors de la connexion :

   breign login --server https://votre-serveur-api.com

3. Utiliser la valeur par défaut (https://api-dev.avatar.lu) si non spécifié

Commandes

Authentification

• login : Se connecter à l'API Brain en utilisant l'authentification par e-mail
• logout : Se déconnecter de l'API Brain

Brains

• brains : Lister tous les brains accessibles
• brain <id> : Obtenir les détails d'un brain spécifique
• brain:create : Créer un nouveau brain (nécessite un nom, un moteur et un persona)
• brain:update <id> : Mettre à jour un brain existant (nom, description, moteur ou persona)
• brain:delete <id> : Supprimer un brain

Flux

• flow:create <brainId> : Configurer un brain pour les conversations (modèle de prompt et flux)

Modules

• module:add <brainId> : Ajouter un module à un brain (par exemple, module de connaissance)
• module:update <brainId> <moduleId> : Mettre à jour la configuration ou le statut d'un module

Gardiens (Modération de Contenu)

• guardians <brainId> : Lister les gardiens d'un brain
• guardian:create <brainId> : Créer un nouveau gardien
• guardian:update <brainId> <guardianId> : Mettre à jour un gardien
• guardian:delete <brainId> <guardianId> : Supprimer un gardien

Conversations

• chat <brainId> : Démarrer une session de chat interactive avec un brain
• chat:create <brainId> : Créer une nouvelle conversation
• chat:send <conversationId> : Envoyer un message à une conversation existante
• chat:messages <conversationId> : Voir tous les messages d'une conversation

Outils

• tts : Convertir du texte en parole
• stt : Convertir de la parole en texte

Fichiers de Base de Connaissances

• files <brainId> : Lister les fichiers dans la base de connaissances d'un brain
• file:upload <brainId> : Télécharger un fichier dans la base de connaissances d'un brain
• file <brainId> <fileId> : Obtenir les détails d'un fichier
• file:delete <brainId> <fileId> : Supprimer un fichier