Agent Bricks CLI
Beta
Cette fonctionnalité est en bêta. Aucun paramètre de workspace n'est requis pour l'activer. Installez l'Agent Bricks CLI pour start.
L'Agent Bricks CLI (databricks-agentbricks) est un outil de ligne de commande Databricks destiné aux développeurs qui créent et déploient des agents personnalisés dans le code.
L'Agent Bricks CLI offre une approche orientée code pour créer des agents personnalisés depuis le terminal. L'Agent Bricks CLI génère la structure d'un projet à l'aide d'un framework intégré fondé sur les bonnes pratiques de Databricks. Il peut ensuite exécuter le projet localement à des fins de test et le déployer sur le runtime d'agent Databricks. La CLI vous permet de passer d'un répertoire vide à un agent déployé sans configurer manuellement le runtime, les outils, la mémoire et les ressources gérées. Pour découvrir d'autres méthodes de création d'agents personnalisés, notamment le workflow basé sur des applications, consultez la page Créer un agent et le déployer sur Databricks Apps.
Prérequis
-
La CLI Databricks, installée et accessible via votre variable PATH.
-
Python 3.10 ou supérieur, avec
pip. -
Installez la CLI Agent Bricks :
Bashpip install databricks-agentbricks
Le cycle de vie de la CLI Agent Bricks
L'interface CLI Agent Bricks génère automatiquement une structure de répertoire locale contenant du code d'agent déployable à partir d'un template de framework, avec le runtime, les tests et une interface de chat facultative déjà configurés. Vous écrivez la logique de l'application (modèle, outils et prompts), et la CLI se charge de son exécution locale et de son déploiement sur l'infrastructure Databricks.
agent.toml est la source de vérité déclarative pour toutes les ressources gérées par Databricks dont dépend votre agent : liaisons d’outils (sandbox de données, services MCP [Model Context Protocol] gérés, fonctions Unity Catalog) et ressources de mémoire, de session et de suivi. agentbricks deploy lit le fichier pour assurer le provisionnement et la configuration de l’ensemble, ce qui signifie que c’est le fichier, et non un code de configuration rédigé manuellement, qui fait l’objet du déploiement.
Les trois commandes permettant de faire passer un agent d'un répertoire vide à la production :
agentbricks initcrée l'ossature du projet à partir d'un bundled Template, en alimentant éventuellement un fichier.envavec un profil Databricks afin que le projet s'exécute immédiatement.agentbricks devexécute l'agent localement par rapport au service de modèles Databricks pour vous permettre de le tester avant le déploiement.agentbricks deployeffectue le provisionnement des ressources déclarées dansagent.tomlet déploie l'agent sur l'environnement d'exécution de l'agent Databricks.
Vous pouvez également ajouter des outils et lier des magasins de mémoire et de session à tout moment, et pas seulement lors de l’initialisation. Utilisez agentbricks tools add, agentbricks memory bind et agentbricks sessions bind pour mettre à jour la configuration de votre agent entre l’une de ces étapes.
Fonctionnalités de l'interface CLI Agent Bricks
Compétence | Description |
|---|---|
Accès aux modèles | La CLI Agent Bricks effectue automatiquement le provisionnement de l'accès aux modèles afin que votre agent puisse appeler un modèle hébergé par Databricks sans gérer d'informations d'identification ni d'endpoints. Voir les API Databricks Foundation Model. |
Mémoire gérée | Mémoires à long terme qu'un agent peut écrire et rechercher, partitionnées par acteur et prises en charge par des magasins gérés. Utilisez la mémoire pour faire persister les faits et les préférences d'une session à l'autre. Consultez Mémoire d'agent gérée. |
Sessions gérées | Transcriptions de conversations conservées dans des stockages de session gérés et partitionnées par acteur, avec la prise en charge de la division des sessions en copies indépendantes. Consultez les sessions d’agent gérées. |
Outils | Fonctionnalités gérées par Databricks déclarées dans |
Traçage | Traçage MLflow activé par default, qui achemine les traces de chaque exécution vers une Experimentation MLflow par projet à des fins de debugging et de monitoring. Consultez la section Présentation du traçage. |
Déploiement | Déploie un agent sur l'environnement d'exécution de l'agent Databricks, octroie au service principal de l'agent l'accès aux stockages liés et gère le cycle de vie du déploiement. |
Étape 1 : s'authentifier avec OAuth et enregistrer un profil
L'Agent Bricks CLI utilise l'authentification par CLI Databricks. Authentifiez-vous sur votre workspace avec OAuth (utilisateur à machine) et enregistrez les identifiants sous forme de profil nommé.
Pour start le flux OAuth, exécutez la commande suivante en remplaçant l'hôte par l'URL de votre workspace. La commande ouvre un navigateur pour terminer la connexion, puis écrit le profil dans ~/.databrickscfg:
databricks auth login --host https://<your-workspace-url> --profile <profile>
Pour définir ce profil comme profil par default de la CLI afin que les commandes ultérieures puissent omettre --profile, exécutez la commande suivante :
agentbricks login --profile <profile>
agentbricks login valide les identifiants du profil. S'ils sont manquants ou rejetés, la CLI relance databricks auth login et effectue une nouvelle tentative.
Étape 2 : créez le projet d’agent
Générez un nouveau projet d'agent et transmettez --framework pour choisir le template. Cet exemple utilise le template LangGraph, qui inclut une application de chat par navigateur :
agentbricks init --framework langgraph my-agent
cd my-agent
La CLI intègre un Template fourni par framework et --framework sélectionne celui à déployer : langgraph pour LangGraph ou openai pour le SDK OpenAI Agents. La CLI écrit les ressources gérées et les liaisons d'outils du projet dans agent.toml et la provenance du Template dans .agentbricks/project.toml. Pour générer le backend compatible uniquement avec l'API sans l'application de chat, ajoutez --disable-chat-app.
Étape 3 : Associer les magasins de sessions et de mémoire gérés
Liez des stockages gérés afin que votre agent puisse conserver l'historique des conversations et la mémoire à long terme. Chaque commande enregistre le nom du stockage dans agent.toml et crée le stockage s'il n'existe pas.
Pour lier un magasin de sessions et un magasin de mémoire, exécutez la commande suivante :
agentbricks sessions bind my-agent-sessions
agentbricks memory bind my-agent-memory
Étape 4 : Afficher le traçage
Le traçage est activé par default. agentbricks init lie une expérimentation MLflow /Shared/agentbricks_traces/<project> par default, et agentbricks dev et agentbricks deploy y envoient les traces de chaque run.
Pour lister les traces une fois que votre agent en a produit, exécutez la commande suivante :
agentbricks tracing list
Pour lier une expérimentation MLflow spécifique, exécutez agentbricks tracing bind --experiment-id <experiment-id>. Pour désactiver le traçage, exécutez agentbricks tracing unbind.
Étape 5 : Exécuter l'agent localement
Exécutez l'agent sur votre machine pour le tester avant le déploiement.
agentbricks dev
Cette commande permet de démarrer un serveur local sur le port 8000 en utilisant la même commande et le même environnement que le runtime de l'agent Databricks. L'interface CLI Agent Bricks connecte l'agent au service de modèles Databricks afin qu'il puisse appeler le modèle localement. Le Template définit un modèle par default comme valeur MODEL dans agent/agent.py. Pour utiliser un autre modèle, modifiez cette valeur. Envoyez des requêtes à http://localhost:8000 pour interagir avec l'agent.
Étape 6 : Déployez l’agent
Déployez l’agent dans le runtime d’agent Databricks. La CLI assure le provisionnement des magasins liés, accorde au Service Principal de l’agent l’accès à ces derniers et déploie l’application. L’agent déployé s’appelle agent-bricks-<name>.
agentbricks deploy my-agent
Une fois le déploiement terminé, la CLI renvoie l'URL du déploiement. Ouvrez cette URL pour interagir avec votre agent en direct, qui est automatiquement connecté au service des modèles Databricks. Pour gérer le déploiement par la suite, utilisez les commandes agentbricks deployments, telles que agentbricks deployments logs et agentbricks deployments stop.
Référence des commandes
Pour consulter la référence complète et actualisée des commandes, comprenant l'ensemble des commandes et des options, rendez-vous sur le fichier README de la CLI Agent Bricks sur GitHub.
Ressources supplémentaires
- Outils d'agent et services MCP : les MCP et les outils d'agent.
- Concepts de mémoire d'agent gérée et API : Mémoire d'agent gérée.
- Concepts des sessions d'agent gérées et API : Sessions d'agent gérées.
- MLflow Tracing pour les agents : Présentation du traçage.