AI Knowledge Base Reader: Funktionen und Operationen

Der AI Knowledge Base Reader sucht nach Daten innerhalb eines Datensatzes mit vordefinierter Genauigkeit.

Eigenschaften (Properties)

Operation

Bestimmt, welche Operation der Adapter durchführt

Mögliche Werte:

AI-Semantic-Search: sucht nach Daten innerhalb eines Datensatzes mit vordefinierter Genauigkeit

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: `fa3618e7-9b53-4926-baf9-9e2daca5afd5`
`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`	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.
`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`
`chunkLimit`	(optional) Gibt die maximale Anzahl der übereinstimmenden Datenchunks an, die in die Ausgabe aufgenommen werden sollen. Wenn chunkLimit beispielsweise auf 5 gesetzt ist, kann die Ausgabe bis zu 5 übereinstimmende Chunks enthalten. Mögliche Werte: Ganze Zahl (integer) `4` (Standard)
`scoreThreshold`	(optional) Ein numerischer Wert zwischen 0 und 1 (mit Ausnahme von 0 und 1), der den maximalen Präzisionsgrad für die Auswahl übereinstimmender Chunks angibt. Niedrigere Werte entsprechen einer höheren Genauigkeit. Mögliche Werte: Dezimal-Zahl zwischen 0 und 1 `0,5` (Standard)

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

<?xml version="1.0" encoding="UTF-8"?>
<x4ai_adapter>
	<query>Tell me something about Don Quixote</query>
</x4ai_adapter>

Folgende Elemente sind im Input enthalten:

Element	Beschreibung
`x4ai_adapter`	Umschließendes Element für die Operation `AI-Semantic-Search`.
`query`	Satz, nach dem gesucht wird und für den im Output Metadaten ausgegeben werden.

Output

Der Adapter erzeugt ein XML-Dokument als Output:

CODE

<output>
  <documents>
    <document>
      <content>matching document chunk</content>
      <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>
    </document>
    <document>
      <content></content>
      <metadata>
        <id></id>
        <source></source>
        <page></page>
        <source_url></source_url>
        <version></version>
        <similarity_score></similarity_score>
       </metadata>
     </document>
   </documents>
</output>

Folgende Elemente sind im Output enthalten:

Element	Beschreibung
`output`	Umschließendes Element für die Operation `AI-Semantic-Search`.
`documents`	Umschließendes Element für das Element `document`.
`document`	Enthält Informationen zum konsultierten Dokument, zum Inhalt und den Metadaten.
`content`	Inhalt des Dokuments
`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 `similarity_score`: Ähnlichkeit der Antwort mit der gestellten Frage. Je kleiner der Wert, desto besser die Übereinstimmung mit der Frage.