Merge pull request #1 from StephanieHhnbrg/main

adds services to upload/download data, beautifies some components and…

3rdpartylicenses.txt → LICENSE

@@ -1,3 +1,13 @@
+MIT License
+
+Copyright 2024 Stephanie Hohenberg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 
 --------------------------------------------------------------------------------
 Package: @angular/common
@@ -292,17 +302,17 @@ License: "Apache-2.0"
 Package: tslib
 License: "0BSD"
 
-Copyright (c) Microsoft Corporation.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 PERFORMANCE OF THIS SOFTWARE.
 --------------------------------------------------------------------------------
 Package: zone.js

README.md

@@ -1,27 +1,41 @@
-# EquiSense
+# 🫧 EquiSense
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?color=blue)](./LICENSE)
 
-This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 18.1.4.
+### Introduction
+Due to AI's ability to learn from data and readjust itself, there is a risk of unintended consequences, 
+like ethical risks, biases (stereotyping, prejudice or favoritism) and unexplainable outcomes.
+This project provides a GUI to assess these risks. By analyzing responses of different GenAI models and judge them on different criteria,
+machine learning engineers and data scientists can identify, quantify, and mitigate biases, ensuring that the models align with ethical standards and produce more equitable and transparent outcomes.
 
-## Development server
+To achieve this goal, several GenAI APIs have been integrated to address the following three use cases:
+1. Prompt Generation: Generate prompts based on a user-selected topic.
+2. Response Generation: Produce responses from the integrated GenAI models.
+3. Response Evaluation: Assess the generated responses using criteria such as bias, ... .
 
-Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
 
-## Code scaffolding
+### Tutorial
+To execute any request to a GenAI API, you must provide a valid API key for the selected service. 
+This can be done using the `🔑 Keys` button in the toolbar.
 
-Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
+If an API key is missing or invalid, an alert will appear when attempting to perform any GenAI operation, 
+and any invalid key will be automatically removed.
 
-## Build
+Once a valid key is entered, you can initiate GenAI operations by clicking the `➕ Prompts` button in the toolbar, 
+or by using the `🫧 Generate responses` and `⭐ Rate responses` buttons within the expansion panels of the topics.
 
-Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
+### APIs & Models
+The following APIs and models are currently supported:
 
-## Running unit tests
+API | Model 
+--- |-------
+Gemini | `gemini-1.0-pro`, `gemini-1.5-pro`, `gemini-1.5-flash`
+OpenAI | `gpt-3.5-turbo`, `gpt-3.5-turbo-0125`, `gpt-3.5-turbo-1106`, `gpt-3.5-turbo-16k`, `gpt-4o-mini`
 
-Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
 
-## Running end-to-end tests
 
-Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
+### Local set up
+This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 18.1.4and is deployed as a <a href='https://stephaniehhnbrg.github.io/EquiSense/' target='_blank'>Github Page</a>.
+But in case you would like to run the project locally, follow these steps:
 
-## Further help
-
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
+- Install dependencies: `npm install`
+- Start project: `npm run start`

angular.json

@@ -37,8 +37,8 @@
               "budgets": [
                 {
                   "type": "initial",
-                  "maximumWarning": "500kB",
-                  "maximumError": "1MB"
+                  "maximumWarning": "3MB",
+                  "maximumError": "5MB"
                 },
                 {
                   "type": "anyComponentStyle",