Update README.md

README.md

@@ -5,16 +5,92 @@ task_categories:
 language:
 - en
 ---
-
-The dataset is sourced from GARDIAN (https://gardian.bigdata.cgiar.org/), 
+# Data Sources and RAG Pipeline
+The dataset is sourced from [GARDIAN](https://gardian.bigdata.cgiar.org/), 
 a comprehensive hub for agri-food data and publications. Utilizing its robust API, 
 the GAIA-CIGI pipeline has systematically discovered and gathered all open-access reports and publications 
 from the various CGIAR centers. 
 
-Each document has been converted into a structured, machine-readable format using GROBID, 
-a specialized tool for extracting the structure of scientific publications
-(https://grobid.readthedocs.io/en/latest/Introduction/).
+Each document has been converted into a structured, machine-readable format using [GROBID](https://grobid.readthedocs.io/en/latest/Introduction/), 
+a specialized tool for extracting the structure of scientific publications.
+
+A complete description of the system architecture can be found [here](https://scio.atlassian.net/wiki/spaces/CiGi/pages/45711361/Pipeline+Architecture)
+
+# Document Structure
+
+```
+{
+  "metadata": {
+    "id": "",
+    "source": "",
+    "url": ""
+  },
+  "pagecount": 1,
+  "title": "",
+  "abstract": "",
+  "keywords":["keyowrds"]
+  "chapters": [
+    {
+      "index": 1,
+      "head": "",
+      "paragraphs": [
+        {
+          "text": "",
+          "size": 1,
+          "index": 1
+        },
+        {
+          "text": "",
+          "size": 2,
+          "index": 2
+        }
+      ]
+    }
+  ],
+  "figures": [
+    {
+      "text": ""
+    }
+  ],
+"sieverID":""
+}
+```
+# Property Description
+
+<ol>
+  <li>"metadata" (object, required): Contains information related to the document's metadata. 
+    <ol>
+      <li>"id" (string): the identifier for the document.</li>
+      <li>"source" (string): the source or origin of the document.</li>
+      <li>"url" (string): the url of the downloaded document.</li>      
+    </ol>
+  </li>  
+  <li>"pageCount" (integer, required): the number of pages of the document.</li>
+  <li>"title" (string, required): the title of the document.</li>
+  <li>"abstract" (string, required): the abstract of the document.</li>
+  <li>"chapters" (array of objects, required): represents chapters or sections within the document.
+    <ol>
+      <li>"index" (integer, required): the numerical order of the chapter.</li>
+      <li>"head" (string, required): the heading of the chapter.</li>
+      <li>"paragraphs" (array of objects, required): contains paragraphs within the chapter.
+        <ol>
+          <li>"text" (string, required): the content of the paragraph.</li>
+          <li>"size" (integer, required): represents the size of the paragraph (words separated by one space).</li>
+          <li>"index" (integer, required): the numerical order of paragraph within the chapter.</li>
+        </ol>
+      </li>
+    </ol>    
+  </li>  
+  <li>"figures" (array of objects, required): represents tables within the document.
+    <ol>
+      <li>
+        "text" (string, required): the content of the table.
+      </li>
+    </ol>
+  </li>
+  <li>"sieverID" (string, required): Internal identifier of the document.</li>
+</ol>
 
-Each document carries a persistent GARDIAN id that allows the retrieval of the full metadata record of the associated publication
+>Each document carries a persistent GARDIAN id that allows the retrieval of the full metadata record of the associated publication
 
 Number of documents: 4995