Skip to content

Commit 19a7aed

Browse files
committed
📝 Add apicall case study on the README
1 parent afa8c45 commit 19a7aed

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -332,12 +332,24 @@ This advanced case study demonstrates the application of VueGen in a real-world
332332
> The EMP case study is available online as [HTML][emp-html-demo] and [Streamlit][emp-st-demo] reports.
333333
> The [configuration file][emp-config] is available in the `docs/example_config_files` folder, and the [directory][emp-dir] with example data is in the `docs/example_data` folder.
334334
335-
### 3. ChatBot Component
335+
### 3. APICall Component
336+
337+
This case study focuses on the `APICall` component, which enables interaction with external APIs by using HTTP methods such as **GET** and **POST**. The retrieved data is displayed in the report, allowing users to integrate external data sources into their anlyses. This component is restricted to **Streamlit** reports.
338+
339+
🔗 [![Open in Colab][colab_badge]][colab_link_apicall]
340+
341+
> [!NOTE]
342+
> A [configuration file example][apicall-config] for the apicall component is available in
343+
the `docs/example_config_files` folder.
344+
345+
### 4. ChatBot Component
336346

337347
This case study highlights VueGen’s capability to embed a chatbot component into a report subsection,
338348
enabling interactive conversations inside the report. This component is streamlit-specific and is not
339349
available for other report types.
340350

351+
🔗 [![Open in Colab][colab_badge]][colab_link_chatbot]
352+
341353
Two API modes are supported:
342354

343355
- **Ollama-style streaming chat completion:**
@@ -356,11 +368,11 @@ Two API modes are supported:
356368
- `links`: a list of source URLs (optional)
357369
- `HTML content`: an HTML snippet with a Pyvis network visualization (optional)
358370

359-
This response structure is currently customized for an internal knowledge graph assistant, but VueGen is being actively developed
360-
to support more flexible and general-purpose response formats in future releases.
371+
This response structure is currently customized for an internal knowledge graph assistant, but VueGen is being actively developed to support more flexible and general-purpose response formats in future releases.
361372

362373
> [!NOTE]
363-
> You can see a [configuration file example][config-chatbot] for the chatbot component in the `docs/example_config_files` folder.
374+
> A [configuration file example][chatbot-config] for the chatbot component is available
375+
in the `docs/example_config_files` folder.
364376

365377
## Web application deployment
366378

@@ -443,7 +455,6 @@ We appreciate your feedback! If you have any comments, suggestions, or run into
443455
[emp-st-demo]: https://earth-microbiome-vuegen-demo.streamlit.app/
444456
[ollama_chat]: https://github.com/ollama/ollama/blob/main/docs/api.md#generate-a-chat-completion
445457
[ollama]: https://ollama.com/
446-
[config-chatbot]: https://github.com/Multiomics-Analytics-Group/vuegen/blob/main/docs/example_config_files/Chatbot_example_config.yaml
447458
[issues]: https://github.com/Multiomics-Analytics-Group/vuegen/issues
448459
[pulls]: https://github.com/Multiomics-Analytics-Group/vuegen/pulls
449460
[vuegen-article]: https://doi.org/10.1093/bioadv/vbaf149
@@ -462,6 +473,10 @@ We appreciate your feedback! If you have any comments, suggestions, or run into
462473
[emp]: https://earthmicrobiome.org/
463474
[emp-config]: https://github.com/Multiomics-Analytics-Group/vuegen/blob/main/docs/example_config_files/Earth_microbiome_vuegen_demo_notebook_config
464475
[emp-dir]: https://github.com/Multiomics-Analytics-Group/vuegen/blob/main/docs/example_data/Earth_microbiome_vuegen_demo_notebook
476+
[colab_link_apicall]: https://colab.research.google.com/github/Multiomics-Analytics-Group/vuegen/blob/main/docs/vuegen_apicall_case_study.ipynb
477+
[apicall-config]: https://github.com/Multiomics-Analytics-Group/vuegen/blob/main/docs/example_config_files/APIcall_example_config.yaml
478+
[colab_link_chatbot]: https://colab.research.google.com/github/Multiomics-Analytics-Group/vuegen/blob/main/docs/vuegen_chatbot_case_study.ipynb
479+
[chatbot-config]: https://github.com/Multiomics-Analytics-Group/vuegen/blob/main/docs/example_config_files/Chatbot_example_config.yaml
465480
[conda-download]: https://conda-forge.org/download/
466481
[gui-readme]: https://github.com/Multiomics-Analytics-Group/vuegen/blob/main/gui/README.md
467482
[pyinstaller]: https://pyinstaller.org/

0 commit comments

Comments
 (0)