hello_wordsmith / README.md
rmcnairn's picture
How to instructions update
5df2a88 verified
|
Raw
History Blame
817 Bytes
metadata
license: mit
language:
  - en

This is a simple package wrapping llama-index CLI with Wordsmith defaults for a "Hello World" interaction with RAG.

Step 1: pip install git+https://huggingface.co/derek-at-work/hello_wordsmith -q // This is a simple wrapper around llama index, that helps you to get up and running with a basic data set and will help you clone the key aspects you need

Step 2: export OPENAI_API_KEY="sk-XXX-OPENAI-API-KEY-XXX" // replace the placeholder text with your API key

Step 3: Interacting with your command line RAG pipeline: hello-wordsmith // launch a chat or hello-wordsmith -q 'What is RAG?' // to ask a one-off

Index additional data: You can load in your own data to chat with hello-wordsmith -f "./my_directory/*" It's stored locally and can be wiped with hello-wordsmith --clear