addString

Versionshinweise	26.6

Die AIUtils stehen nur zur Verfügung, wenn man das Modul „KI-Assistent“ lizenziert hat.

Code

GROOVY

AIStructuredOutputConfig addString(AIStructuredOutputConfig config, String key, boolean required, String description)
AIStructuredOutputConfig addString(AIStructuredOutputConfig config, String key, boolean required, String description, String defaultValue)

Beschreibung

Fügt einer AIStructuredOutputConfig ein String-Feld hinzu.

Mit dieser Methode definieren Sie ein Feld innerhalb einer strukturierten KI-Antwort. Dabei legen Sie den Feldnamen, die fachliche Beschreibung und fest, ob das Feld erforderlich ist oder von der KI weggelassen werden darf.

Optional kann zusätzlich ein Default-Wert 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: Die AIStructuredOutputConfig, die erweitert werden soll.
key: Der Feldschlüssel innerhalb des aktuellen Objekts, z. B. "customerName".
required: Legt fest, ob das Feld erforderlich ist.
- true: Das Feld ist erforderlich.
- false: Die KI darf das Feld weglassen.
description: Fachliche Beschreibung des Felds. Diese Beschreibung wird verwendet, um der KI die Bedeutung und den erwarteten Inhalt des Felds zu verdeutlichen.
defaultValue: Optionaler Fallback-Wert, der bei der Nachverarbeitung eingesetzt wird, wenn das Feld fehlt oder null ist.

Rückgabe und Fehlerverhalten

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

1. Einfaches String-Feld definieren

GROOVY

AIStructuredOutputConfig config = AIUtils.createStructuredConfig()

AIUtils.addString(
    config,
    "customerName",
    true,
    "Vollständiger Name des Kunden"
)

2. Optionales Feld mit Default-Wert

GROOVY

AIStructuredOutputConfig config = AIUtils.createStructuredConfig()

AIUtils.addString(
    config,
    "city",
    false,
    "Stadt des Kunden. Wenn nicht eindeutig erkennbar, Feld weglassen.",
    "Unbekannt"
)

3. Verwendung in einer strukturierten Antwort

GROOVY

AIStructuredOutputConfig config = AIUtils.createStructuredConfig()

AIUtils.addString(
    config,
    "status",
    true,
    "Klassifizierung der Anfrage"
)

Map<String, Object> systemVars = [:]
Map<String, Object> userVars = ["text": "Ich habe mein Passwort vergessen."]

IAIResult result = AIUtils.executePrompt("AnalyseCheck", config, systemVars, userVars)

if (AIUtils.isAIResponseSuccessful(result)) {
    Map<String, Object> data = AIUtils.getAIStructuredResponse(result)
    String status = (String) data.get("status")
} else {
    String errorMessage = AIUtils.getAIResponseError(result)
}