Die AIUtils stehen nur zur Verfügung, wenn man das Modul „KI-Assistent“ lizenziert hat.
Code
AIStructuredOutputConfig addIntList(AIStructuredOutputConfig config, String key, boolean required, String description)
AIStructuredOutputConfig addIntList(AIStructuredOutputConfig config, String key, boolean required, String description, List<Integer> defaultValue)
Beschreibung
Fügt einer AIStructuredOutputConfig ein Listenfeld mit Integer-Werten hinzu.
Mit dieser Methode definieren Sie ein Feld für eine Liste von Ganzzahlen innerhalb einer strukturierten KI-Antwort. Dabei legen Sie den Feldnamen, die fachliche Beschreibung und fest, ob die Liste erforderlich ist oder von der KI weggelassen werden darf.
Optional kann zusätzlich ein Standardwert angegeben werden. Dieser wird bei der Nachverarbeitung verwendet, wenn das Feld in der KI-Antwort fehlt oder null ist.
Die übergebene Konfiguration wird direkt verändert. Eine erneute Zuweisung des Rückgabewerts ist daher nicht erforderlich.
Parameter
-
config(AIStructuredOutputConfig) - DieAIStructuredOutputConfig, die erweitert werden soll. -
key(String) - Der Feldschlüssel innerhalb des aktuellen Objekts, z. B."quantities". -
required(boolean) - Legt fest, ob die Liste erforderlich ist.-
true: Die Liste ist erforderlich. -
false: Die KI darf die gesamte Liste weglassen.
-
-
description(String) - Fachliche Beschreibung des Felds. Diese Beschreibung wird verwendet, um der KI die Bedeutung und den erwarteten Inhalt der Liste zu verdeutlichen. -
defaultValue(List<Integer>) - optional Standardwert vom TypList<Integer>, der bei der Nachverarbeitung eingesetzt wird, wenn das Feld fehlt odernullist.
Rückgabe
AIStructuredOutputConfig - Im Erfolgsfall gibt die Methode dieselbe AIStructuredOutputConfig-Instanz zurück. Im Fehlerfall wird keine Konfiguration zurückgegeben. Stattdessen wird eine IllegalArgumentException ausgelöst, z. B. wenn übergebene Argumente ungültig sind.
Beispiele
Einfaches Integer-Listenfeld definieren
AIStructuredOutputConfig config = AIUtils.createStructuredConfig()
AIUtils.addIntList(
config,
"quantities",
true,
"Extracted quantities"
)
Optionales Listenfeld mit Standardwert
AIStructuredOutputConfig defaultConfig = AIUtils.createStructuredConfig()
AIUtils.addIntList(
defaultConfig,
"mentionedYears",
false,
"All years mentioned in the text. If no years are recognizable, omit the field.",
[2026]
)
Verwendung in einer strukturierten Antwort
AIStructuredOutputConfig analysisConfig = AIUtils.createStructuredConfig()
AIUtils.addIntList(
analysisConfig,
"mentionedYears",
true,
"All years mentioned in the text"
)
Map<String, Object> systemVars = [:]
Map<String, Object> userVars = ["text": "The contract was concluded in 2022 and extended in 2024."]
IAIResult result = AIUtils.executePrompt("AnalyseCheck", analysisConfig, systemVars, userVars)
if (AIUtils.isAIResponseSuccessful(result)) {
Map<String, Object> data = AIUtils.getAIStructuredResponse(result)
List<Integer> mentionedYears = (List<Integer>) data.get("mentionedYears")
} else {
String errorMessage = AIUtils.getAIResponseError(result)
}