Auto Light Dark
Auto Light Dark
German English

addStringList

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

Code

AIStructuredOutputConfig addStringList(AIStructuredOutputConfig config, String key, boolean required, String description)
AIStructuredOutputConfig addStringList(AIStructuredOutputConfig config, String key, boolean required, String description, List<String> defaultValue)

Beschreibung

Fügt einer AIStructuredOutputConfig ein Listenfeld mit String-Werten hinzu.

Mit dieser Methode definieren Sie ein Feld für eine Liste von Zeichenketten innerhalb einer strukturierten KI-Antwort. Dabei legen Sie den Feldnamen, die fachliche Beschreibung und fest, ob die Liste 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. "tags".

  • required (boolean) - Legt fest, ob die Liste erforderlich ist.

    • true: Die Liste ist erforderlich.

    • false: Die KI darf die gesamte Liste weglassen.

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

  • defaultValue (List<String>) - optional Standardwert vom Typ List<String>, 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-Listenfeld definieren

AIStructuredOutputConfig config = AIUtils.createStructuredConfig()

AIUtils.addStringList(
  config,
  "tags",
  false,
  "Relevant classification features"
)

Optionales Listenfeld mit Standardwert

AIStructuredOutputConfig defaultConfig = AIUtils.createStructuredConfig()

AIUtils.addStringList(
  defaultConfig,
  "keywords",
  false,
  "Relevant keywords for the request. If no keywords are reliably recognizable, omit the field.",
  ["STANDARD"]
)

Verwendung in einer strukturierten Antwort

AIStructuredOutputConfig analysisConfig = AIUtils.createStructuredConfig()

AIUtils.addStringList(
  analysisConfig,
  "tags",
  true,
  "Relevant tags for classifying the request"
)

Map<String, Object> systemVars = [:]
Map<String, Object> userVars = ["text": "The customer reports an urgent problem with his hardware order."]

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

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