weaviate cli

CLIを織ります

端末から直接ベクトルデータベースを管理および対話するための強力なコマンドラインインターフェイス。

重要な機能

• コレクション：コレクション構成を作成、更新、削除、取得します
• データ管理：さまざまな検索タイプ（ベクター、キーワード、ハイブリッド）でデータをインポート、クエリ、更新、削除
• マルチテナント：コレクション全体でテナントとその州を管理します
• バックアップと復元：S3、GCS、ファイルシステムをサポートしてバックアップを作成および復元する
• シャード：コレクションシャードを監視および管理します
• 柔軟な構成：ベクトルインデックス、複製、一貫性レベルなどを構成する
• 役割管理：ユーザーに役割と許可を割り当てて取り消す

クイックスタート

PIPを使用してインストール：

pip install weaviate-cli

Macで、HomeBrewを使用してインストールしてください：

brew install weaviate-cli

基本的な使用法

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

コアコマンド

• 作成：コレクション、テナント、バックアップ、またはインポートデータを作成します
• 削除：コレクション、テナント、またはデータを削除します
• 更新：収集設定、テナントの状態、またはデータを変更します
• 取得：コレクション情報、テナントの詳細、またはシャードステータスを取得する
• クエリ：さまざまな方法を使用してデータを検索します
• 復元：サポートされているバックエンドからバックアップを復元します
• 割り当て：ユーザーに役割と権限を割り当てます
• 取り消し：ユーザーからの役割と許可を取り消します

構成

Weaviate CLIを使用すると、構成ファイルを介してクラスターエンドポイントとパラメーターを構成できます。デフォルトでは、CLIは~/.config/weaviate/config.jsonで構成ファイルを探します。このファイルが存在しない場合、次のデフォルト値で作成されます。

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

--config-fileオプションを使用して、独自の構成ファイルを指定することもできます。

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

構成ファイルは、次の構造を持つJSONファイルである必要があります。

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

リモートWeaviateインスタンスを使用している場合は、 weaviate-cliコマンドを使用して、Weaviateインスタンスで認証できます。ここでは、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 "
        }
 }

クラスター内の異なるアクションに異なるユーザーを使用することを許可する場合は、構成ファイルで異なるユーザーを指定し、 --userオプションを使用して、特定のアクションに使用するユーザーを指定できます。構成ファイルがどのように見えるかの例は次のとおりです。

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

「タイプ」キーを「ユーザー」に設定する必要があり、ユーザーをAUTHセクションで指定する必要があることに注意することが重要です。 weaviate-cliコマンドを使用する場合、ユーザーは、 --userオプションを使用してアクションに使用するように指定できます。例えば：

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

要件

• Python 3.10+
• インスタンス（ローカルまたはリモート）を織ります

ドキュメント

詳細なドキュメントがまもなく追加されます。

サポートされているモデルプロバイダー

• 埋め込みサービス（WCDクラスターのみ）をWeaviate
• コンテキスト
• トランス
• Openai
• オラマ
• 協力します
• ジナイ

コミュニティとサポート

• Slackコミュニティ - アクティブなコミュニティに参加してください
• スタックオーバーフロー - weaviateタグを使用して検索します
• GitHubの問題 - バグを報告するか、機能を要求します

貢献

貢献を歓迎します！詳細については、貢献ガイドラインをご覧ください。

ライセンス

BSD-3-Clauseライセンス