Command-line interface for NautilusDB
Project description
nautilusdb-cli
A command-line tool for NautilusDB, a fully-managed, cloud-native vector search service.
NautilusDB is currently in public alpha. We're actively improving the product and releasing new features and we'd love to hear your feedback! Please take a moment to fill out this feedback form to help us understand your use-case better.
By default, all collections are subject to permanent deletion after 2 weeks. Please let us know if you need to keep it for longer via the feedback form.
Quickstart
You can try out NautilusDB right away. We have prepared a special public
collection openai-web
that can answer questions about the contents of www.openai.com
nautiluscli ask openai-web "what is red team?"
Installation
Install a released NautilusDB cli from pip.
python3 version >= 3.10
is required
pip3 install nautiluscli
Examples:
Create a new API key
You can create a new API key and set it in NAUTILUSDB_API_KEY
environment variable. NautilusDB will use this key to authorize access to
collections.
nautiluscli create-api-key
export NAUTILUSDB_API_KEY='<key>'
Check the current CLI configuration
nautiluscli info
Create a new Collection
Create a new collection myCollection
in the shared demo account.
A collection will be created that is only accessible to the configured API key.
nautiluscli create-collection myCollection
List Collections
See the list of Collection accessible to you, including myCollection
that you just created.
nautiluscli list-collections
Upload file from URL
Index a PDF into myCollection
. In this example, we will index the original research paper on Transformers.
nautiluscli upload-file myCollection https://arxiv.org/pdf/1706.03762.pdf
Upload local file
Alternatively, upload a PDF from local file system for indexing.
nautiluscli upload-file myCollection README.md
Ask questions
You can now ask questions within the context of a collection and get answers.
nautiluscli ask myCollection "what is a transformer?"
Delete the Collection
You can optionally delete the collection. Deletions are non-reversible.
nautiluscli delete-collection myCollection
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for nautiluscli-0.5.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 555bbcb6b5f5ef2bb9775950c98d3d39c902a7f4a7424cc5221575bf6994c850 |
|
MD5 | 65e83ff0d79050b661be68c24e15e46b |
|
BLAKE2b-256 | 4970045f1fb47b3837ca0d63aff00d1aa1b43179a6be990df1a71eeb50117b9d |