Skip to content

Commit

Permalink
added more details
Browse files Browse the repository at this point in the history
  • Loading branch information
Nutlope committed Jan 25, 2024
1 parent 7ba5b65 commit b7060fd
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,36 @@
# Open source AI RAG Chatbot

This is a [LlamaIndex](https://www.llamaindex.ai/) and [Together.ai](https://www.together.ai/) project using [Next.js](https://nextjs.org/) bootstrapped with [`create-llama`](https://github.com/run-llama/LlamaIndexTS/tree/main/packages/create-llama).
This is a [LlamaIndex](https://www.llamaindex.ai/) and [Together.ai](https://www.together.ai/) RAG chatbot using [Next.js](https://nextjs.org/) bootstrapped with [`create-llama`](https://github.com/run-llama/LlamaIndexTS/tree/main/packages/create-llama).

It's modified to be powered by Together AI Inference through Mixtral and Together Embeddings.
It's powered by Llama Index, Mixtral (through Together AI Inference) and Together Embeddings. It'll embed the PDF file in `data`, generate embeddings stored locally, then give you a RAG chatbot to ask questions to.

## Getting Started

Copy your `.example.env` file into a `.env` and replace the TOGETHER_API_KEY with your API key from [together.ai](https://www.together.ai).

1. Install the dependencies:
1. Install the dependencies.

```
npm install
```

2. Generate the embeddings
2. Generate the embeddings and store them locally in the `cache` folder. You can also provide a PDF in the `data` folder instead of the default one.

```
npm run generate
```

3. Run the app and chat with it
3. Run the app and send messages to your chatbot. It will use context from the embeddings to answer questions.

```
npm run dev
```

## Common Issues

- Ensure your environment file is called `.env`
- Specify a dummy `OPENAI_API_KEY` value in this `.env` to make sure it works (temporary hack, Llama index is patching this)

## Learn More

To learn more about LlamaIndex and Together AI, take a look at the following resources:
Expand Down

0 comments on commit b7060fd

Please sign in to comment.