Skip to content

Commit ecbb174

Browse files
nerpaulaSimran-B
authored andcommitted
new graphrag ui
1 parent 17e9b62 commit ecbb174

9 files changed

+58
-26
lines changed

site/content/ai-suite/graphrag/web-interface.md

Lines changed: 58 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@ title: How to use GraphRAG in the Arango Data Platform web interface
33
menuTitle: Web Interface
44
weight: 20
55
description: >-
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
{{< tip >}}
109
The Arango Data Platform & AI Suite are available as a pre-release. To get
@@ -17,9 +16,10 @@ the Arango team.
1716
The entire process is organized into sequential steps within a **Project**:
1817

1918
1. Creating the importer service
20-
2. Uploading your file and exploring the generated Knowledge Graph
21-
3. Creating the retriever service
22-
4. Chatting with your Knowledge Graph
19+
2. Adding data sources
20+
3. Exploring the generated Knowledge Graph
21+
4. Creating the retriever service
22+
5. Chatting with your Knowledge Graph
2323

2424
## Create a GraphRAG project
2525

@@ -33,12 +33,22 @@ To create a new GraphRAG project using the Arango Data Platform web interface, f
3333
a description for your project.
3434
5. Click the **Create project** button to finalize the creation.
3535

36+
## Project Settings
37+
38+
The **Project Settings** dialog allows you to configure and manage your
39+
Importer and Retriever services.
40+
41+
You can open the **Project Settings** dialog in two ways:
42+
- In the **Data Sources** section, click **Add data source** and then click on
43+
the **Open project settings** button.
44+
- In the **Graph** section, click on the gear icon.
45+
3646
## Configure the Importer service
3747

38-
Configure a service to import, parse, and retrieve all the needed data from a
48+
Configure a service to import, parse, and extract all the needed data from a
3949
file. This service uses the LLM API provider and model of your choice.
4050

41-
After clicking on a project name, you are taken to a screen where you can
51+
After opening the **Project Settings**, you are taken to a dialog where you can
4252
configure and start a new importer service job. Follow the steps below.
4353

4454
{{< tabs "importer-service" >}}
@@ -56,14 +66,14 @@ configure and start a new importer service job. Follow the steps below.
5666
{{< tab "OpenRouter" >}}
5767
1. Select **OpenRouter** from the **LLM API Provider** dropdown menu.
5868
2. Select the model you want to use from the **Model** dropdown menu. By default,
59-
the service is using **Mistral AI - Mistral Nemo**.
60-
1. Enter your **OpenAI API Key**.
61-
2. Enter your **OpenRouter API Key**.
62-
3. Click the **Start importer service** button.
69+
the service uses **Mistral AI - Mistral Nemo**.
70+
3. Enter your **OpenAI API Key**.
71+
4. Enter your **OpenRouter API Key**.
72+
5. Click the **Start importer service** button.
6373

6474
{{< info >}}
65-
When using the OpenRouter option, the LLM responses are served via OpenRouter
66-
while OpenAI is used for the embedding model.
75+
When using OpenRouter, you need both API keys because the LLM responses are served
76+
via OpenRouter while OpenAI is used for the embedding model.
6777
{{< /info >}}
6878

6979
![Configure Importer service using OpenRouter](../../images/graphrag-ui-configure-importer-openrouter.png)
@@ -86,31 +96,53 @@ service automatically downloads and loads models from the MLflow registry.
8696

8797
See also the [GraphRAG Importer](../reference/importer.md) service documentation.
8898

89-
## Upload your file
99+
## Add data source
100+
101+
To add your first data source:
90102

91-
1. Upload a file by dragging and dropping it in the designated upload area.
92-
The importer service you previously launched parses and creates the
93-
Knowledge Graph automatically.
94-
2. Enter a file name.
95-
3. Click the **Start import** button.
103+
1. In the **Data Sources** section, click the **Add data source** button.
104+
2. Upload a file by dragging and dropping it in the designated upload area.
105+
The importer service you previously configured will automatically parse the file
106+
and create the Knowledge Graph.
107+
3. Enter a descriptive name for your file.
108+
4. Click the **Start import** button.
96109

97110
{{< info >}}
98-
You can only import a single file, either in `.md` or `.txt` format.
111+
Currently, you can import one file at a time in either Markdown (`.md`) or
112+
plain text (`.txt`) format. Additional files can be added to update the Knowledge Graph.
99113
{{< /info >}}
100114

101115
![Upload file in GraphRAG web interface](../../images/graphrag-ui-upload-file.png)
102116

103117
## Explore the Knowledge Graph
104118

105-
You can open and explore the Knowledge Graph that has been generated by clicking
106-
on the **Explore in visualizer** button.
119+
After your file is processed, you can view and explore the generated Knowledge Graph
120+
in the **Graph** section.
121+
122+
![Explore Knowledge Graph in GraphRAG web interface](../../../images/graphrag-ui-explore-knowledge-graph.png)
123+
124+
For a more detailed exploration, click the **Explore** button to open the Knowledge Graph in the dedicated Graph Visualizer.
107125

108126
For more information, see the [Graph Visualizer](../../data-platform/graph-visualizer.md) documentation.
109127

128+
## Update the Knowledge Graph
129+
130+
Once you have created your initial Knowledge Graph, you can update it by uploading
131+
additional files using the same process described in the [Add data source](#add-data-source) section.
132+
The importer service will automatically update the existing Knowledge Graph and
133+
underlying collections with the new data.
134+
135+
To update your Knowledge Graph:
136+
137+
1. In the **Data Sources** section, click the **Add data source** button again.
138+
2. Upload a new file by dragging and dropping it in the designated upload area.
139+
3. The importer service will process the new file and update the existing Knowledge Graph along with the underlying collections.
140+
110141
## Configure the Retriever service
111142

112-
Creating the retriever service allows you to extract information from
113-
the generated Knowledge Graph. Follow the steps below to configure the service.
143+
The retriever service enables you to query and extract information from
144+
the generated Knowledge Graph. To configure the retriever service, open the
145+
**Project Settings** and follow the steps below.
114146

115147
{{< tabs "retriever-service" >}}
116148

@@ -132,8 +164,8 @@ the generated Knowledge Graph. Follow the steps below to configure the service.
132164
4. Click the **Start retriever service** button.
133165

134166
{{< info >}}
135-
When using the OpenRouter option, the LLM responses are served via OpenRouter
136-
while OpenAI is used for the embedding model.
167+
When using OpenRouter, the LLM responses are served via OpenRouter while OpenAI
168+
is used for the embedding model.
137169
{{< /info >}}
138170

139171
![Configure Retriever Service using OpenRouter](../../images/graphrag-ui-configure-retriever-openrouter.png)
45.7 KB
Loading
42 KB
Loading
56.8 KB
Loading
-55.8 KB
Loading
-65.4 KB
Loading
-46.1 KB
Loading
707 KB
Loading
-2.58 KB
Loading

0 commit comments

Comments
 (0)