addBoolean

Versionshinweise	26.6

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

Code

GROOVY

AIStructuredOutputConfig addBoolean(AIStructuredOutputConfig config, String key, boolean required, String description)
AIStructuredOutputConfig addBoolean(AIStructuredOutputConfig config, String key, boolean required, String description, Boolean defaultValue)

Beschreibung

Fügt einer AIStructuredOutputConfig ein Feld vom Typ Boolean hinzu.

Mit dieser Methode definieren Sie ein Wahrheitswert-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. "paid".
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 vom Typ Boolean, 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 Boolean-Feld definieren

GROOVY

AIStructuredOutputConfig config = AIUtils.createStructuredConfig()

AIUtils.addBoolean(
    config,
    "paid",
    false,
    "Ob die Rechnung bereits bezahlt wurde"
)

2. Optionales Feld mit Default-Wert

GROOVY

AIStructuredOutputConfig config = AIUtils.createStructuredConfig()

AIUtils.addBoolean(
    config,
    "isCustomer",
    false,
    "Ob die Person bereits Kunde ist. Wenn nicht eindeutig erkennbar, Feld weglassen.",
    false
)

3. Verwendung in einer strukturierten Antwort

GROOVY

AIStructuredOutputConfig config = AIUtils.createStructuredConfig()

AIUtils.addBoolean(
    config,
    "urgent",
    true,
    "Ob die Anfrage als dringend einzustufen ist"
)

Map<String, Object> systemVars = [:]
Map<String, Object> userVars = ["text": "Bitte melden Sie sich noch heute. Das ist sehr dringend."]

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

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