Skip to content

Commit ee01882

Browse files
committed
docs(readme): add genai workflow diagram
1 parent 6a8178d commit ee01882

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,17 @@ modules: application features
3737
utils: class and constant utilities for this module
3838
```
3939
40+
### Search In Document Flow
41+
42+
The search in document endpoint is the most complex of this application, it uses RAG concepts to break down the provided
43+
PDF document into a small chunks and then use it as a context for the followup user questions. Also, it uses Redis to store
44+
and retrieve chat history during user's session.
45+
46+
> As an improvement, it'll be worth to have a separated endpoint for uploading documents and another one for handling questions
47+
> to it. To keep things easy to follow up and having a single endpoint, the diagram is as you can see below:
48+
49+
![GenAI Search in Document Flow](docs/genai-flow.png 'GenAI Search in Document Flow')
50+
4051
## Prerequisites
4152
4253
Before running the application, make sure you have the following installed:
@@ -53,7 +64,8 @@ Before running the application, make sure you have the following installed:
5364
git clone https://github.com/WillACosta/genai-langchain-api
5465
```
5566

56-
> Copy the `.env.example` file to `.env` and fill it with your own credentials
67+
> Copy the `.env.example` file to `.env` and fill it with your own credentials. Get here:
68+
> [Google Gemini](https://ai.google.dev/) | [LangChain](https://js.langchain.com/docs/introduction/)
5769
5870
```shell
5971
cp .env.example .env

docs/genai-flow.png

364 KB
Loading

0 commit comments

Comments
 (0)