Skip to content

Commit c1f41c5

Browse files
committed
readme updates
Signed-off-by: Mustafa <mustafa.cetin@intel.com>
1 parent cd620bb commit c1f41c5

File tree

3 files changed

+56
-7
lines changed

3 files changed

+56
-7
lines changed

DocSum/docker_compose/intel/cpu/xeon/README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,14 +64,38 @@ docker build -t opea/docsum:latest --build-arg https_proxy=$https_proxy --build-
6464
```
6565

6666
### 3. Build UI Docker Image
67+
Several UI options are provided. If you need to work with multimedia documents, .doc, or .pdf files, suggested to use Gradio UI.
6768

68-
Build the frontend Docker image via below command:
69+
#### Gradio UI
70+
Build the Gradio UI frontend Docker image using the following command:
6971

7072
```bash
7173
cd GenAIExamples/DocSum/ui
7274
docker build -t opea/docsum-ui:latest --build-arg https_proxy=$https_proxy --build-arg http_proxy=$http_proxy -f docker/Dockerfile.gradio .
7375
```
7476

77+
#### Svelte UI
78+
79+
Build the frontend Docker image via below command:
80+
81+
```bash
82+
cd GenAIExamples/DocSum/ui
83+
docker build -t opea/docsum-ui:latest --build-arg https_proxy=$https_proxy --build-arg http_proxy=$http_proxy -f docker/Dockerfile .
84+
```
85+
86+
#### React UI
87+
88+
Build the frontend Docker image via below command:
89+
90+
```bash
91+
cd GenAIExamples/DocSum/ui
92+
export BACKEND_SERVICE_ENDPOINT="http://${host_ip}:8888/v1/docsum"
93+
docker build -t opea/docsum-react-ui:latest --build-arg BACKEND_SERVICE_ENDPOINT=$BACKEND_SERVICE_ENDPOINT -f ./docker/Dockerfile.react .
94+
95+
docker build -t opea/docsum-react-ui:latest --build-arg BACKEND_SERVICE_ENDPOINT=$BACKEND_SERVICE_ENDPOINT --build-arg https_proxy=$https_proxy --build-arg http_proxy=$http_proxy -f ./docker/Dockerfile.react .
96+
```
97+
98+
7599
## 🚀 Start Microservices and MegaService
76100

77101
### Required Models
@@ -265,7 +289,7 @@ You will have the following Docker Images:
265289

266290
## 🚀 Launch the UI
267291

268-
Several UI options are provided. If you need to work with multimedia documents, .doc, or .pdf files, only the Gradio UI supports that. If the Gradio UI is not built, the Svelte UI will be started
292+
Several UI options are provided. If you need to work with multimedia documents, .doc, or .pdf files, suggested to use Gradio UI.
269293

270294
### Gradio UI
271295

@@ -275,7 +299,7 @@ Open this URL `http://{host_ip}:5173` in your browser to access the Gradio based
275299

276300
### Svelte UI
277301

278-
Open this URL `http://{host_ip}:5173` in your browser to access the Gradio based frontend.
302+
Open this URL `http://{host_ip}:5173` in your browser to access the Svelte based frontend.
279303

280304
![project-screenshot](../../../../assets/img/docSum_ui_text.png)
281305

DocSum/docker_compose/intel/hpu/gaudi/README.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,38 @@ cd GenAIExamples/DocSum/
4747
docker build -t opea/docsum:latest --build-arg https_proxy=$https_proxy --build-arg http_proxy=$http_proxy -f Dockerfile .
4848
```
4949

50-
### 4. Build UI Docker Image
50+
### 3. Build UI Docker Image
51+
#### Gradio UI
52+
Several UI options are provided. If you need to work with multimedia documents, .doc, or .pdf files, suggested to use Gradio UI.
5153

52-
Build the frontend Docker image via below command:
54+
Build the Gradio UI frontend Docker image using the following command:
5355

5456
```bash
5557
cd GenAIExamples/DocSum/ui
5658
docker build -t opea/docsum-ui:latest --build-arg https_proxy=$https_proxy --build-arg http_proxy=$http_proxy -f docker/Dockerfile.gradio .
5759
```
5860

61+
#### Svelte UI
62+
63+
Build the frontend Docker image via below command:
64+
65+
```bash
66+
cd GenAIExamples/DocSum/ui
67+
docker build -t opea/docsum-ui:latest --build-arg https_proxy=$https_proxy --build-arg http_proxy=$http_proxy -f docker/Dockerfile .
68+
```
69+
70+
#### React UI
71+
72+
Build the frontend Docker image via below command:
73+
74+
```bash
75+
cd GenAIExamples/DocSum/ui
76+
export BACKEND_SERVICE_ENDPOINT="http://${host_ip}:8888/v1/docsum"
77+
docker build -t opea/docsum-react-ui:latest --build-arg BACKEND_SERVICE_ENDPOINT=$BACKEND_SERVICE_ENDPOINT -f ./docker/Dockerfile.react .
78+
79+
docker build -t opea/docsum-react-ui:latest --build-arg BACKEND_SERVICE_ENDPOINT=$BACKEND_SERVICE_ENDPOINT --build-arg https_proxy=$https_proxy --build-arg http_proxy=$http_proxy -f ./docker/Dockerfile.react .
80+
```
81+
5982
## 🚀 Start Microservices and MegaService
6083

6184
### Required Models
@@ -251,7 +274,7 @@ You will have the following Docker Images:
251274
252275
## 🚀 Launch the UI
253276

254-
Several UI options are provided. If you need to work with multimedia documents, .doc, or .pdf files, only the Gradio UI supports that. If the Gradio UI is not built, the Svelte UI will be started
277+
Several UI options are provided. If you need to work with multimedia documents, .doc, or .pdf files, suggested to use Gradio UI.
255278

256279
### Gradio UI
257280

@@ -260,7 +283,7 @@ Open this URL `http://{host_ip}:5173` in your browser to access the Gradio based
260283

261284
## 🚀 Launch the Svelte UI
262285

263-
Open this URL `http://{host_ip}:5173` in your browser to access the frontend.
286+
Open this URL `http://{host_ip}:5173` in your browser to access the Svelte based frontend.
264287

265288
![project-screenshot](https://github.com/intel-ai-tce/GenAIExamples/assets/21761437/93b1ed4b-4b76-4875-927e-cc7818b4825b)
266289

DocSum/ui/svelte/src/lib/shared/Network.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,11 @@ export async function fetchTextStream(query: string | Blob, params: string, file
2828
if (params === "doc_id") {
2929
formData.append("files", file, fileName);
3030
formData.append("messages", query);
31+
formData.append("type", "text");
3132
} else if (params === "text") {
3233
formData.append("files", file, fileName);
3334
formData.append("messages", query);
35+
formData.append("type", "text");
3436
}
3537

3638
// Initiate the POST request to upload the file

0 commit comments

Comments
 (0)