Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
oskarhane committed Oct 11, 2023
1 parent 2b1bfae commit 0b99705
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 7 deletions.
Binary file added .github/media/app5-ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 37 additions & 7 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,17 @@ docker compose down
```

# Applications

Here's what's in this repo:

| Name | Main files | Compose name | URLs | Description |
|---|---|---|---|---|
| Code support bot | `bot.py` | `bot` | http://localhost:8501 | Main usecase. Fullstack Python application. |
| Stack Overflow Loader | `loader.py` | `loader` | http://localhost:8502 | Load SO data into the database (create vector embeddings etc). Fullstack Python application. |
| PDF Reader | `pdf_bot.py` | `pdf_bot` | http://localhost:8503 | Read local PDF and ask it questions. Fullstack Python application. |
| Standalone Bot API | `api.py` | `api` | http://localhost:8504 | Standalone HTTP API streaming (SSE) + non-streaming endpoints. Python. |
| Standalone UI | `front-end/` | `front-end` | http://localhost:8505 | Standalone client that uses the Standalone Bot API to interact with the model. JavaScript (Svelte) front-end. |

## App 1 - Support Agent Bot

UI: http://localhost:8501
Expand All @@ -63,11 +74,10 @@ DB client: http://localhost:7474
![](.github/media/app1-rag-selector.png)
*(Chat input + RAG mode selector)*

![](.github/media/app1-generate.png)
*(CTA to auto generate support ticket draft)*

![](.github/media/app1-ticket.png)
*(UI of the auto generated support ticket draft)*
| | |
|---|---|
| ![](.github/media/app1-generate.png) | ![](.github/media/app1-ticket.png) |
| *(CTA to auto generate support ticket draft)* | *(UI of the auto generated support ticket draft)* |

---

Expand All @@ -81,8 +91,12 @@ DB client: http://localhost:7474
- UI: choose tags, run import, see progress, some stats of data in the database
- Load high ranked questions (regardless of tags) to support the ticket generation feature of App 1.

![](.github/media/app2-ui-1.png)
![](.github/media/app2-model.png)



| | |
|---|---|
| ![](.github/media/app2-ui-1.png) | ![](.github/media/app2-model.png) |

## App 3 Question / Answer with a local PDF
UI: http://localhost:8503
Expand All @@ -94,3 +108,19 @@ its contents and have the LLM answer them using vector similarity
search.

![](.github/media/app3-ui.png)

## App 4 Standalone HTTP API
Endpoints:
- http://localhost:8504/query?text=hello&rag=false (non streaming)
- http://localhost:8504/query-stream?text=hello&rag=false (SSE streaming)

Exposes the functionality to answer questions in the same way as App 1 above. Uses
same code and prompts.

## App 5 Static front-end
UI: http://localhost:8505

This application has the same features as App 1, but is built separate from
the back-end code using modern best practices (Vite, Svelte, Tailwind).
The auto-reload on changes are instant using the Docker watch `sync` config.
![](.github/media/app5-ui.png)

0 comments on commit 0b99705

Please sign in to comment.