AI Chat Connector: Funktionen und Operationen

Der AI Chat Connector generiert KI-gestützte Antworten auf User Prompts.

Eigenschaften (Properties)

Operation

Bestimmt, welche Operation der Adapter durchführt

Mögliche Werte:

AI-Chat: Erzeugt KI-gestützte Antworten

Parameter

`Adapter`	Hauptklasse des Adapters (nicht verändern!) Mögliche Werte: de.softproject.integration.nativeadapter.NativeAdapter: Hauptklasse (Standard)
`Repository`	Das virtuelle Repository des Adapterprojekts. Mögliche Werte: `13a6386b-c321-4cfb-a259-835774a016c6`
`protocol`	Verwendetes AI Gateway-Protokoll (HTTP oder HTTPS). Mögliche Werte: `http`: HTTP (unverschlüsselt) verwenden (Standard) `https`: HTTPS (SSL-verschlüsselt) verwenden
`host`	Name des AI Gateway Hosts Mögliche Werte: Beliebige gültige Zeichenkette ohne Protokollangabe (z. B. `localhost`)
`port`	(optional) Nummer des AI Gateway Ports. Mögliche Werte: Beliebige ganze Zahl (z.B. `9999`)
`accessToken`	Wird benötigt, um eine Verbindung mit dem Keycloak herzustellen. Mögliche Werte: eindeutiger Access Token Der Access Token muss in Keycloak generiert werden.
`configKey`	Konfigurationsschlüssel für den Chat-Dienst. Der Schlüssel stammt aus einer im System vorhandenen gültigen X4AI-Konfiguration. Mögliche Werte: Beliebige Zeichenkette (String) Beispiele: `default` `general-knowledge`
`backstory`	Einleitende Kontext- oder Hintergrundinformationen für das LLM (Large Language Model), in der Regel eine Textdatei mit einer Anweisung im Ordner Resources. Beispiel für den Inhalt der Textdatei: `You are a helpful assistant and an X4 BPMS expert.` Mögliche Werte: `Pfad zu einer txt-Datei` Beispiel: `%USER_COLLECTION_ABSOLUTE%/X4AI-Example-ChatAdapter/Resources/backstory.txt`
`callbackLog`	Gibt während der Ausführung Informationen aus, wie z. B. den Tokenverbrauch.

Statuswerte

`1 (successful)`	Die Operation war erfolgreich.
`0`	Die Operation wurde erfolgreich ausgeführt, jedoch ohne Ergebnis.
`-1 (failed)`	Die Operation schlug aufgrund eines technischen Fehlers fehl.

Input

Der Adapter erwartet ein XML-Dokument mit folgender Struktur als Input.

XML

<x4ai_adapter>
  <prompt>your prompt</prompt>
</x4ai_adapter>

Folgende Elemente können im Input enthalten sein:

Element	Beschreibung
`x4ai_adapter`	Umschließendes Element für die Operation `AI-Chat`.
`prompt`	Prompt bzw. Fragestellung, also Anweisung an die KI

Output

Der Adapter erzeugt ein XML-Dokument als Output:

XML

<output>
  <response>AI Response</reponse>
  <callback_log>
    <total_tokens>30</total_tokens>
    <completion_tokens>13</completion_tokens>
    <prompt_tokens>17</prompt_tokens>
  </callback_log>
</output>

Folgendes Element ist im Output enthalten:

Element

Beschreibung

output

Enthält die Antwort, die durch den Adapter generiert wurde.

response

Antwort der KI

callback_log

Gibt den Tokenverbrauch während der Ausführung an.

Enthält die Elemente:

total_tokens: Gesamtanzahl der Tokens
completion_tokens: Anzahl der Tokens, die für Completions genutzt wurden
prompt_tokens: Anzahl der Tokens, die für Prompts genutzt wurden