forked from AI_team/Philosophy-RAG-demo
Adds information to the readme
This commit is contained in:
parent
9a05fd62f8
commit
e259808322
30
README.md
30
README.md
@ -1,3 +1,31 @@
|
||||
# generic-RAG-demo
|
||||
|
||||
A generic RAG demo
|
||||
A Sogeti Nederland generic RAG demo
|
||||
|
||||
## Getting Started
|
||||
|
||||
Please mind due to use of argparse the generic RAG demo can not be launched the usual way chainlit is started.
|
||||
|
||||
```bash
|
||||
chainlit run generic_rag/app.py # will not work
|
||||
```
|
||||
|
||||
Instead, the app can be launched and debugged the usual way.
|
||||
|
||||
```bash
|
||||
python generic_rag/app.py -p data # will work
|
||||
python generic_rag/app.py --help # will work and prints command line options
|
||||
```
|
||||
|
||||
|
||||
## Chainlit starters
|
||||
|
||||
Chainlit suggestions (starters) can be set with the `CHAINLIT_STARTERS` environment variable.
|
||||
The variable should be a JSON array of objects with `label` and `message` properties.
|
||||
An example is given below
|
||||
|
||||
```
|
||||
|
||||
CHAINLIT_STARTERS=[{"label":"Label 1","message":"Message one."},{"label":"Label 2","message":"Message two."},{"label":"Label 3","message":"Message three."}]
|
||||
|
||||
```
|
||||
|
||||
Loading…
Reference in New Issue
Block a user