addInt

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

Code

AIStructuredOutputConfig addInt(AIStructuredOutputConfig config, String key, boolean required, String description)
AIStructuredOutputConfig addInt(AIStructuredOutputConfig config, String key, boolean required, String description, Integer defaultValue)

Beschreibung

Fügt einer AIStructuredOutputConfig ein Integer-Feld hinzu.

Mit dieser Methode definieren Sie ein numerisches Ganzzahlfeld 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. "quantity".

• 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 Integer, 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 Integer-Feld definieren

AIStructuredOutputConfig config = AIUtils.createStructuredConfig()

AIUtils.addInt(
    config,
    "quantity",
    true,
    "Anzahl der bestellten Artikel"
)

2. Optionales Feld mit Default-Wert

AIStructuredOutputConfig config = AIUtils.createStructuredConfig()

AIUtils.addInt(
    config,
    "age",
    false,
    "Alter der Person in Jahren. Wenn nicht eindeutig erkennbar, Feld weglassen.",
    0
)

3. Verwendung in einer strukturierten Antwort

AIStructuredOutputConfig config = AIUtils.createStructuredConfig()

AIUtils.addInt(
    config,
    "priorityScore",
    true,
    "Priorität der Anfrage als Ganzzahl zwischen 1 und 10"
)

Map<String, Object> systemVars = [:]
Map<String, Object> userVars = ["text": "Die Anfrage ist sehr dringend und sollte heute bearbeitet werden."]

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

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