Skip to content

Commit

Permalink
docs: Add introduction, screenshots of the application and team secti…
Browse files Browse the repository at this point in the history 
…on to readme
  • Loading branch information
@SverreNystad
SverreNystad committed Nov 28, 2024
1 parent 5341477 commit d11e94b
Showing 1 changed file with 129 additions and 0 deletions.
129 changes: 129 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,95 @@
# NTNU KPRO AI Assistant

Each year, the Norwegian public spends about 5.6 billion NOK on planning and validating building applications. The process is complex, time-consuming, and often yields poor-quality submissions. The KartAI project aims to streamline this by developing AI tools to support the application process. The project is a collaboration between the Norwegian University of Science and Technology (NTNU) and KartAI.

KatAI's main goal is to streamline municipal work processes related to cadastre and building case processing using automated, advanced data-driven methods, including artificial intelligence in combination with proactive user and citizen dialogue. The goal is to contribute to automating and streamlining the processing of building cases.



The scope of the project consists of two primary objectives:

* **Develop a Web Application:** This platform will serve as a centralized hub, integrating the various AI models available through the KartAI project. By bringing these models together, the application will serve as a proof-of-concept (PoC), allowing KartAI to display their assortment of AI tools for different stages of the application process.

* **Create a Summary AI Assistant:** This AI-driven tool analyze documents from submitted applications and generate concise summaries, highlighting key points. The system implements a checklist matching feature. It cross-reference the building application with an official checklist and relevant regulations and inform about the quality of the application. This functionality is designed to support both applicants and case workers, enhancing the overall efficiency and clarity of the application process


## Final Product
The following is a brief overview of the final product, including the system architecture and screenshots of the web application and the AI Summary Assistant.
![System Architecture](/docs/images/system-architecture.png)

### Screenshots of the Final Product


<details>
<summary><b>Click to see Web Application screenshots</b></summary>

1. **Landing Page**
The landing page for the web application.
![Landing Page](docs/images/web-application/landing-page.png)

2. **Landing Page with Navbar**
The landing page with the navigation bar displayed.
![Navbar](docs/images/web-application/navbar.png)

3. **3D Tiltaksvisning**
The page for 3D visualization of projects.
![3D View](docs/images/web-application/3d-view.png)

4. **PlanChat**
A chat window designed to answer questions about laws and regulations.
![PlanChat](docs/images/web-application/planprate-page.png)

5. **ArkivGPT Interface**
The user interface for interacting with the ArkivGPT AI model.
![ArkivGPT Interface](docs/images/web-application/arkivgpt-page.png)

6. **ArkivGPT Results**
Displaying results from an ArkivGPT query.
![ArkivGPT Results](docs/images/web-application/arkivgpt-page-result.png)

7. **File Preview**
Previewing files related to ArkivGPT queries.
![File Preview](docs/images/web-application/file-preview.png)

8. **CADAiD Request**
User interface for requesting validation from the CADAiD model.
![CADAiD Request](docs/images/web-application/cadaid.png)

9. **CADAiD Results**
Results generated from the CADAiD model.
![CADAiD Results](docs/images/web-application/cadaid-file.png)

10. **Applications Overview**
A page showing an overview of applications for municipality workers.
![Applications Overview](docs/images/web-application/applications.png)

11. **Municipality Dashboard (Top)**
The dashboard for municipality workers showing checklist maps.
![Municipality Dashboard Top](docs/images/web-application/municipality-top.png)

12. **Municipality Dashboard (Bottom)**
The dashboard displaying checklist maps and AI model results.
![Municipality Dashboard Bottom](docs/images/web-application/municipality-bot.png)

13. **User Dashboard**
The dashboard where applicants can review their applications using various AI models.
![User Dashboard](docs/images/web-application/user-dashboard.png)


</details>

<details>
<summary><b>Click to see AI Summary Assistant Screenshots</b></summary>

1. **AI Summary Assistant**
The graph showing the AI agent structure.
![AI Summary Assistant](docs/images/ai-summary-assistant/ai-system-graph.jpeg)
2. **LangSmith tracking**
The monitoring of the agent showing what choices it makes.
Here one can see the agent have retrieved relevant laws and regulations from vector database and done a web search, as well reflect on the output of it self before marking the checkpoint and giving its reasoning.
![LangSmith tracking](docs/images/ai-summary-assistant/langsmith-tracking.png)
</details>

## Prerequisites

Before you start, make sure the following tools are installed on your system:
Expand Down Expand Up @@ -41,3 +124,49 @@ docker compose down

- [Developer Setup](/docs/manuals/developer_setup.md)
- [T3 Start Guide](/docs/manuals/t3_guide.md)


## Team

The team behind this project is a group of students at NTNU in Trondheim. The team consists of:

<table align="center">
<tr>
<td align="center">
<a href="https://github.com/andreaslhjulstad">
<img src="https://github.com/andreaslhjulstad.png?size=100" width="100px;" alt="Andreas Lilleby Hjulstad"/><br />
<sub><b>Andreas Lilleby Hjulstad</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/ArtemisAaroe">
<img src="https://github.com/ArtemisAaroe.png?size=100" width="100px;" alt="Artemis Kjøllmoen Aarø"/><br />
<sub><b>Artemis Kjøllmoen Aarø</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/johanneeo">
<img src="https://github.com/johanneeo.png?size=100" width="100px;" alt="Johanne Eide Omland"/><br />
<sub><b>Johanne Eide Olsnes</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/magnusgiverin">
<img src="https://github.com/magnusgiverin.png?size=100" width="100px;" alt="Magnus Giverin"/><br />
<sub><b>Magnus Giverin</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/maurice-wegerif">
<img src="https://github.com/maurice-wegerif.png?size=100" width="100px;" alt="Maurice Wegerif"/><br />
<sub><b>Maurice Wegerif</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/SverreNystad">
<img src="https://github.com/SverreNystad.png?size=100" width="100px;" alt="Sverre Nystad"/><br />
<sub><b>Sverre Nystad</b></sub>
</a>
</td>
</tr>
</table>

0 comments on commit d11e94b

Please sign in to comment.