Auto Light Dark
Auto Light Dark
German English

addBoolean

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

Code

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 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) - Die AIStructuredOutputConfig, die erweitert werden soll.

  • key (String) - Der Feldschlüssel innerhalb des aktuellen Objekts, z. B. "paid".

  • required (boolean) - Legt fest, ob das Feld erforderlich ist.

    • true: Das Feld ist erforderlich.

    • false: Die KI darf das Feld weglassen.

  • description (String) - Fachliche Beschreibung des Felds. Diese Beschreibung wird verwendet, um der KI die Bedeutung und den erwarteten Inhalt des Felds zu verdeutlichen.

  • defaultValue (Boolean) - optional Standardwert vom Typ Boolean, der bei der Nachverarbeitung eingesetzt wird, wenn das Feld fehlt oder null ist.

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 Boolean-Feld definieren

AIStructuredOutputConfig config = AIUtils.createStructuredConfig()

AIUtils.addBoolean(
  config,
  "paid",
  false,
  "Whether the invoice has already been paid"
)

Optionales Feld mit Standardwert

AIStructuredOutputConfig defaultConfig = AIUtils.createStructuredConfig()

AIUtils.addBoolean(
  defaultConfig,
  "isCustomer",
  false,
  "Whether the person is already a customer. If not clearly recognizable, omit the field.",
  false
)

Verwendung in einer strukturierten Antwort

AIStructuredOutputConfig analysisConfig = AIUtils.createStructuredConfig()

AIUtils.addBoolean(
  analysisConfig,
  "urgent",
  true,
  "Whether the request is to be classified as urgent"
)

Map<String, Object> systemVars = [:]
Map<String, Object> userVars = ["text": "Please get back to me today. This is very urgent."]

IAIResult result = AIUtils.executePrompt("AnalyseCheck", analysisConfig, 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)
}