You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-5Lines changed: 10 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -35,28 +35,28 @@ The project includes several basic examples that demonstrate application deploym
35
35
1.[`app.py`](examples/basic/app.py): This example runs the main application, which includes the ingestion, embedding, and RAG pipelines served via FastAPI.
36
36
37
37
```bash
38
-
poetry run uvicorn r2r.examples.basic.app:app
38
+
uvicorn r2r.examples.basic.app:app
39
39
```
40
40
41
41
2.[`run_client.py`](examples/basic/run_client.py): This example should be run after starting the main application. It demonstrates uploading text entries as well as a PDF to the local server with the python client. Further, it shows document and user-level vector management with built-in features.
42
42
43
43
```bash
44
-
poetry run python -m r2r.examples.basic.run_client
44
+
python -m r2r.examples.basic.run_client
45
45
```
46
46
47
47
3.[`run_pdf_chat.py`](examples/pdf_chat/run_demo.py): An example demonstrating upload and chat with a more realistic pdf.
48
48
49
49
```bash
50
50
# Ingest pdf
51
-
poetry run python -m r2r.examples.pdf_chat.run_demo ingest
51
+
python -m r2r.examples.pdf_chat.run_demo ingest
52
52
53
53
# Ask a question
54
-
poetry run python -m r2r.examples.pdf_chat.run_demo search "What are the key themes of Meditations?"
54
+
python -m r2r.examples.pdf_chat.run_demo search "What are the key themes of Meditations?"
55
55
```
56
56
57
57
4.[`web`](web/package.json): A web application which is meant to accompany the framework to provide visual intelligence.
58
58
```bash
59
-
cd web && pnpm install
59
+
cd$workdir/web && pnpm install
60
60
# Serve the web app
61
61
pnpm dev
62
62
```
@@ -90,6 +90,11 @@ Follow these steps to ensure a smooth setup:
90
90
# use "all" to include every optional dependency
91
91
poetry install --extras "parsing"
92
92
```
93
+
- Execute with poetry run:
94
+
```bash
95
+
poetry run python -m r2r.examples.pdf_chat.run_demo ingest
96
+
```
97
+
93
98
94
99
3. **Configure Environment Variables:**
95
100
- You need to set up cloud provider secrets in your `.env`. At a minimum, you will need an OpenAI key.
0 commit comments