vectara-cli 0.1.14

A CLI tool for interacting with the Vectara platform, including advanced text processing and indexing features.

vectara-cli

vectara-cli is a Python package designed to interact with the Vectara platform, providing a command-line interface (CLI) and a set of APIs for indexing and querying documents, managing corpora, and performing advanced text analysis and processing tasks. This package is particularly useful for developers and data scientists working on search and information retrieval applications.

Features

• Indexing text and documents into Vectara corpora.
• Querying indexed documents.
• Creating and deleting corpora.
• Advanced text processing and analysis using pre-trained models (optional advanced package).

Get Started

Get started with the example_notebooks here by downloading them and running them locally on any laptop.

Basic Installation

The basic installation includes the core functionality for interacting with the Vectara platform.

pip install vectara-cli

Advanced Installation

The advanced installation includes additional dependencies for advanced text processing and analysis features. This requires PyTorch, Transformers, and Accelerate, which can be substantial in size.

pip install vectara-cli[advanced]

Ensure you have an appropriate PyTorch version installed for your system, especially if you're installing on a machine with GPU support. Refer to the official PyTorch installation guide for more details.

Command Line Interface (CLI) Usage

The vectara-cli provides a powerful command line interface for interacting with the Vectara platform, enabling tasks such as document indexing, querying, corpus management, and advanced text processing directly from your terminal. This section will guide you through the basics of using the vectara-cli.

Configuration

Before your start always set your api keys with :

vectara set-api-keys <user_id> <api_key>

• More About Configuration

Usage

• Basic Usage CLI
• Programmatic Usage
• Advanced Usage

Deploy Your App

• vectara create-ui: This command will create a new UI for your app.

Note: that this script assumes you have Node.js and NPM installed on your system, as required by the npx command.

Contributing

• CONTRIBUTE
• Testing

License

vectara-cli is MIT licensed. See the LICENSE file for more details.

@misc{Vectara Cli,
  author = {p3nGu1nZz, Tonic},
  title = {Vectara Cli is a Python package for Vectara platform interaction, ideal for search and information retrieval tasks.},
  year = {2024},
  publisher = {Tonic-AI},
  journal = {Tonic-AI repository},
  howpublished = {\url{https://git.tonic-ai.com/releases/vectara-cli}}
}