Auto Light Dark
Auto Light Dark
German English

addObjectList

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

Code

AIStructuredOutputConfig addObjectList(AIStructuredOutputConfig config, String key, boolean required, String description, AIStructuredOutputConfig elementConfig)

Beschreibung

Fügt einer AIStructuredOutputConfig ein Listenfeld hinzu, dessen Elemente Objekte sind.

Mit dieser Methode definieren Sie eine Liste von verschachtelten Objekten innerhalb einer strukturierten KI-Antwort. Dabei legen Sie den Feldnamen, die fachliche Beschreibung, ob die Liste erforderlich ist, sowie eine untergeordnete AIStructuredOutputConfig für die Struktur jedes Listenelements fest.

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

  • 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 Objektliste zu verdeutlichen.

  • elementConfig (AIStructuredOutputConfig) - Die untergeordnete AIStructuredOutputConfig, die die Felder jedes Objekts innerhalb der Liste definiert.

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

Objektliste definieren

AIStructuredOutputConfig itemConfig = AIUtils.createStructuredConfig()
AIUtils.addString(itemConfig, "name", true, "Name of the item")
AIUtils.addInt(itemConfig, "quantity", true, "Quantity of the item")

AIStructuredOutputConfig config = AIUtils.createStructuredConfig()
AIUtils.addObjectList(
  config,
  "items",
  true,
  "Invoice items",
  itemConfig
)

Optionale Objektliste definieren

AIStructuredOutputConfig scoreConfig = AIUtils.createStructuredConfig()
AIUtils.addString(scoreConfig, "key", true, "Rated classification key")
AIUtils.addInt(scoreConfig, "score", false, "Rating of the fit from 0 to 100", 0)

AIStructuredOutputConfig scoresConfig = AIUtils.createStructuredConfig()
AIUtils.addObjectList(
  scoresConfig,
  "scores",
  false,
  "List of rated classification keys. If none are recognizable, omit the field.",
  scoreConfig
)

Verwendung in einer strukturierten Antwort

AIStructuredOutputConfig orderItemConfig = AIUtils.createStructuredConfig()
AIUtils.addString(orderItemConfig, "name", true, "Name of the item")
AIUtils.addInt(orderItemConfig, "quantity", true, "Quantity of the item")

AIStructuredOutputConfig orderConfig = AIUtils.createStructuredConfig()
AIUtils.addObjectList(
  orderConfig,
  "items",
  true,
  "Items extracted from the text",
  orderItemConfig
)

Map<String, Object> systemVars = [:]
Map<String, Object> userVars = ["text": "2 monitors and 1 keyboard were ordered."]

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

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