weaviate cli Téléchargement - weaviate cli WeAviate CLI

weaviate cli

Autre code source

v3.1.0

Télécharger

Timer la CLI

Une puissante interface de ligne de commande pour gérer et interagir avec les bases de données vectorielles de Weavate directement à partir de votre terminal.

Caractéristiques clés

Collections : créer, mettre à jour, supprimer et obtenir des configurations de collection
Gestion des données : Importer, requérir, mettre à jour et supprimer les données avec divers types de recherche (vecteur, mot-clé, hybride)
Multi-location : gérer les locataires et leurs États à travers les collections
Sauvegarde et restauration : Créez et restaurez les sauvegardes avec la prise en charge de S3, GCS et Système de fichiers
Sharding : surveiller et gérer les éclats de collecte
Configuration flexible : configurer les index vectoriels, la réplication, les niveaux de cohérence et plus encore
Gestion des rôles : attribuer et révoquer les rôles et les autorisations aux utilisateurs

Démarrage rapide

Installer à l'aide de PIP:

pip install weaviate-cli

Sur Mac, installez à l'aide de Homebrew:

brew install weaviate-cli

Utilisation de base

 # Show available commands
weaviate-cli --help

# Create a collection
weaviate-cli create collection --collection movies --vectorizer transformers

# Import test data
weaviate-cli create data --collection movies --limit 1000

# Query data
weaviate-cli query data --collection movies --search-type hybrid --query " action movies "

Commandes de base

Créer : créer des collections, des locataires, des sauvegardes ou des données d'importation
Supprimer : supprimer les collections, les locataires ou les données
Mise à jour : modifier les paramètres de collecte, les états des locataires ou les données
Obtenez : Récupérer les informations de la collection, les détails des locataires ou le statut de fragment
Requête : recherche de données à l'aide de diverses méthodes
Restaurer : restaurer les sauvegardes des backends pris en charge
Attribution : attribuez des rôles et des autorisations aux utilisateurs
Revoke : révoquer les rôles et les autorisations des utilisateurs

Configuration

Weavate CLI vous permet de configurer les points de terminaison et les paramètres de votre cluster via un fichier de configuration. Par défaut, la CLI recherche un fichier de configuration sur ~/.config/weaviate/config.json . Si ce fichier n'existe pas, il sera créé avec les valeurs par défaut suivantes:

{
    "host" : " localhost " ,
    "http_port" : " 8080 " ,
    "grpc_port" : " 50051 "
}

Vous pouvez également spécifier votre propre fichier de configuration à l'aide de l'option --config-file :

weaviate-cli --config-file /path/to/your/config.json

Le fichier de configuration doit être un fichier JSON avec la structure suivante:

{
    "host" : " your-weaviate-host " ,
    "http_port" : " your-http-port " ,
    "grpc_port" : " your-grpc-port " ,
    "auth" : {
        "type" : " api_key " ,
        "api_key" : " your-api-key "
    }
}

Si vous utilisez une instance WeAviate à distance, vous pouvez utiliser la commande weaviate-cli pour s'authentifier avec votre instance WeAviate. Ici, vous pouvez voir un exemple sur la façon dont le fichier de configuration devrait ressembler si vous vous connectez à un cluster WCD:

 {
     "host" : " thisisaninventedcluster.url.s3.us-west3.prov.weaviate.cloud " ,
     "auth" : {
         "type" : " api_key " ,
         "api_key" : " jfeRFsdfRfSasgsDoNOtTrYToUsErRQwqqdZfghasd "
     },
    "headers" :{
        "X-OpenAI-Api-Key" : " OPEN_AI_KEY " ,
        "X-Cohere-Api-Key" : " Cohere_AI_KEY " ,
        "X-JinaAI-Api-Key" : " JINA_AI_KEY "
        }
 }

Si vous souhaitez autoriser l'utilisation de différents utilisateurs pour différentes actions dans votre cluster, vous pouvez spécifier les différents utilisateurs dans le fichier de configuration et utiliser l'option --user pour spécifier quel utilisateur utiliser pour une action spécifique. Un exemple de la façon dont le fichier de configuration devrait ressembler est le suivant:

{
    "host" : " your-weaviate-host " ,
    "auth" : {
        "type" : " user " ,
        "user1" : " your-api-key-for-user1 " ,
        "user2" : " your-api-key-for-user2 "
    }
}

Il est important de noter que la clé "Type" doit être définie sur "utilisateur" et que les utilisateurs doivent être spécifiés dans la section AUTH. Lorsque vous utilisez la commande weaviate-cli , vous pouvez spécifier l'utilisateur à utiliser pour une action en utilisant l'option --user . Par exemple:

weaviate-cli --user user1 create collection --collection movies --vectorizer transformers
weaviate-cli --user user2 get collection --collection movies