weaviate cli

Waviate CLI

Eine leistungsstarke Befehlszeilenschnittstelle zum Verwalten und Interagieren mit Weaviate-Vektor-Datenbanken direkt von Ihrem Terminal.

Schlüsselmerkmale

• Sammlungen : Erstellen, aktualisieren, löschen und abrufen Sammlungskonfigurationen
• Datenverwaltung : Importieren, Abfragen, Aktualisieren und Löschen von Daten mit verschiedenen Suchtypen (Vektor, Schlüsselwort, Hybrid)
• Multi-Mieter : Verwalten Sie Mieter und ihre Staaten über Sammlungen hinweg
• Sicherung & Wiederherstellung : Erstellen und Wiederherstellen von Backups mit Unterstützung für S3, GCS und Dateisystem
• Sharding : Überwachen und Verwalten von Sammlungsschards
• Flexible Konfiguration : Konfigurieren von Vektorindizes, Replikation, Konsistenzniveaus und mehr
• Rollenverwaltung : Rollen und Berechtigungen an Benutzer zuweisen und widerrufen

Schneller Start

Mit PIP installieren:

pip install weaviate-cli

Installieren Sie auf dem Mac mit Homebrew:

brew install weaviate-cli

Grundnutzung

 # 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 " 

Kernbefehle

• Erstellen : Erstellen Sie Sammlungen, Mieter, Backups oder Importdaten
• Löschen : Kollektionen, Mieter oder Daten entfernen
• Aktualisieren : Sammlung Einstellungen, Mieterzustände oder Daten ändern
• Holen Sie sich : Sammlungsinformationen, Mietdetails oder Shard -Status abrufen
• Abfrage : Suchen Sie nach Daten mit verschiedenen Methoden
• Wiederherstellung : Wiederherstellen von Backups von unterstützten Backends wiederherstellen
• zuweisen : Weisen Sie den Benutzern Rollen und Berechtigungen zu
• Revoke : Rollen und Berechtigungen von Benutzern widerrufen

Konfiguration

Mit Weaviate CLI können Sie Ihre Cluster -Endpunkte und -Parameter über eine Konfigurationsdatei konfigurieren. Standardmäßig sucht die CLI nach einer Konfigurationsdatei unter ~/.config/weaviate/config.json . Wenn diese Datei nicht vorhanden ist, wird sie mit den folgenden Standardwerten erstellt:

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

Sie können auch Ihre eigene Konfigurationsdatei mit der Option --config-file angeben:

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

Die Konfigurationsdatei sollte eine JSON -Datei mit der folgenden Struktur sein:

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

Wenn Sie eine Remote-WEAVIATE-Instanz verwenden, können Sie den Befehl weaviate-cli verwenden, um sich mit Ihrer WEAVIATE-Instanz zu authentifizieren. Hier sehen Sie ein Beispiel, wie die Konfigurationsdatei aussehen sollte, wenn Sie eine Verbindung zu einem WCD -Cluster herstellen:

 {
     "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 "
        }
 }

Wenn Sie zulassen möchten, dass verschiedene Benutzer für verschiedene Aktionen in Ihrem Cluster verwendet werden, können Sie die verschiedenen Benutzer in der Konfigurationsdatei angeben und die Option --user verwenden, um anzugeben, welche Benutzer für eine bestimmte Aktion verwendet werden sollen. Ein Beispiel dafür, wie die Konfigurationsdatei aussehen sollte, lautet wie folgt:

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

Es ist wichtig zu beachten, dass der Schlüssel "Typ" auf "Benutzer" festgelegt werden muss und die Benutzer im Auth -Abschnitt angegeben werden müssen. Wenn Sie den Befehl weaviate-cli verwenden, können Sie den Benutzer angeben, der für eine Aktion mithilfe der Option --user verwendet wird. Zum Beispiel:

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

Anforderungen

• Python 3.10+
• Geräteinstanz (lokal oder fern)

Dokumentation

Eine detaillierte Dokumentation wird in Kürze hinzugefügt.

Unterstützter Modellanbieter

• Einbettungsservice für Weaviate (nur WCD -Cluster)
• Contuptionär
• Transformatoren
• Openai
• Ollama
• Zusammenhängen
• Jinaai

Community & Support

• Slack Community - Treten Sie unserer aktiven Gemeinschaft bei
• Stack Overflow - Suchen Sie mit dem weaviate -Tag
• GitHub -Probleme - Melden Sie Fehler oder Anfordern von Funktionen

Beitragen

Wir begrüßen Beiträge! Weitere Informationen finden Sie in unseren beitragenden Richtlinien.

Lizenz

BSD-3-Klausel-Lizenz