iang
/
ragger
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README fixes

This commit is contained in:
Ian Griffin 2024-10-28 11:02:54 +08:00
parent d1137d1026
commit dbf8bb1766
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -1,4 +1,4 @@
Ragger RAGger
====== ======
```ragger.py``` is a command line tool to RAG over multiple pieces of text, PDFs and websites using langchain and OpenAI. ```ragger.py``` is a command line tool to RAG over multiple pieces of text, PDFs and websites using langchain and OpenAI.
@ -7,6 +7,7 @@ The main repository is on ![git.telosama.xyz](https://git.telosama.xyz/iang/ragg
## Prerequisites ## Prerequisites
Since this codebase uses OpenAI models, a OpenAI API key is needed. Since this codebase uses OpenAI models, a OpenAI API key is needed.
After obtaining an API key, set the environment variable OPENAI_API_KEY to the API key. After obtaining an API key, set the environment variable OPENAI_API_KEY to the API key.
This program is built on top of python 3.10
## Installation ## Installation
This program can be installed by cloning the repository and installing the package using pip: This program can be installed by cloning the repository and installing the package using pip: