Enhance Document and artifacts (#13)

* Enhance images for README (#12)

* - Enhance images for README

* - Added ai assistant to list of download items in Market

---------

Co-authored-by: Tung Le <[email protected]>

ai-assistant-product/README.md

@@ -3,12 +3,12 @@
 The AI Assistant is a powerful tool designed to streamline your daily work within the portal. Acting as your personal assistant, it provides seamless support for a wide range of tasks, from navigating documentation to launching processes and managing tasks and cases. With the AI Assistant at your side, you can work more efficiently and effectively, freeing up valuable time for what truly matters.
 Engage in a more interactive and intuitive workflow by conversing with the assistant about your processes instead of merely executing them. This dynamic interaction enhances your experience, allowing you to explore options and gain insights as you work. With multilingual capabilities, the AI Assistant communicates effortlessly in English, German, Spanish, and more, ensuring you receive support in your preferred language.
 
-<img src="./doc/img/chat-dashboard.png" width="50%" alt="Chat Dashboard">
+![Chat Dashboad](doc/img/chat-dashboard.png)
 
 Beyond providing immediate assistance, the AI Assistant empowers you to create and manage custom models and assistants tailored to your unique needs. With the management overview feature, designing, configuring, and organizing these models is a breeze. You can craft personalized assistants, assign specific behaviors, or leverage predefined templates to guide their actions. This level of customization ensures that your AI Assistant aligns perfectly with your preferences and work style.
 Embrace the future of work with the AI Assistant, your personalized companion for enhanced productivity and seamless task management.
 
-<img src="./doc/img/assistant-management.png" width="50%" alt="Assistant Management">
+![Assistant Management](doc/img/assistant-management.png)
 
 **List of capabilities:**
 
@@ -97,19 +97,19 @@ The AI Management screen serves as a central hub for configuring and managing al
 
 - [Manage AI functions](#manage-ai-functions): control and organize various AI functions, defining the actions your AI can perform and how it interacts with users to provide accurate and efficient results
 
-<img src="./doc/img/ai-functions-management.png" width="50%" alt="AI Functions management">
+![AI Functions management](doc/img/ai-functions-management.png)
 
 ##### Manage AI Assistants
 
 This section lists all the AI assistants that the logged-in user has permission to access, along with their names, avatars, and short descriptions.
 
-<img src="./doc/img/assistant-management.png" width="50%" alt="Assistant management">
+![Assistant management](doc/img/assistant-management.png)
 
 You can create a new AI assistant by clicking the **Add new assistant** button, or modify an existing AI assistant's details by selecting the corresponding assistant from the list.
 
 Once you've selected an AI assistant, its details page will be displayed.
 
-<img src="./doc/img/assistant-details.png" width="50%" alt="AI assistant details">
+![AI assistant details](doc/img/assistant-details.png)
 
 There are some settings you can change:
 
@@ -135,21 +135,21 @@ You can quickly configure all the necessary settings for an AI assistant by usin
 
 2. The **Assistant Templates** dialog will appear. Select a template from the list by clicking it.
 
-    <img src="./doc/img/assistant-templates-dialog.png" width="50%" alt="Assistant Templates">
+    ![Assistant Templates](doc/img/assistant-templates-dialog.png)
 
 3. The template's settings will be applied to your AI assistant. You can then modify them to suit your needs.
 
 ###### Manage AI functions
 
 On the right side is a table listing the AI functions available to the AI assistant. You can view general information about each function, such as its name, type, description, permissions, and usage.
 
-<img src="./doc/img/assistant-details-functions.png" width="50%" alt="Functions">
+![Functions](doc/img/assistant-details-functions.png)
 
 You can prevent the AI assistant from using a function by removing it from this table.
 
 When you click the **Add** button, the **Add function** dialog will appear. To add a function, click on the row of the function you want to select, then click **Add** to add the selected functions.
 
-<img src="./doc/img/assistant-details-add-functions.png" width="50%" alt="Add function dialog">
+![Add function dialog](doc/img/assistant-details-add-functions.png)
 
 Afterward, the selected functions will appear in the **Functions** table.
 
@@ -163,15 +163,15 @@ As time goes by, an AI assistant may become obsoleted and you may want to delete
 
 A confim dialog will appear, you can delete the AI assistant completely by clicking the **Remove** button on that dialog.
 
-<img src="./doc/img/assistant-details-delete.png" width="50%" alt="Delete AI Assistant dialog">
+![Delete AI Assistant dialog](doc/img/assistant-details-delete.png)
 
 But please aware that, all conversations between the AI assistant and Ivy users will be deleted.
 
 ##### Configure AI Models
 
 AI Models is a list of model options which a AI assistant can use to perform its functionalities.
 
-<img src="./doc/img/models-management.png" width="50%" alt="Model management">
+![Model management](doc/img/models-management.png)
 
 The AI Assistant need 2 AI models to works: a GPT model, and a text embedding model. Therefore, AI Assistant offers 2 tailored options that tested and ready to use:
 
@@ -187,7 +187,7 @@ When you clicking on a model item in the AI Models list, you will be redirected
 
 Furthermore, you can test to connection to OpenAI platform by clicking the button **Test Connection**. If something went wrong, we will show the details error
 
-<img src="./doc/img/ai-model-test-connection.png" width="50%" alt="Test connection">
+![Test connection](doc/img/ai-model-test-connection.png)
 
 Once you click the **Save** button, all the settings, including the API Key will be saved as Axon Ivy variables, and you will be redirected to the [AI Management](#ai-management).
 
@@ -199,15 +199,15 @@ All AI functions that the logged in user can access are listed in the **AI Funct
 - `Ivy Flow` function: disabled when system detected that there could be an error when running the flow. For example: a required Ivy callable process could not be found
 - `Knowkedge Base` function: disabled when the system cannot find the corresponding vector store
 
-<img src="./doc/img/all-ai-functions-list.png" width="50%" alt="AI Function list">
+![AI Function list](doc/img/all-ai-functions-list.png)
 
 You can also see all non-startable AI functions by toggling the option **Show non-startable AI functions**.
 
 ###### Delete AI function
 
 You can delete the AI function completely from the AI Assistant by clicking the **Delete** button (has the trash bin icon) placed in the last column of the corresponding row of that AI function. A confirmation dialog will show as below
 
-<img src="./doc/img/delete-ai-function.png" width="30%" alt="Delete AI Function">
+![Delete AI Function](doc/img/delete-ai-function.png)
 
 Please read the confirmation carefully before delete the AI function. The AI function could be using by some AI assitants, and once you delete it, the AI assistants cannot work on the functions any more, or worser, some errors may arise.
 
@@ -216,7 +216,7 @@ Please read the confirmation carefully before delete the AI function. The AI fun
 AI Assistant allows admin users (with has role `AXONIVY_PORTAL_ADMIN`) to create knowledge bases for use by the AI function of type `Knowledge Base`.
 Simply start the process `Create knowledge base for AI Assistant` and follow the instructions there, you can create create knowledge bases which could be use by `Knowledge Base` functions.
 
-<img src="./doc/img/create-knowledge-page-ui.png" width="50%" alt="create Knowledge Base section">
+![Create Knowledge Base section](doc/img/create-knowledge-page-ui.png)
 
 Currently, you can create knowledge base for 2 types: Portal Support and Others.
 
@@ -226,7 +226,7 @@ The AI Assistant includes a built-in tool called `Portal support` which can answ
 
 To generate the knowledge base for this function, please visit the [Portal download page](https://market.axonivy.com/portal) on the Axon Ivy Market and download the latest document, as shown in the image below.
 
-<img src="./doc/img/download-portal-doc.png" width="50%" alt="Download Portal Document">
+![Download Portal Document](doc/img/download-portal-doc.png)
 
 Then, just simply upload the downloaded file as instructed in [Create knowledge bases](#create-knowledge-bases) above.
 

ai-assistant-product/README_DE.md

@@ -6,11 +6,11 @@ Als Ihr persönlicher Assistent bietet er nahtlose Unterstützung bei einer Viel
 
 Treten Sie in einen interaktiveren und intuitiveren Workflow ein, indem Sie mit dem Assistenten über Ihre Prozesse sprechen, anstatt sie lediglich auszuführen. Diese dynamische Interaktion verbessert Ihr Erlebnis, sodass Sie Optionen erkunden und Einblicke gewinnen können, während Sie arbeiten. Mit mehrsprachigen Fähigkeiten kommuniziert der KI-Assistent mühelos in Englisch, Deutsch, Spanisch und mehr, sodass Sie Unterstützung in Ihrer bevorzugten Sprache erhalten.
 
-<img src="./doc/img/chat-dashboard.png" width="50%" alt="Chat-Dashboard">
+![Chat-Dashboard](doc/img/chat-dashboard.png)
 
 Über die unmittelbare Unterstützung hinaus ermöglicht Ihnen der KI-Assistent, benutzerdefinierte Modelle und Assistenten zu erstellen und zu verwalten, die auf Ihre individuellen Bedürfnisse zugeschnitten sind. Mit der Verwaltungsübersicht ist es ein Kinderspiel, diese Modelle zu entwerfen, zu konfigurieren und zu organisieren. Sie können personalisierte Assistenten erstellen, spezifische Verhaltensweisen zuweisen oder vordefinierte Vorlagen verwenden, um deren Aktionen zu steuern. Dieses Maß an Anpassung stellt sicher, dass Ihr KI-Assistent perfekt auf Ihre Vorlieben und Arbeitsweise abgestimmt ist.
 
-<img src="./doc/img/assistant-management.png" width="50%" alt="Assistentenverwaltung">
+![Assistentenverwaltung](doc/img/assistant-management.png)
 
 **Liste der Funktionen**
 
@@ -101,19 +101,19 @@ Von hier aus kannst du:
 
 - [KI-Funktionen verwalten](#ki-funktionen-verwalten):Kontrolliere und organisiere die verschiedenen KI-Funktionen, definiere die Aktionen, die die KI ausführen kann, und lege fest, wie sie mit Benutzern interagiert, um präzise und effiziente Ergebnisse zu liefern.
 
-<img src="./doc/img/ai-functions-management.png" width="50%" alt="Verwaltung von KI-Funktionen">
+![Verwaltung von KI-Funktionen](doc/img/ai-functions-management.png)
 
 ##### KI-Assistenten verwalten
 
 In diesem Abschnitt werden alle KI-Assistenten aufgelistet, auf die der eingeloggte Benutzer Zugriff hat, zusammen mit ihren Namen, Avataren und kurzen Beschreibungen.
 
-<img src="./doc/img/assistant-management.png" width="50%" alt="Assistentenverwaltung">
+![Assistentenverwaltung](doc/img/assistant-management.png)
 
 Du kannst einen neuen KI-Assistenten erstellen, indem du auf die Schaltfläche **Neuen Assistenten hinzufügen** klickst, oder die Details eines vorhandenen KI-Assistenten ändern, indem du den entsprechenden Assistenten aus der Liste auswählst.
 
 Sobald du einen KI-Assistenten ausgewählt hast, wird dessen Detailseite angezeigt.
 
-<img src="./doc/img/assistant-details.png" width="50%" alt="Details zum KI-Assistenten">
+![Details zum KI-Assistenten](doc/img/assistant-details.png)
 
 Für den KI-Assistenten können folgende Werte und Einstellungen konfiguriert werden:
 
@@ -138,21 +138,21 @@ Du kannst schnell alle erforderlichen Einstellungen für einen KI-Assistenten mi
 1. Klicke im Detailbildschirm des KI-Assistenten oben rechts auf die Schaltfläche Vorlage verwenden.
 2. Der Dialog Assistentenvorlagen wird angezeigt. Wähle eine Vorlage aus der Liste aus. 
 
-    <img src="./doc/img/assistant-templates-dialog.png" width="50%" alt="Assistentenvorlagen">
+    ![Assistentenvorlagen](doc/img/assistant-templates-dialog.png)
 
 3. Die Einstellungen der Vorlage werden auf den KI-Assistenten angewendet. Diese können anschließend nach Bedarf angepasst werden.
 
 ###### KI-Funktionen verwalten
 
 Auf der rechten Seite befindet sich eine Tabelle, die die dem KI-Assistenten verfügbaren KI-Funktionen auflistet. Du kannst allgemeine Informationen zu jeder Funktion einsehen, wie Name, Typ, Beschreibung, Berechtigungen und Nutzung.
 
-<img src="./doc/img/assistant-details-functions.png" width="50%" alt="Funktionen">
+![Funktionen](doc/img/assistant-details-functions.png)
 
 Du kannst verhindern, dass der KI-Assistent eine Funktion verwendet, indem du diese aus der Tabelle entfernst.
 
 Wenn du auf die Schaltfläche **Hinzufügen** klickst, erscheint der Dialog **Funktion hinzufügen**. Um eine Funktion hinzuzufügen, klicke auf die Zeile der gewünschten Funktion und dann auf **Hinzufügen**, um die ausgewählten Funktionen hinzuzufügen.
 
-<img src="./doc/img/assistant-details-add-functions.png" width="50%" alt="Dialog zum Hinzufügen von Funktionen">
+![Dialog zum Hinzufügen von Funktionen](doc/img/assistant-details-add-functions.png)
 
 Anschließend erscheinen die ausgewählten Funktionen in der **Funktionen** Tabelle.
 
@@ -166,15 +166,15 @@ Mit der Zeit kann ein KI-Assistent veraltet sein und du möchtest ihn möglicher
 
 Ein **Bestätigungsdialog** wird angezeigt, in dem du den KI-Assistenten vollständig löschen kannst. Klicke auf die Schaltfläche Entfernen, um den KI-Assistenten zu entfernen.
 
-<img src="./doc/img/assistant-details-delete.png" width="50%" alt="Dialog zum Löschen des KI-Assistenten">
+![Dialog zum Löschen des KI-Assistenten](doc/img/assistant-details-delete.png)
 
 Bitte beachte, dass dabei alle Gespräche zwischen dem KI-Assistenten und dem Ivy-Benutzern gelöscht werden.
 
 ##### KI-Modelle konfigurieren
 
 **KI-Modelle** ist eine Liste von Modelloptionen, die ein KI-Assistent verwenden kann, um seine Funktionen auszuführen.
 
-<img src="./doc/img/models-management.png" width="50%" alt="Modellverwaltung">
+![Modellverwaltung](doc/img/models-management.png)
 
 Der KI-Assistent benötigt zwei KI-Modelle, um zu funktionieren: ein GPT-Modell und ein Text-Embedding-Modell. Daher bietet der KI-Assistent zwei maßgeschneiderte, getestete und einsatzbereite Optionen an:
 
@@ -190,7 +190,7 @@ Wenn du auf ein Modell in der Liste der KI-Modelle klickst, wirst du zur Details
 
 Darüber hinaus kannst du die Verbindung zur OpenAI-Plattform testen, indem du auf die Schaltfläche **Verbindung testen** klickst. Wenn ein Fehler auftritt, werden die Details des Fehlers angezeigt.
 
-<img src="./doc/img/ai-model-test-connection.png" width="50%" alt="Verbindung testen">
+![Verbindung testen](doc/img/ai-model-test-connection.png)
 
 Sobald du auf die Schaltfläche **Speichern** klickst, werden alle Einstellungen, einschließlich des API-Keys, als Axon Ivy-Variablen gespeichert und du wirst zurück zum [KI-Management](#ki-management) weitergeleitet.
 
@@ -204,15 +204,15 @@ Es gibt einige Gründe, warum eine KI-Funktion nicht startbar ist:
 - `Ivy Flow` Funktion: deaktiviert, wenn das System feststellt, dass ein Fehler beim Ausführen des Flows auftreten könnte, z. B., wenn ein erforderlicher Ivy-Aufrufprozess nicht gefunden wurde.
 - `Wissensbasis` Funktion: deaktiviert, wenn das System den entsprechenden Vektorspeicher nicht finden kann.
 
-<img src="./doc/img/all-ai-functions-list.png" width="50%" alt="Liste der KI-Funktionen">
+![Liste der KI-Funktionen](doc/img/all-ai-functions-list.png)
 
 Du kannst auch alle nicht startbaren KI-Funktionen anzeigen, indem du die Option **Nicht startbare KI-Funktionen anzeigen** umschaltest.
 
 ###### KI-Funktion löschen
 
 Du kannst die KI-Funktion vollständig aus dem KI-Assistenten löschen, indem du auf die Schaltfläche Löschen (mit dem Mülleimer-Symbol) in der letzten Spalte der entsprechenden Zeile dieser KI-Funktion klickst. Ein Bestätigungsdialog wird wie unten angezeigt:
 
-<img src="./doc/img/delete-ai-function.png" width="30%" alt="KI-Funktion löschen">
+![KI-Funktion löschen](doc/img/delete-ai-function.png)
 
 Bitte lies die Bestätigung sorgfältig, bevor du die KI-Funktion löschst. Die KI-Funktion könnte von einigen KI-Assistenten verwendet werden und sobald du sie löschst, können die KI-Assistenten die Funktion nicht mehr ausführen oder es können Fehler auftreten.
 
@@ -222,7 +222,7 @@ Der **KI-Assistent** ermöglicht es **Administratorbenutzern** (mit der Rolle `A
 
 Starte einfach den Prozess **Wissensdatenbank für KI-Assistenten erstellen** und folge den Anweisungen dort, um eine neue Wissensdatenbanken zu erstellen, die von Funktionen des Typs Wissensdatenbank genutzt werden können.
 
-<img src="./doc/img/create-knowledge-page-ui.png" width="50%" alt="Wissensdatenbank erstellen UI">
+![Wissensdatenbank erstellen UI](doc/img/create-knowledge-page-ui.png)
 
 Derzeit kannst du Wissensdatenbanken für zwei Typen erstellen: `Portal-Unterstützung` und `Sonstiges`.
 
@@ -231,8 +231,8 @@ Derzeit kannst du Wissensdatenbanken für zwei Typen erstellen: `Portal-Unterst
 Der KI-Assistent enthält ein integriertes Tool namens `Portal support`, das Fragen zum Axon Ivy Portal beantworten kann.
 
 Um die Wissensdatenbank für diese Funktion zu erstellen, besuche bitte die [Portal-Downloadseite](https://market.axonivy.com/portal) auf dem Axon Ivy Market und lade das neueste Dokument herunter, wie im untenstehenden Bild gezeigt.
-
-<img src="./doc/img/download-portal-doc.png" width="30%" alt="Portal-Dokument herunterladen">
+  
+![Portal-Dokument herunterladen](doc/img/download-portal-doc.png)
 
 Anschließend lädst du die heruntergeladene Datei wie in  [Wissensdatenbanken erstellen](#wissensdatenbanken-erstellen) oben beschrieben hoch.
 
@@ -718,7 +718,7 @@ Das Ausgaberesultat des Ivy-Callable-Prozesses muss ein Objekt mit dem Namen res
 }
 ```
 
-[!IMPORTANT]
+> [!IMPORTANT]
 > Bitte beachte:
 > - Die Namen der Attribute müssen mit den Namen der Parameter des oben genannten Callable-Prozesses übereinstimmen.
 > - Das Attribut `signature` im JSON-Objekt ist die Signatur des Callable-Prozesses.

ai-assistant-product/product.json

@@ -5,6 +5,12 @@
       "id": "maven-import",
       "data": {
         "projects": [
+          {
+            "groupId": "com.axonivy.utils.aiassistant",
+            "artifactId": "ai-assistant",
+            "version": "${version}",
+            "type": "iar"
+          },
           {
             "groupId": "com.axonivy.utils.aiassistant",
             "artifactId": "ai-assistant-demo",