From fbde15b40d61d3b8c710cb4ba933eff4142fdec8 Mon Sep 17 00:00:00 2001 From: Louie Tsai Date: Thu, 10 Oct 2024 08:46:41 -0700 Subject: [PATCH] Update DocSum README.md for its workflow (#904) Signed-off-by: Tsai, Louie --- DocSum/README.md | 54 ++++++++++++++++++++++++++++++++++++------------ 1 file changed, 41 insertions(+), 13 deletions(-) diff --git a/DocSum/README.md b/DocSum/README.md index d87dd55f6..37a678963 100644 --- a/DocSum/README.md +++ b/DocSum/README.md @@ -102,25 +102,53 @@ Refer to the [DocSum helm chart](https://github.com/opea-project/GenAIInfra/tree ### Workflow of the deployed Document Summarization Service -The workflow of the Document Summarization Service, from user's input query to the application's output response, is as follows: +The DocSum example is implemented using the component-level microservices defined in [GenAIComps](https://github.com/opea-project/GenAIComps). The flow chart below shows the information flow between different microservices for this example. ```mermaid +--- +config: + flowchart: + nodeSpacing: 400 + rankSpacing: 100 + curve: linear + themeVariables: + fontSize: 50px +--- flowchart LR - subgraph DocSum + %% Colors %% + classDef blue fill:#ADD8E6,stroke:#ADD8E6,stroke-width:2px,fill-opacity:0.5 + classDef orange fill:#FBAA60,stroke:#ADD8E6,stroke-width:2px,fill-opacity:0.5 + classDef orchid fill:#C26DBC,stroke:#ADD8E6,stroke-width:2px,fill-opacity:0.5 + classDef invisible fill:transparent,stroke:transparent; + style DocSum-MegaService stroke:#000000 + + %% Subgraphs %% + subgraph DocSum-MegaService["DocSum MegaService "] direction LR - A[User] <--> |Input query| B[DocSum Gateway] - B <--> |Post| Megaservice - subgraph Megaservice["Megaservice"] - direction TB - C([ Microservice : llm-docsum-tgi
9000]) -. Post .-> D{{TGI Service
8008}} - end - Megaservice --> |Output| E[Response] + LLM([LLM MicroService]):::blue end - subgraph Legend - X([Micsrservice]) - Y{{Service from industry peers}} - Z[Gateway] + subgraph UserInterface[" User Interface "] + direction LR + a([User Input Query]):::orchid + UI([UI server
]):::orchid end + + + LLM_gen{{LLM Service
}} + GW([DocSum GateWay
]):::orange + + + %% Questions interaction + direction LR + a[User Input Query] --> UI + UI --> GW + GW <==> DocSum-MegaService + + + %% Embedding service flow + direction LR + LLM <-.-> LLM_gen + ``` ## Consume Document Summarization Service