weaviate cli

Weaviate CLI

Мощный интерфейс командной строки для управления и взаимодействия с базами данных векторов Weaviate непосредственно из вашего терминала.

Ключевые функции

• Коллекции : создавать, обновить, удалять и получить конфигурации сбора
• Управление данными : импорт, запрос, обновление и удаление данных с различными типами поиска (Vector, Keyword, Hybrid)
• Multianancy : управлять арендаторами и их государствами в разных коллекциях
• Резервное копирование и восстановление : создать и восстановить резервные копии с поддержкой 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 " 

Основные команды

• Создать : Создать коллекции, арендаторов, резервное копирование или импортные данные
• Удалить : удалить коллекции, арендаторов или данные
• Обновление : изменить настройки сбора, состояния арендатора или данные
• GET : получить информацию о сборе, подробности арендатора или статус осколков
• Запрос : данные поиска с использованием различных методов
• Восстановление : восстановить резервные копии из поддерживаемых бэкэндов
• Назначить : назначить роли и разрешения пользователям
• Отменить : отозвать роли и разрешения от пользователей

Конфигурация

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+
• Приятный экземпляр (локальный или удаленный)

Документация

Подробная документация будет добавлена ​​в ближайшее время.

Поддерживаемый поставщик моделей

• Служба внедрения Weaviate (только кластеры WCD)
• Contextyary
• Трансформеры
• Openai
• Оллама
• Кожух
• Джинааи

Сообщество и поддержка

• Slack Community - Присоединяйтесь к нашему активному сообществу
• Переполнение стека - поиск с использованием тега weaviate
• Проблемы GitHub - отчет об ошибках или функциях запроса

Внося

Мы приветствуем вклад! Пожалуйста, смотрите наши рекомендации для получения подробной информации.

Лицензия

Лицензия BSD-3-CLAUSE