AI Knowledge Base Chat Connector: Funktionen und Operationen

Der AI Knowledge Base Chat Connector generiert KI-gestützte Antworten auf User Prompts und nutzt für die Beantwortung zuvor hinterlegte Daten.

Eigenschaften (Properties)

Operation

Bestimmt, welche Operation der Adapter durchführt

Mögliche Werte:

AI-Knowledgebase-Chat: Generiert KI-gestützte Antworten auf User Prompts. Für die Beantwortung werden zuvor hinterlegte Daten genutzt.

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: `876cf76d-bcb1-463e-8433-68270d04c00e`
`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`
`datasets`	Liste von Datensätzen, die für die Beantwortung genutzt werden, kommaseparariert. Mögliche Werte: Beliebige Zeichenkette (String) zu existierenden Datensätzen im System, kommasepariert. Beispiel: `x4.documentation.ver7-3-1,x4.documentation.ver7-2-3`
`backstory`	Einleitende Kontext- oder Hintergrundinformationen für das LLM (Large Language Model). Hier gibt es zwei Möglichkeiten: eine Anweisung mit den Variablen `{knowledgebase}` und `{prompt}` im Parameter `backstory` Textdatei (`.txt`) mit einer Anweisung im Ordner Resources Mögliche Werte (Beispiele) für eine Anweisung mit den Variablen `{knowledgebase}` und `{prompt}`: `Complete the prompt based only on the following context: {knowledgebase} {prompt}` `You are a helpful assistant and an X4 BPMS expert: {knowledgebase} {prompt}` Mögliche Werte bei Verwendung einer Textdatei: `Pfad zu einer txt-Datei` Beispiel: `%USER_COLLECTION_ABSOLUTE%/X4AI-Example-ChatAdapter/Resources/backstory.txt` Beispiel für den Inhalt der Textdatei: `You are a helpful assistant and an X4 BPMS expert: {knowledgebase} {prompt}`
`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.

CODE

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

Folgende Elemente sind im Input enthalten:

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

Output

Der Adapter erzeugt ein XML-Dokument als Output:

CODE

<output>
  <original_prompt>customer’s question</original_prompt>
  <response>AI Response</response>
  <sources>
    <metadata>
      <id>uuid</id>
      <source>document name</source>
      <page>page</page>
      <source_url>url</source_url>
      <version>document version</version>
      <similarity_score>number between (0; 1)</similarity_score>
    </metadata>
    <metadata>
      <id></id>
      <source>X4BPMS_731_ESB_EN</source>
      <page>588</page>
      <source_url>http://download.softproject.de/x4bpms/7-3-1/X4BPMS_731_ESB_EN.pdf#page=588</source_url>
      <version>7.3.1</version>
      <similarity_score>0.16465315713444784</similarity_score>
    </metadata>
  </sources>
  <callback_log>
    <total_tokens>30</total_tokens>
    <completion_tokens>13</completion_tokens>
    <prompt_tokens>17</prompt_tokens>
    <total_cost_usd>0.01327</total_cost_usd>
    <successful_requests>1</successful_requests>
  </callback_log>
</output>

Folgende Elemente sind im Output enthalten:

Element	Beschreibung
`output`	Wurzelelement für die Operation `AI-Semantic-Search`.
`original_prompt`	Ursprüngliche Frage an die KI
`response`	Anwort der KI
`sources`	Umschließendes Element für das Element `metadata`.
`metadata`	Metadaten des Dokuments mit den Elementen: `id`: ID des Dokuments `source`: eindeutiger Name (`sourceKey`) des Dokuments `page`: Seite des Dokuments `source_url`: URL des Dokuments `version`: Version des Dokuments (Beispiel: 7.3.1; 7.4.0) `similarity_score`: Ähnlichkeit der Antwort mit der gestellten Frage. Je kleiner der Wert, desto besser die Übereinstimmung mit der Frage.
`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 `total_cost_usd`: Gesamtkosten der Anfrage in USD `successful_requests`: Anzahl der erfolgreich durchgeführten Anfragen