Auto Light Dark
Auto Light Dark
German English

addString

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

Code

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 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. "customerName".

  • 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 (String) - optional Standardwert, 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 String-Feld definieren

AIStructuredOutputConfig config = AIUtils.createStructuredConfig()

AIUtils.addString(
  config,
  "customerName",
  true,
  "Full name of the customer"
)

Optionales Feld mit Standardwert

AIStructuredOutputConfig defaultConfig = AIUtils.createStructuredConfig()

AIUtils.addString(
  defaultConfig,
  "city",
  false,
  "City of the customer. If not clearly recognizable, omit the field.",
  "Unknown"
)

Verwendung in einer strukturierten Antwort

AIStructuredOutputConfig analysisConfig = AIUtils.createStructuredConfig()

AIUtils.addString(
  analysisConfig,
  "status",
  true,
  "Classification of the request"
)

Map<String, Object> systemVars = [:]
Map<String, Object> userVars = ["text": "I forgot my password."]

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