Skip to content

Commit ec64cb9

Browse files
authored
adding image and chaning docs and readme: (#15)
1 parent d1675cf commit ec64cb9

File tree

5 files changed

+9
-8
lines changed

5 files changed

+9
-8
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ This Blueprint demonstrates how to use open-source models and a simple LLM workf
1313

1414
It is designed to showcase a simpler alternative to more complex and/or resource demanding alternatives, such as RAG systems that rely on vectorDBs and/or long-context models with large token windows.
1515

16+
<img src="./images/structured-qa-diagram.png" width="1200" alt="structure-qa Diagram" />
17+
18+
📘 To explore this project further and discover other Blueprints, visit the [**Blueprints Hub**](https://developer-hub.mozilla.ai/blueprints/query-structured-documents-using-a-lightweight-llm-workflow).
19+
1620

1721
### 👉 📖 For more detailed guidance on using this project, please visit our [Docs here](https://mozilla-ai.github.io/structured-qa/).
1822

docs/images/structured-qa-diagram.png

110 KB
Loading

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# **Structured-QA Blueprint**
22

33
<div style="text-align: center;">
4-
<img src="images/document-to-podcast-diagram.png" alt="Project Logo" style="width: 100%; margin-bottom: 1px; margin-top: 1px;">
4+
<img src="images/structured-qa-diagram.png" alt="Project Logo" style="width: 100%; margin-bottom: 1px; margin-top: 1px;">
55
</div>
66

77
Blueprints empower developers to easily integrate AI capabilities into their projects using open-source models and tools.

docs/step-by-step-guide.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,14 @@ This system has the following core stages:
99
Prepare the input document by extracting the different sections that compose the structure of the document.
1010
Split the sections and save them to separate files.
1111

12-
🔎 **2. Find Relevant Section**
13-
Given a list of sections and the input question, use the LLM to identify the section that looks more relevant.
12+
🔎 **2. Find Relevant and Retrieve Section**
13+
Given a list of sections and the input question, use the LLM to identify the section that looks more relevant. Load the individual section to be passed to the next step.
1414

15-
📄 **3. Retrieve Section**
16-
Load the individual section to be passed to the next step.
17-
18-
📗 **4. Answer Question**
15+
📗 **3. Answer Question**
1916
Use the LLM to answer the question based on the information available in the retrieved section.
2017

2118

22-
In case the LLM can't find an answer to the question, the stages 2 to 4 run on a loop until the LLM finds the answer.
19+
In case the LLM can't find an answer to the question, the stages 2 to 3 run on a loop until the LLM finds the answer.
2320

2421
---
2522

images/structured-qa-diagram.png

110 KB
Loading

0 commit comments

Comments
 (0)