@@ -3,8 +3,7 @@ title: How to use GraphRAG in the ArangoDB Platform web interface
33menuTitle : Web Interface
44weight : 5
55description : >-
6- Learn how to create, configure, and run a full GraphRAG workflow in four steps
7- using the Platform web interface
6+ Learn how to create, configure, and run a full GraphRAG workflow in just a few steps using the Platform web interface
87---
98{{< tag "ArangoDB Platform" >}}
109
@@ -19,9 +18,10 @@ the ArangoDB team.
1918The entire process is organized into sequential steps within a ** Project** :
2019
21201 . Creating the importer service
22- 2 . Uploading your file and exploring the generated Knowledge Graph
23- 3 . Creating the retriever service
24- 4 . Chatting with your Knowledge Graph
21+ 2 . Adding data sources
22+ 3 . Exploring the generated Knowledge Graph
23+ 4 . Creating the retriever service
24+ 5 . Chatting with your Knowledge Graph
2525
2626## Create a GraphRAG project
2727
@@ -35,12 +35,22 @@ To create a new GraphRAG project using the ArangoDB Platform web interface, foll
3535 a description for your project.
36365 . Click the ** Create project** button to finalize the creation.
3737
38+ ## Project Settings
39+
40+ The ** Project Settings** dialog allows you to configure and manage your
41+ Importer and Retriever services.
42+
43+ You can open the ** Project Settings** dialog in two ways:
44+ - In the ** Data Sources** section, click ** Add data source** and then click on
45+ the ** Open project settings** button.
46+ - In the ** Graph** section, click on the gear icon.
47+
3848## Configure the Importer service
3949
40- Configure a service to import, parse, and retrieve all the needed data from a
50+ Configure a service to import, parse, and extract all the needed data from a
4151file. This service uses the LLM API provider and model of your choice.
4252
43- After clicking on a project name , you are taken to a screen where you can
53+ After opening the ** Project Settings ** , you are taken to a dialog where you can
4454configure and start a new importer service job. Follow the steps below.
4555
4656{{< tabs "importer-service" >}}
@@ -52,20 +62,20 @@ configure and start a new importer service job. Follow the steps below.
52623 . Enter your ** OpenAI API Key** .
53634 . Click the ** Start importer service** button.
5464
55- ![ Configure Importer service using OpenAI] ( ../../../images/graphrag-ui-configure-importer-openai.png )
65+ ![ Configure Importer service using OpenAI] ( ../../../images/graphrag-ui-configure-importer-openai.png )
5666{{< /tab >}}
5767
5868{{< tab "OpenRouter" >}}
59691 . Select ** OpenRouter** from the ** LLM API Provider** dropdown menu.
60702 . Select the model you want to use from the ** Model** dropdown menu. By default,
61- the service is using ** Mistral AI - Mistral Nemo** .
62- 1 . Enter your ** OpenAI API Key** .
63- 2 . Enter your ** OpenRouter API Key** .
64- 3 . Click the ** Start importer service** button.
71+ the service uses ** Mistral AI - Mistral Nemo** .
72+ 3 . Enter your ** OpenAI API Key** .
73+ 4 . Enter your ** OpenRouter API Key** .
74+ 5 . Click the ** Start importer service** button.
6575
6676{{< info >}}
67- When using the OpenRouter option, the LLM responses are served via OpenRouter
68- while OpenAI is used for the embedding model.
77+ When using OpenRouter, you need both API keys because the LLM responses are served
78+ via OpenRouter while OpenAI is used for the embedding model.
6979{{< /info >}}
7080
7181![ Configure Importer service using OpenRouter] ( ../../../images/graphrag-ui-configure-importer-openrouter.png )
@@ -88,31 +98,53 @@ service automatically downloads and loads models from the MLflow registry.
8898
8999See also the [ GraphRAG Importer] ( services/importer.md ) service documentation.
90100
91- ## Upload your file
101+ ## Add data source
102+
103+ To add your first data source:
92104
93- 1 . Upload a file by dragging and dropping it in the designated upload area.
94- The importer service you previously launched parses and creates the
95- Knowledge Graph automatically.
96- 2 . Enter a file name.
97- 3 . Click the ** Start import** button.
105+ 1 . In the ** Data Sources** section, click the ** Add data source** button.
106+ 2 . Upload a file by dragging and dropping it in the designated upload area.
107+ The importer service you previously configured will automatically parse the file
108+ and create the Knowledge Graph.
109+ 3 . Enter a descriptive name for your file.
110+ 4 . Click the ** Start import** button.
98111
99112{{< info >}}
100- You can only import a single file, either in ` .md ` or ` .txt ` format.
113+ Currently, you can import one file at a time in either Markdown (` .md ` ) or
114+ plain text (` .txt ` ) format. Additional files can be added to update the Knowledge Graph.
101115{{< /info >}}
102116
103117![ Upload file in GraphRAG web interface] ( ../../../images/graphrag-ui-upload-file.png )
104118
105119## Explore the Knowledge Graph
106120
107- You can open and explore the Knowledge Graph that has been generated by clicking
108- on the ** Explore in visualizer** button.
121+ After your file is processed, you can view and explore the generated Knowledge Graph
122+ in the ** Graph** section.
123+
124+ ![ Explore Knowledge Graph in GraphRAG web interface] ( ../../../images/graphrag-ui-explore-knowledge-graph.png )
125+
126+ For a more detailed exploration, click the ** Explore** button to open the Knowledge Graph in the dedicated Graph Visualizer.
109127
110128For more information, see the [ Graph Visualizer] ( ../../graphs/graph-visualizer.md ) documentation.
111129
130+ ## Update the Knowledge Graph
131+
132+ Once you have created your initial Knowledge Graph, you can update it by uploading
133+ additional files using the same process described in the [ Add data source] ( #add-data-source ) section.
134+ The importer service will automatically update the existing Knowledge Graph and
135+ underlying collections with the new data.
136+
137+ To update your Knowledge Graph:
138+
139+ 1 . In the ** Data Sources** section, click the ** Add data source** button again.
140+ 2 . Upload a new file by dragging and dropping it in the designated upload area.
141+ 3 . The importer service will process the new file and update the existing Knowledge Graph along with the underlying collections.
142+
112143## Configure the Retriever service
113144
114- Creating the retriever service allows you to extract information from
115- the generated Knowledge Graph. Follow the steps below to configure the service.
145+ The retriever service enables you to query and extract information from
146+ the generated Knowledge Graph. To configure the retriever service, open the
147+ ** Project Settings** and follow the steps below.
116148
117149{{< tabs "retriever-service" >}}
118150
@@ -134,8 +166,8 @@ the generated Knowledge Graph. Follow the steps below to configure the service.
1341664 . Click the ** Start retriever service** button.
135167
136168{{< info >}}
137- When using the OpenRouter option , the LLM responses are served via OpenRouter
138- while OpenAI is used for the embedding model.
169+ When using OpenRouter, the LLM responses are served via OpenRouter while OpenAI
170+ is used for the embedding model.
139171{{< /info >}}
140172
141173![ Configure Retriever Service using OpenRouter] ( ../../../images/graphrag-ui-configure-retriever-openrouter.png )
0 commit comments