LilPalantir

A simple command-line tool to empower fast querying of local knowledge on your machine via CLI, built on top of the LlamaIndex.

Documentation

LilPalantir is designed to facilitate quick and efficient access to a vast array of local knowledge. It leverages advanced AI models like GPT-3.5-Turbo and GPT-4-Turbo to interpret and respond to natural language queries, providing insights and information stored locally on your machine.

Getting Started

To get started, you can leverage the install.sh script for MacOS and Linux, or install.bat for Windows, to run a full install of all the requirements for the script to work out of the box. Remember to give the script execution rights by running chmod +x install.sh on Linux and MacOS machines.

Installation

# For MacOS and Linux
chmod +x install.sh
./install.sh

# For Windows
install.bat

Consuming the Local Knowledge

To feed information to LilPalantir, you need to provide a folder where your data resides. Use the loader.py script to process this data.

Loading Data

loader.py /path/to/your/data/folder

The script will unpack and ingest all supported file types within the folder. The duration of this process depends on the volume of data. You will receive feedback when the ingestion is complete.

Querying the Knowledge Base

Once the data is ingested, you can query your local knowledge base using natural language with models like GPT-3.5-Turbo or GPT-4-Turbo. Use the query.py script for this purpose.

Making Queries

query.py "your query here"

For example:

query.py "give a detailed explanation of what are the applications of LSTM?"

Pre-installation Requirements

• Operating System: Ensure you are running MacOS or Linux.
• Python: Python 3.x is required. Check your Python version with python3 --version.

Troubleshooting

Refer to the error logs or console output if you encounter installation issues. Common errors might include permission denials or package conflicts.

Cleanup and Maintenance

• Remove any temporary files created during installation.
• Deactivate and remove the virtual environment if used.

deactivate
rm -rf venv

Manual Steps and User Interactions

• You will be prompted to enter the OpenAI API key during setup.
• Confirm installations and updates when prompted.

Dependencies and Purpose

Each installed package serves a specific role in the functionality of LilPalantir:

• python-dotenv: Manage environment variables.
• llama_index: Core dependency for querying.
• Other packages like numpy, pandas, requests, etc., provide various utilities for data handling and web interactions.