.. -*- fill-column: 78; -*- .. include:: general.txt .. _ai_assistants: ################################### KI Unterstützung ################################### Der |DKS| kann ab Version 1.10.1 KI-gestützte Funktionen zur Textverbesserung bereitstellen, die von externen KI-Systemen erbracht werden. Der |DKS| unterstützt dabei beliebige Anbieter von KI-Dienstleistungen (|TXAen|), soweit deren APIs mit dem de-facto-Standard des ChatGPT APIs des Anbieters OpenAI kompatibel sind. Für jeden |TXA| können beliebig viele Aktionen hinterlegt werden, die über das API des |DKSs| verfügbar sind. Diese Aktionen operieren auf einem übergebenen Eingabetext, den sie zusammen mit den für die Aktion hinterlegten AI-Anweisung (Prompts) an das API des |TXAen| übertragen. Als Ergebnis der Aktion wird das vom |TXAen| erhaltene Resultat zurückgeliefert. Auf welche Weise diese Funktionen durch den Client aufgerufen werden, hängt von der Implementierung auf der Client-Seite ab. Typischerweise selektiert ein Anwender einen Text oder einen Textbereich und wählt über ein Menü oder eine Schaltfläche die für diesen Text auszuführende Aktion aus. Das Resultat der Aktion wird dem Anwender in geeigneter Weise präsentiert, wobei es dem Anwender obliegt, das gelieferte Ergebnis nach seinen Vorstellungen weiterzuverwenden, z. B. den selektierten Text durch das Resultat zu ersetzen, das Ergebnis zum bestehenden Text hinzuzufügen oder den Text gemäß der Informationen des Resultats anzupassen. .. Bei Aufruf dieser API-Funktionen wir dem |DKS| Nutzer des |DKSs|, die diese Funktionalität verwenden möchten, müssen über eigene Accounts bei den KI-Anbietern verfügen und ihre Zugangs- und Abrechnungsdaten bei der Konfiguration der |TXAen| auf dem |DKS| hinterlegen. Der |DKS| wird mit einer Reihe von Beispielaktionen ausgeliefert, die als Vorlage für eigene Aktionen des Kunden verwendet werden können. .. note:: Wir weisen darauf hin, dass die Beispielaktionen in erster Linie zur Illustration dienen. Sie können beliebig verändert, gelöscht oder erweitert werden, um Ihren Bedürfnissen zu entsprechen. ****************************** Text-Assistenten verwalten ****************************** Über :menuselection:`Text-Assistent --> Text-Assistenten-Liste` erhalten Sie eine Liste aller definierten Text-Assistenten. Die einzelnen Spalten enthalten folgende Informationen: * In der Spalte :guilabel:`Name` findet sich der Name des |TXAen|. Durch einen Klick auf den Namen des |TXAen| können Sie die Aktionen für diesen Assistenten anzeigen und bearbeiten. * In der Spalte :guilabel:`Beschreibung` steht eine Kurzbeschreibung des Assistenten. * Die Spalte :guilabel:`API-Endpunkt` enthält den für diesen Assistenten konfigurierten API-Endpunkt. * In der Spalte :guilabel:`Standardmodell` ist das für den Assistenten definierte Standardmodell angegeben. * Die Spalte :guilabel:`Verbrauchte Tokens` gibt an, welcher Anteil des konfigurierten Kontingents bereits verbraucht wurde. Wenn für den |TXAen| kein Token-Limit festgelegt wurde, enthält diese Spalte die Angabe `Kein Limit`. * In :guilabel:`Aktionen` finden sich Schaltflächen zum Editieren der Einstellungen des Assistenten (:guilabel:`Einstellungen`) und zum Löschen des Assistenten (:guilabel:`Diesen Text-Assistenten löschen`). .. _edit-txa-settings: |TXAen| bearbeiten --------------------------- Die Einstellungen für vorhandene |TXAen| können durch Klicken auf die entsprechende Schaltfläche in der Liste der Assistenten bearbeitet werden. * Die Checkbox :guilabel:`Aktiviert` dient dazu, den Assistenten zu aktivieren oder zu deaktivieren. Durch das Deaktivieren des Assistenten werden alle dem Assistenten zugeordneten Aktionen blockiert, auch wenn diese individuell aktiviert sind. * Das Feld :guilabel:`Id` enthält eine eindeutige interne Bezeichnung des Assistenten, die beim Anlegen des Assistenten vergeben wurd und nicht nachträglich geändert werden kann. * Im Feld :guilabel:`Name` steht der kurze Name des Assistenten, der in der Anzeige verwendet wird. * Das Feld :guilabel:`Beschreibung` erlaubt es, weitere Informationen zum Assistenten zu hinterlegen. * In :guilabel:`API-Schlüssel` steht der zur Autorisierung beim Anbieter verwendete API Key. * Ihre Organisationskennung bei diesem Anbieter steht im Feld :guilabel:`API Organisation`. * Der API-Endpunkt wird im Feld :guilabel:`API-Endpunkt` angegeben. * Das zu verwendende Modell kann aus der Liste der möglichen Werte für das Feld :guilabel:`Default model` ausgewählt werden. * Die Anzahl der bereits verbrauchten Tokens wird im Feld :guilabel:`Used Tokens` angezeigt. * Mit der Schaltfläche :guilabel:`= 0` lässt sich dieser Wert auf 0 zurücksetzen. * Der Zeitpunkt, zu dem die Anzahl der verbrauchten Tokens zuletzt zurückgesetzt wurde, wird in :guilabel:`Last used tokens reset` angezeigt. * Im Feld :guilabel:`Daily Limit` kann ein tägliches Token Limit eingerichtet werden, das nicht überschritten werden kann. Ein negativer Wert setzt die Limitierung außer Kraft. Nach dem Bearbeiten der Einstellungen klicken Sie auf die Schaltfläche :guilabel:`Speichern`, um die eingegebenen Informationen zu speichern. OpenAI / ChatGPT aktivieren --------------------------------------- Im Auslieferungszustand des |DKSs| ist bereits der Anbieter ``OpenAI`` angelegt und teilweise vorkonfiguriert. .. image:: images/DKS_TextAssistant.png :class: with-border Falls Sie diesen Anbieter verwenden möchten, benötigen Sie Zugangsdaten für das OpenAI API in Form eines API Keys und Organisationskennung; beides erhalten Sie nach der Einrichtung eines Accounts bei OpenAI. Zur Aktivierung des Anbieters klicken Sie auf das Zahnradsymbol in der rechten Tabellenspalte, woraufhin Sie folgende Übersicht erhalten: .. image:: images/DKS_OpenAiAssistantEdit.png :class: with-border Bitte tragen Sie dort Ihren API-Key (im Feld :guilabel:`API Key`) und Ihre Organisationskennung (Im Feld :guilabel:`API org`) ein. Nach dem Speichern dieser Informationen kann der |DKS| ermitteln, welche Modelle Ihnen für die Durchführung von Anfragen zur Verfügung stehen und Sie können eine Option aus Liste der möglichen Werte für das Feld :guilabel:`Standardmodell` auswählen. Nach dem Aktivieren der Checkbox :guilabel:`Aktiviert` steht Ihnen der Anbieter `OpenAI` zur Verfügung. Einen neuen Anbieter einrichten ------------------------------- Klicken Sie die Schaltfläche :guilabel:`Neuer Text-Assistent` über der Liste der bestehenden Assistenten, um einen neuen Text-Assistenten anzulegen. Auf der nun angezeigten Seite müssen Sie eine eindeutige Id für den neuen |TXAen| vergeben, die nachträglich nicht mehr geändert werden kann. .. note:: Eine Id darf nur Kleinbuchstaben, Zahlen oder den Unterstrich enthalten und muss mit einem Buchstaben beginnen. Alle weiteren Einstellungen entsprechen der Beschreibung in :ref:`Text-Assistenten bearbeiten ` .. note:: Die Liste der möglichen Standardmodelle steht erst nach der Eingabe (und dem Speichern) des API-Keys und Organisationskennung zur Verfügung, da die Liste beim Anbieter (mittels API-Key und Organisationskennung) abgefragt werden muss. ****************************** Assistenten-Aktionen verwalten ****************************** Für jeden |TXAen| kann eine beliebige Anzahl von Aktionen definiert werden, die mit diesem |TXA| ausgeführt werden können. Ein Klick auf den Namen des |TXAen| in der Liste der Assistenten führt zur Anzeige der Liste der Aktionen für diesen Assistenten. .. image:: images/DKS_OpenAiAssistantActions.png :class: with-border Die einzelnen Spalten enthalten folgende Informationen: * In der Spalte :guilabel:`Name` findet sich der Name der Assistenten-Aktion. Durch einen Klick auf den Namen können Sie die Einstellungen für diese Aktion anzeigen und bearbeiten. * In der Spalte :guilabel:`Beschreibung` steht eine Kurzbeschreibung der Assistenten-Aktion. * In :guilabel:`Aktionen` finden sich dir Schaltfläche zum Löschen der Assistenten-Aktion (:guilabel:`Diese Aktion löschen`). .. _edit-txa-actions: Assistenten-Aktionen bearbeiten ------------------------------- Die Einstellungen für eine vorhandene Aktion können durch Klicken auf deren Namen in der Liste der Aktionen bearbeitet werden. .. image:: images/DKS_OpenAiAssistantActionEdit.png :class: with-border * Die Checkbox :guilabel:`Aktiviert` dient dazu, die Aktion zu (de)aktivieren. Damit eine Aktion zur Verfügung steht, müssen sowohl der Assistent wie auch die Aktion selbst aktiviert sein. * Das Feld :guilabel:`Id` enthält eine eindeutige interne Bezeichnung der Aktion, die beim Anlegen der Aktion vergeben wurde und nicht nachträglich geändert werden kann. * Im Feld :guilabel:`Name` steht der kurze Name der Aktion, der in der Anzeige verwendet wird. * Das Feld :guilabel:`System Instruction` enthält die System-Anweisung für den Assistenten, die beschreibt, welche Operationen mit einem übergebenen Text ausgeführt werden sollen. Sie wird beim Aufruf der externen KI mit der Rolle `developer` übertragen. * In :guilabel:`Assistant Instruction` können weitere Instruktion stehen, die mit der Rolle `assistant` übertragen werden. Nach dem Bearbeiten der Einstellungen klicken Sie auf die Schaltfläche :guilabel:`Speichern`, um die eingegebenen Informationen zu speichern. Eine neue Aktion einrichten ------------------------------- Klicken Sie die Schaltfläche :guilabel:`Neue Aktion` über der Liste der bestehenden Assistenten, um eine neuen Aktion anzulegen. Auf der nun angezeigten Seite müssen Sie eine eindeutige Id für die neue Aktion vergeben, die nachträglich nicht mehr geändert werden kann. .. note:: Eine Id darf nur Kleinbuchstaben, Zahlen oder den Unterstrich enthalten und muss mit einem Buchstaben beginnen. Alle weiteren Einstellungen entsprechen der Beschreibung in :ref:`Assistenten-Aktionen bearbeiten ` ******************************* Assistenten und Aktionen testen ******************************* Mit :menuselection:`Text-Assistent --> Demo` können Sie einzelne Aktionen testen und verfolgen, welche Daten an die externe KI übergeben werden und welche Ergebnisse dafür geliefert werden.