tablestore-agent-cli est l'outil en ligne de commande dédié à Knowledge Base et Memory (banque de mémoire). Utilisez-le pour gérer les ressources Knowledge Base et Memory.
Installation
Installez la CLI globalement depuis le registre npm.
Prérequis : Node.js 18 ou version ultérieure.
npm install -g @tablestore/tablestore-agent-cli --registry=https://registry.npmjs.org/
tablestore-agent-cli versionPackage npm : https://www.npmjs.com/package/@tablestore/tablestore-agent-cli.
Configuration
Utilisez la commande configure set pour enregistrer vos identifiants d'accès et les paramètres de ressources. Vous pouvez également configurer la CLI depuis le Dashboard ; consultez la section Dashboard pour plus de détails.
Obligatoire : AccessKey
Configurez l'AccessKey ID et l'AccessKey Secret de votre compte Alibaba Cloud. Pour obtenir une AccessKey, consultez la rubrique Create an AccessKey.
tablestore-agent-cli configure set access_key_id 'LTAI5t...'
tablestore-agent-cli configure set access_key_secret 'xxx'Configuration facultative
Configurez les ressources suivantes selon vos besoins.
Instance Tablestore
tablestore-agent-cli configure set ots_endpoint 'https://xxx.cn-beijing.ots.aliyuncs.com'
tablestore-agent-cli configure set ots_instance_name 'xxx'Si aucune instance Tablestore n'est configurée, la CLI crée et réutilise automatiquement une instance gérée. Pour plus de détails, consultez la section Création automatique d'instance gérée.
Pour spécifier une région, configurez le paramètre region :
tablestore-agent-cli configure set region 'cn-beijing'Bucket OSS
Seule la fonctionnalité de téléchargement de documents de Knowledge Base nécessite un bucket OSS.
Knowledge Base requiert des autorisations de lecture et d'écriture sur le bucket OSS. Pour les accorder, cliquez sur Authorize Tablestore to access OSS.
tablestore-agent-cli configure set oss_endpoint 'https://oss-cn-hangzhou.aliyuncs.com'
tablestore-agent-cli configure set oss_bucket_name 'my-bucket'Portée par défaut de Memory
Une fois la portée par défaut de Memory configurée, vous pouvez omettre les paramètres correspondants dans les commandes Memory.
tablestore-agent-cli configure set memory_store_name 'agent_memory'
tablestore-agent-cli configure set memory_app_id 'app-001'
tablestore-agent-cli configure set memory_tenant_id 'tenant-001'
tablestore-agent-cli configure set memory_agent_id 'agent-001'
tablestore-agent-cli configure set memory_run_id 'run-001'Vérification de la connectivité
Exécutez la commande doctor pour vérifier la configuration et la connectivité.
tablestore-agent-cli doctor # Full diagnosis
tablestore-agent-cli doctor kb # Knowledge Base only
tablestore-agent-cli doctor memory # Memory onlyChaque vérification renvoie pass, warn, fail ou skip. Le code de sortie est 0 si toutes les vérifications réussissent, et 1 si au moins une vérification échoue.
Si une instance Tablestore ou un bucket OSS requis n'est pas configuré, doctor crée et réutilise automatiquement une ressource gérée. Pour plus de détails, consultez la section Création automatique d'instance gérée.
Exemples
Après avoir installé et configuré la CLI, exécutez les commandes suivantes pour explorer les fonctionnalités principales de Knowledge Base et Memory.
Exemple Knowledge Base : créer une base de connaissances et télécharger un document
# Create a knowledge base
tablestore-agent-cli kb create --name my_kb --description "Product documentation knowledge base"
# Add a local document
tablestore-agent-cli kb doc-add --kb my_kb --file ./report.pdf
# Semantic search
tablestore-agent-cli kb retrieve --kb my_kb --query "System architecture design"Exemple Memory : écrire et récupérer une mémoire
# Create a memory store
tablestore-agent-cli memory create --store agent_memory --description "Long-term memory store"
# Add a memory
tablestore-agent-cli memory add --store agent_memory --app-id app-001 --text "The user likes mapo tofu"
# Retrieve memories
tablestore-agent-cli memory search --store agent_memory --app-id app-001 --tenant-id tenant-001 --query "What food does the user like" --top-k 5Dashboard
La CLI intègre un Dashboard web qui vous permet de configurer la CLI, de gérer les ressources Knowledge Base et Memory, et de déboguer la récupération de données.
Démarrer le Dashboard
tablestore-agent-cli dashboard start # Listens on 127.0.0.1:3000 by default
tablestore-agent-cli dashboard start -p 9999 # Custom port
tablestore-agent-cli dashboard start --host 0.0.0.0 # Custom bind addressUne fois le Dashboard démarré, ouvrez l'adresse affichée dans le terminal dans un navigateur.
Règles de sélection de la portée Memory
Lorsque vous ouvrez une banque de mémoires dans le Dashboard, la portée par défaut est */*/*/*. Cette portée ne prend en charge que deux opérations : lister toutes les mémoires à long terme et demander un audit.
Pour récupérer des mémoires, spécifiez AppId et TenantId. Les paramètres AgentId et RunId acceptent une valeur spécifique ou le caractère générique *.
Pour ajouter une mémoire, spécifiez une valeur pour chacun des paramètres suivants : AppId, TenantId, AgentId et RunId.
Configuration avancée
Emplacement du fichier de configuration
Le fichier de configuration est stocké à l'emplacement ~/.config/tablestore-agent-cli/config.toml.
Variables d'environnement
Les variables d'environnement sont prioritaires par rapport au fichier de configuration.
|
Variable d'environnement |
Clé de configuration |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Création automatique d'instance gérée
Si les paramètres ots_endpoint et ots_instance_name ne sont pas configurés, la CLI crée et réutilise automatiquement une instance Tablestore gérée dans la région de Pékin. L'instance est créée lors de la première exécution de la commande doctor ou lors de l'appel d'une commande nécessitant une instance. L'instance gérée utilise un endpoint public et sa création est asynchrone. La CLI met en cache le résultat dans la section [managed_ots] du fichier de configuration, afin que les commandes suivantes réutilisent la même instance. Lorsque vous définissez une cible explicite, le cache géré est automatiquement effacé.
Les buckets OSS fonctionnent de la même manière. Ils sont créés à la demande lors des flux de téléchargement, tels que doctor kb ou kb doc-add, et sont mis en cache dans la section [managed_oss] du fichier de configuration.
Gestion multi-instances
Vous pouvez enregistrer plusieurs instances nommées dans un seul fichier de configuration et basculer entre elles via la CLI ou le sélecteur situé en haut du Dashboard.
# Configure the AccessKey for a specific instance
tablestore-agent-cli configure set --instance prod access_key_id 'LTAI...'
# Switch the active instance
tablestore-agent-cli configure use prod
# Show the current configuration
tablestore-agent-cli configure showUtilisez les instances nommées pour passer d'un environnement à un autre, comme la production, la préproduction ou les tests.