Iris: Get offered models from Pyris (#6886)

src/main/java/de/tum/in/www1/artemis/domain/iris/settings/IrisSubSettings.java

@@ -10,7 +10,6 @@
 
 import de.tum.in.www1.artemis.domain.DomainObject;
 import de.tum.in.www1.artemis.domain.iris.IrisTemplate;
-import de.tum.in.www1.artemis.service.connectors.iris.IrisModel;
 
 /**
  * An IrisSubSettings object represents the settings for a specific feature of Iris.
@@ -31,8 +30,7 @@ public class IrisSubSettings extends DomainObject {
 
     @Nullable
     @Column(name = "preferredModel")
-    @Enumerated(EnumType.STRING)
-    private IrisModel preferredModel;
+    private String preferredModel;
 
     public boolean isEnabled() {
         return enabled;
@@ -52,11 +50,11 @@ public void setTemplate(@Nullable IrisTemplate template) {
     }
 
     @Nullable
-    public IrisModel getPreferredModel() {
+    public String getPreferredModel() {
         return preferredModel;
     }
 
-    public void setPreferredModel(@Nullable IrisModel preferredModel) {
+    public void setPreferredModel(@Nullable String preferredModel) {
         this.preferredModel = preferredModel;
     }
 }

src/main/java/de/tum/in/www1/artemis/service/connectors/iris/IrisConnectorService.java

@@ -1,5 +1,7 @@
 package de.tum.in.www1.artemis.service.connectors.iris;
 
+import java.util.Arrays;
+import java.util.List;
 import java.util.Map;
 import java.util.concurrent.CompletableFuture;
 
@@ -19,6 +21,7 @@
 import de.tum.in.www1.artemis.domain.iris.IrisTemplate;
 import de.tum.in.www1.artemis.service.connectors.iris.dto.IrisErrorResponseDTO;
 import de.tum.in.www1.artemis.service.connectors.iris.dto.IrisMessageResponseDTO;
+import de.tum.in.www1.artemis.service.connectors.iris.dto.IrisModelDTO;
 import de.tum.in.www1.artemis.service.connectors.iris.dto.IrisRequestDTO;
 import de.tum.in.www1.artemis.service.iris.exception.*;
 
@@ -50,14 +53,27 @@ public IrisConnectorService(@Qualifier("irisRestTemplate") RestTemplate restTemp
      *                           not reachable)
      * @param parameters     A map of parameters to be included in the template through handlebars (if they are specified
      *                           in the template)
-     * @return The message response to the request which includes the {@link de.tum.in.www1.artemis.domain.iris.IrisMessage} and the used {@link IrisModel}
+     * @return The message response to the request which includes the {@link de.tum.in.www1.artemis.domain.iris.IrisMessage} and the used IrisModel
      */
     @Async
-    public CompletableFuture<IrisMessageResponseDTO> sendRequest(IrisTemplate template, IrisModel preferredModel, Map<String, Object> parameters) {
+    public CompletableFuture<IrisMessageResponseDTO> sendRequest(IrisTemplate template, String preferredModel, Map<String, Object> parameters) {
         var request = new IrisRequestDTO(template, preferredModel, parameters);
         return sendRequest(request);
     }
 
+    /**
+     * Requests all available models from Pyris
+     *
+     * @return A list of available Models as IrisModelDTO
+     */
+    public List<IrisModelDTO> getOfferedModels() throws IrisConnectorException {
+        var response = restTemplate.getForEntity(irisUrl + "/api/v1/models", JsonNode.class);
+        if (!response.getStatusCode().is2xxSuccessful() || !response.hasBody()) {
+            throw new IrisConnectorException("Could not fetch offered models");
+        }
+        return Arrays.asList((IrisModelDTO[]) parseResponse(response.getBody(), IrisModelDTO.class.arrayType()));
+    }
+
     private CompletableFuture<IrisMessageResponseDTO> sendRequest(IrisRequestDTO request) {
         try {
             try {

src/main/java/de/tum/in/www1/artemis/service/connectors/iris/dto/IrisMessageResponseDTO.java

@@ -1,7 +1,6 @@
 package de.tum.in.www1.artemis.service.connectors.iris.dto;
 
 import de.tum.in.www1.artemis.domain.iris.IrisMessage;
-import de.tum.in.www1.artemis.service.connectors.iris.IrisModel;
 
-public record IrisMessageResponseDTO(IrisModel usedModel, IrisMessage message) {
+public record IrisMessageResponseDTO(String usedModel, IrisMessage message) {
 }

src/main/java/de/tum/in/www1/artemis/service/connectors/iris/dto/IrisModelDTO.java

@@ -0,0 +1,4 @@
+package de.tum.in.www1.artemis.service.connectors.iris.dto;
+
+public record IrisModelDTO(String id, String name, String description) {
+}

src/main/java/de/tum/in/www1/artemis/service/connectors/iris/dto/IrisRequestDTO.java

@@ -3,7 +3,6 @@
 import java.util.Map;
 
 import de.tum.in.www1.artemis.domain.iris.IrisTemplate;
-import de.tum.in.www1.artemis.service.connectors.iris.IrisModel;
 
-public record IrisRequestDTO(IrisTemplate template, IrisModel preferredModel, Map<String, Object> parameters) {
+public record IrisRequestDTO(IrisTemplate template, String preferredModel, Map<String, Object> parameters) {
 }

src/main/java/de/tum/in/www1/artemis/service/connectors/iris/dto/IrisStatusDTO.java

@@ -2,9 +2,7 @@
 
 import java.util.Map;
 
-import de.tum.in.www1.artemis.service.connectors.iris.IrisModel;
-
-public record IrisStatusDTO(Map<IrisModel, ModelStatus> modelStatuses) {
+public record IrisStatusDTO(Map<String, ModelStatus> modelStatuses) {
 
     public enum ModelStatus {
         UP, DOWN, NOT_AVAILABLE

src/main/java/de/tum/in/www1/artemis/service/iris/IrisSettingsService.java

@@ -21,7 +21,6 @@
 import de.tum.in.www1.artemis.repository.CourseRepository;
 import de.tum.in.www1.artemis.repository.ProgrammingExerciseRepository;
 import de.tum.in.www1.artemis.repository.iris.IrisSettingsRepository;
-import de.tum.in.www1.artemis.service.connectors.iris.IrisModel;
 import de.tum.in.www1.artemis.web.rest.errors.AccessForbiddenException;
 import de.tum.in.www1.artemis.web.rest.errors.BadRequestAlertException;
 
@@ -229,16 +228,13 @@ private IrisSubSettings combineSubSettings(IrisSubSettings subSettings1, IrisSub
         combinedSettings.setEnabled(enabled);
 
         if (!reduced) {
-            IrisModel preferredModel;
+            String preferredModel = null;
             if (subSettings2 != null && subSettings2.getPreferredModel() != null) {
                 preferredModel = subSettings2.getPreferredModel();
             }
             else if (subSettings1 != null && subSettings1.getPreferredModel() != null) {
                 preferredModel = subSettings1.getPreferredModel();
             }
-            else {
-                preferredModel = IrisModel.GPT35_TURBO;
-            }
             combinedSettings.setPreferredModel(preferredModel);
 
             IrisTemplate template;

src/main/java/de/tum/in/www1/artemis/web/rest/iris/IrisModelsResource.java

@@ -0,0 +1,47 @@
+package de.tum.in.www1.artemis.web.rest.iris;
+
+import java.util.List;
+
+import org.springframework.context.annotation.Profile;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import de.tum.in.www1.artemis.security.annotations.EnforceAtLeastEditor;
+import de.tum.in.www1.artemis.service.connectors.iris.IrisConnectorException;
+import de.tum.in.www1.artemis.service.connectors.iris.IrisConnectorService;
+import de.tum.in.www1.artemis.service.connectors.iris.dto.IrisModelDTO;
+import de.tum.in.www1.artemis.web.rest.errors.InternalServerErrorException;
+
+/**
+ * REST controller for managing the models Pyris provides.
+ */
+@RestController
+@Profile("iris")
+@RequestMapping("api/")
+public class IrisModelsResource {
+
+    private final IrisConnectorService irisConnectorService;
+
+    public IrisModelsResource(IrisConnectorService irisConnectorService) {
+        this.irisConnectorService = irisConnectorService;
+    }
+
+    /**
+     * GET iris/models: Retrieve all available models offered by Pyris
+     *
+     * @return the {@link ResponseEntity} with status {@code 200 (Ok)} and with body a List of the models
+     */
+    @GetMapping("iris/models")
+    @EnforceAtLeastEditor
+    public ResponseEntity<List<IrisModelDTO>> getAllModels() {
+        try {
+            var models = irisConnectorService.getOfferedModels();
+            return ResponseEntity.ok(models);
+        }
+        catch (IrisConnectorException e) {
+            throw new InternalServerErrorException("Could not fetch available Iris models");
+        }
+    }
+}

src/main/resources/config/liquibase/changelog/20230717171717_changelog.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                   xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog https://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd">
+    <changeSet id="20230717171717" author="morrien">
+        <modifyDataType tableName="iris_sub_settings" columnName="preferred_model" newDataType="VARCHAR(100)" />
+    </changeSet>
+</databaseChangeLog>

src/main/resources/config/liquibase/master.xml

@@ -52,6 +52,7 @@
     <include file="classpath:config/liquibase/changelog/20230626220000_changelog.xml" relativeToChangelogFile="false"/>
     <include file="classpath:config/liquibase/changelog/20230629194400_changelog.xml" relativeToChangelogFile="false"/>
     <include file="classpath:config/liquibase/changelog/20230714012100_changelog.xml" relativeToChangelogFile="false"/>
+    <include file="classpath:config/liquibase/changelog/20230717171717_changelog.xml" relativeToChangelogFile="false"/>
     <!-- NOTE: please use the format "YYYYMMDDhhmmss_changelog.xml", i.e. year month day hour minutes seconds and not something else! -->
     <!-- we should also stay in a chronological order! -->
     <!-- you can use the command 'date '+%Y%m%d%H%M%S'' to get the current date and time in the correct format -->

src/main/webapp/app/entities/iris/settings/iris-model.ts

@@ -0,0 +1,5 @@
+export class IrisModel {
+    id: string;
+    name: string;
+    description: string;
+}

src/main/webapp/app/entities/iris/settings/iris-sub-settings.model.ts

@@ -1,13 +1,9 @@
 import { BaseEntity } from 'app/shared/model/base-entity';
 import { IrisTemplate } from 'app/entities/iris/settings/iris-template';
 
-export enum IrisModel {
-    GPT35 = 'GPT35',
-}
-
 export class IrisSubSettings implements BaseEntity {
     id?: number;
     enabled = false;
     template?: IrisTemplate;
-    preferredModel?: IrisModel;
+    preferredModel?: string;
 }

src/main/webapp/app/iris/settings/iris-settings-update/iris-settings-update.component.html

@@ -1,21 +1,31 @@
 <div>
     <jhi-button id="reload" [btnType]="PRIMARY" [isLoading]="isLoading" [icon]="faRotate" [title]="'artemisApp.iris.settings.button.reload'" (onClick)="loadIrisSettings()">
     </jhi-button>
-    <jhi-button id="save" [btnType]="SUCCESS" [isLoading]="isSaving" [icon]="faSave" [title]="'artemisApp.iris.settings.button.save'" (onClick)="saveIrisSettings()"> </jhi-button>
+    <jhi-button id="save" [btnType]="SUCCESS" [isLoading]="isSaving" [icon]="faSave" [title]="'artemisApp.iris.settings.button.save'" (onClick)="saveIrisSettings()"></jhi-button>
 </div>
 <div *ngIf="irisSettings">
     <h3 jhiTranslate="artemisApp.iris.settings.subSettings.chatSettings">Chat Settings</h3>
     <div>
-        <jhi-iris-sub-settings-update [subSettings]="irisSettings!.irisChatSettings!" [templateOptional]="settingType !== GLOBAL"></jhi-iris-sub-settings-update>
+        <jhi-iris-sub-settings-update
+            [subSettings]="irisSettings!.irisChatSettings!"
+            [models]="irisModels ?? []"
+            [templateOptional]="settingType !== GLOBAL"
+            [modelOptional]="settingType !== GLOBAL"
+        ></jhi-iris-sub-settings-update>
     </div>
     <hr class="hr" />
 
     <h3 jhiTranslate="artemisApp.iris.settings.subSettings.hestiaSettings">Hestia Settings</h3>
     <div *ngIf="settingType === PROGRAMMING_EXERCISE" class="form-check form-switch">
         <input class="form-check-input" type="checkbox" id="inheritHestia" [checked]="!irisSettings?.irisHestiaSettings" (change)="onInheritHestiaSettingsChanged()" />
-        <label class="form-check-label" for="inheritHestia" jhiTranslate="artemisApp.iris.settings.subSettings.inheritHestiaSettings">Inherit</label>
+        <label class="form-check-label" for="inheritHestia" jhiTranslate="artemisApp.iris.settings.subSettings.inheritHestiaSettings"> Inherit </label>
     </div>
     <div *ngIf="irisSettings!.irisHestiaSettings">
-        <jhi-iris-sub-settings-update [subSettings]="irisSettings!.irisHestiaSettings!" [templateOptional]="settingType !== GLOBAL"></jhi-iris-sub-settings-update>
+        <jhi-iris-sub-settings-update
+            [subSettings]="irisSettings!.irisHestiaSettings!"
+            [models]="irisModels ?? []"
+            [templateOptional]="settingType !== GLOBAL"
+            [modelOptional]="settingType !== GLOBAL"
+        ></jhi-iris-sub-settings-update>
     </div>
 </div>

src/main/webapp/app/iris/settings/iris-settings-update/iris-settings-update.component.ts

@@ -7,6 +7,7 @@ import { AlertService } from 'app/core/util/alert.service';
 import { ButtonType } from 'app/shared/components/button.component';
 import { faRotate, faSave } from '@fortawesome/free-solid-svg-icons';
 import { IrisSubSettings } from 'app/entities/iris/settings/iris-sub-settings.model';
+import { IrisModel } from 'app/entities/iris/settings/iris-model';
 
 export enum IrisSettingsType {
     GLOBAL = 'GLOBAL',
@@ -27,6 +28,7 @@ export class IrisSettingsUpdateComponent implements OnInit {
     public programmingExerciseId?: number;
 
     public irisSettings?: IrisSettings;
+    public irisModels?: IrisModel[];
 
     // Loading bools
     isLoading = false;
@@ -47,10 +49,17 @@ export class IrisSettingsUpdateComponent implements OnInit {
         this.loadIrisSettings();
     }
 
+    loadIrisModels(): void {
+        this.irisSettingsService.getIrisModels().subscribe((models) => {
+            this.irisModels = models;
+            this.isLoading = false;
+        });
+    }
+
     loadIrisSettings(): void {
         this.isLoading = true;
         this.loadIrisSettingsObservable().subscribe((settings) => {
-            this.isLoading = false;
+            this.loadIrisModels();
             if (!settings) {
                 this.alertService.error('artemisApp.iris.settings.error.noSettings');
             }

src/main/webapp/app/iris/settings/iris-settings-update/iris-sub-settings-update/iris-sub-settings-update.component.html

@@ -2,7 +2,20 @@
     <input class="form-check-input" type="checkbox" id="flexSwitchCheckDefault" [(ngModel)]="subSettings!.enabled" />
     <label class="form-check-label" for="flexSwitchCheckDefault" jhiTranslate="artemisApp.iris.settings.subSettings.enabled-disabled"> Enabled/Disabled </label>
 </div>
-<span><span class="fw-bold" jhiTranslate="artemisApp.iris.settings.subSettings.preferredModel">Preferred Model</span>: {{ subSettings.preferredModel }}</span>
+<span><span class="fw-bold" jhiTranslate="artemisApp.iris.settings.subSettings.preferredModel">Preferred Model</span>: </span>
+<div *ngIf="true" ngbDropdown class="d-inline-block me-2">
+    <button class="btn btn-outline-primary w-100" id="dropdownBasic1" ngbDropdownToggle>
+        {{ getSelectedModelName() }}
+    </button>
+    <div ngbDropdownMenu aria-labelledby="dropdownBasic1">
+        <button *ngIf="modelOptional" (click)="setModel(undefined)" [class.selected]="subSettings.preferredModel === undefined" ngbDropdownItem>
+            {{ 'artemisApp.iris.settings.subSettings.inheritModel' | artemisTranslate }}
+        </button>
+        <button *ngFor="let model of models" (click)="setModel(model)" [class.selected]="model.id === subSettings.preferredModel" [ngbTooltip]="model.description" ngbDropdownItem>
+            {{ model.name }}
+        </button>
+    </div>
+</div>
 <div class="mb-3">
     <label class="form-label fs-4 fw-bold" for="template-editor" jhiTranslate="artemisApp.iris.settings.subSettings.template.title"> Template </label>
     <div *ngIf="templateOptional" class="form-check form-switch">

src/main/webapp/app/iris/settings/iris-settings-update/iris-sub-settings-update/iris-sub-settings-update.component.ts

@@ -1,6 +1,7 @@
 import { Component, Input } from '@angular/core';
 import { IrisSubSettings } from 'app/entities/iris/settings/iris-sub-settings.model';
 import { IrisTemplate } from 'app/entities/iris/settings/iris-template';
+import { IrisModel } from 'app/entities/iris/settings/iris-model';
 
 @Component({
     selector: 'jhi-iris-sub-settings-update',
@@ -10,6 +11,12 @@ export class IrisSubSettingsUpdateComponent {
     @Input()
     subSettings: IrisSubSettings;
 
+    @Input()
+    models: IrisModel[];
+
+    @Input()
+    modelOptional = false;
+
     @Input()
     templateOptional = false;
 
@@ -25,4 +32,12 @@ export class IrisSubSettingsUpdateComponent {
             this.subSettings.template = this.previousTemplate ?? irisTemplate;
         }
     }
+
+    getSelectedModelName(): string {
+        return this.models.find((model) => model.id === this.subSettings.preferredModel)?.name ?? this.subSettings.preferredModel ?? 'None';
+    }
+
+    setModel(model: IrisModel | undefined) {
+        this.subSettings.preferredModel = model?.id;
+    }
 }

src/main/webapp/app/iris/settings/shared/iris-settings.service.ts

@@ -3,6 +3,7 @@ import { HttpClient, HttpResponse } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { map } from 'rxjs/operators';
 import { IrisSettings } from 'app/entities/iris/settings/iris-settings.model';
+import { IrisModel } from 'app/entities/iris/settings/iris-model';
 
 type EntityResponseType = HttpResponse<IrisSettings>;
 
@@ -89,4 +90,11 @@ export class IrisSettingsService {
     setProgrammingExerciseSettings(exerciseId: number, settings: IrisSettings): Observable<EntityResponseType> {
         return this.http.put<IrisSettings>(`${this.resourceUrl}/programming-exercises/${exerciseId}/raw-iris-settings`, settings, { observe: 'response' });
     }
+
+    /**
+     * Get the global Iris settings
+     */
+    getIrisModels(): Observable<IrisModel[] | undefined> {
+        return this.http.get<IrisModel[]>(`${this.resourceUrl}/iris/models`, { observe: 'response' }).pipe(map((res: HttpResponse<IrisModel[]>) => res.body ?? []));
+    }
 }

src/main/webapp/i18n/de/iris.json

@@ -26,6 +26,7 @@
                     "inheritHestiaSettings": "Vererbe Hestia Einstellungen",
                     "enabled-disabled": "Aktiviert/Deaktiviert",
                     "preferredModel": "Präferiertes Modell",
+                    "inheritModel": "Vererbe Modell",
                     "template": {
                         "title": "Template",
                         "inherit": "Inherit Template"

src/main/webapp/i18n/en/iris.json

@@ -26,6 +26,7 @@
                     "inheritHestiaSettings": "Inherit Hestia Settings",
                     "enabled-disabled": "Enabled/Disabled",
                     "preferredModel": "Preferred Model",
+                    "inheritModel": "Inherit Modell",
                     "template": {
                         "title": "Template",
                         "inherit": "Inherit Template"