Skip to content

Commit 0edff26

Browse files
authored
Update Productivity README.md for workflow (#940)
Signed-off-by: Tsai, Louie <louie.tsai@intel.com>
1 parent 778afb5 commit 0edff26

File tree

1 file changed

+144
-0
lines changed

1 file changed

+144
-0
lines changed

ProductivitySuite/README.md

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,150 @@
22

33
Productivity Suite, a tool designed to streamline your workflow and boost productivity! Our application leverages the power of OPEA microservices to deliver a comprehensive suite of features tailored to meet the diverse needs of modern enterprises.
44

5+
The ProductivitySuite example is implemented using both megaservices and the component-level microservices defined in [GenAIComps](https://github.com/opea-project/GenAIComps). The flow chart below shows the information flow between different megaservices and microservices for this example. Prompt Registry and Chat History microservices save prompt and chat history from the ChatQnA MegaService only into the database.
6+
7+
```mermaid
8+
---
9+
config:
10+
flowchart:
11+
nodeSpacing: 400
12+
rankSpacing: 100
13+
curve: linear
14+
themeVariables:
15+
fontSize: 50px
16+
---
17+
flowchart LR
18+
%% Colors %%
19+
classDef blue fill:#ADD8E6,stroke:#ADD8E6,stroke-width:2px,fill-opacity:0.5
20+
classDef orange fill:#FBAA60,stroke:#ADD8E6,stroke-width:2px,fill-opacity:0.5
21+
classDef orchid fill:#C26DBC,stroke:#ADD8E6,stroke-width:2px,fill-opacity:0.5
22+
classDef invisible fill:transparent,stroke:transparent;
23+
style ChatQnA-MegaService stroke:#000000
24+
25+
%% Subgraphs %%
26+
subgraph ChatQnA-MegaService["ChatQnA MegaService "]
27+
direction LR
28+
EM([Embedding MicroService]):::blue
29+
RET([Retrieval MicroService]):::blue
30+
RER([Rerank MicroService]):::blue
31+
LLM([LLM MicroService]):::blue
32+
end
33+
subgraph DocSum-MegaService["DocSum MegaService "]
34+
direction LR
35+
LLM_D([LLM MicroService]):::blue
36+
end
37+
subgraph CodeGen-MegaService["CodeGen MegaService "]
38+
direction LR
39+
LLM_CG([LLM MicroService]):::blue
40+
end
41+
subgraph FaqGen-MegaService["FaqGen MegaService "]
42+
direction LR
43+
LLM_F([LLM MicroService]):::blue
44+
end
45+
subgraph UserInterface[" User Interface "]
46+
direction LR
47+
a([User Input Query]):::orchid
48+
Ingest([Ingest data]):::orchid
49+
UI([UI server<br>]):::orchid
50+
end
51+
52+
53+
54+
TEI_RER{{Reranking service<br>}}
55+
TEI_EM{{Embedding service <br>}}
56+
VDB{{Vector DB<br><br>}}
57+
R_RET{{Retriever service <br>}}
58+
DP([Data Preparation MicroService]):::blue
59+
LLM_gen_C{{LLM Service <br>}}
60+
GW_C([ChatQnA GateWay<br>]):::orange
61+
LLM_gen_D{{LLM Service <br>}}
62+
GW_D([DocSum GateWay<br>]):::orange
63+
LLM_gen_CG{{LLM Service <br>}}
64+
GW_CG([CodeGen GateWay<br>]):::orange
65+
LLM_gen_F{{LLM Service <br>}}
66+
GW_F([FaqGen GateWay<br>]):::orange
67+
PR([Prompt Registry MicroService]):::blue
68+
CH([Chat History MicroService]):::blue
69+
MDB{{Mongo DB<br><br>}}
70+
71+
72+
%% Data Preparation flow
73+
%% Ingest data flow
74+
direction LR
75+
Ingest[Ingest data] --> UI
76+
UI --> DP
77+
DP <-.-> TEI_EM
78+
79+
%% Questions interaction
80+
direction LR
81+
a[User Input Query] --> UI
82+
UI <--> GW_C
83+
GW_C <==> ChatQnA-MegaService
84+
EM ==> RET
85+
RET ==> RER
86+
RER ==> LLM
87+
88+
89+
%% Embedding service flow
90+
direction LR
91+
EM <-.-> TEI_EM
92+
RET <-.-> R_RET
93+
RER <-.-> TEI_RER
94+
LLM <-.-> LLM_gen_C
95+
96+
direction LR
97+
%% Vector DB interaction
98+
R_RET <-.-> VDB
99+
DP <-.-> VDB
100+
101+
%% Questions interaction
102+
direction LR
103+
UI --> GW_D
104+
GW_D <==> DocSum-MegaService
105+
106+
107+
%% Embedding service flow
108+
direction LR
109+
LLM_D <-.-> LLM_gen_D
110+
111+
%% Questions interaction
112+
direction LR
113+
UI --> GW_CG
114+
GW_CG <==> CodeGen-MegaService
115+
116+
117+
%% Embedding service flow
118+
direction LR
119+
LLM_CG <-.-> LLM_gen_CG
120+
121+
%% Questions interaction
122+
direction LR
123+
UI --> GW_F
124+
GW_F <==> FaqGen-MegaService
125+
126+
127+
%% Embedding service flow
128+
direction LR
129+
LLM_F <-.-> LLM_gen_F
130+
131+
%% Questions interaction
132+
direction LR
133+
UI --> PR
134+
135+
%% Embedding service flow
136+
direction LR
137+
PR <-.-> MDB
138+
139+
%% Questions interaction
140+
direction LR
141+
UI --> CH
142+
143+
%% Embedding service flow
144+
direction LR
145+
CH <-.-> MDB
146+
147+
```
148+
5149
---
6150

7151
## 🛠️ Key Features

0 commit comments

Comments
 (0)