AI Assistant for QPR ProcessAnalyzer: Difference between revisions

Latest revision as of 10:39, 20 May 2024

Take AI Assistant Into Use

To enable AI Assistant:

Create an OpenAI account and an OpenAI API key.
In the PA_CONFIGURATION table in QPR ProcessAnalyzer database, define your OpenAI API key in the OpenAIAPIKey field and which Large Language Model to use in the OpenAIDefaultModelName field.

AI Assistant Overview

The chat pane is the user interface for the AI Assistant. All users can use the AI Assistant, but they must have access to a dashboard to open it. Discussions are stored permanently and they are dashboard and user specific, meaning the chat history in a dashboard is accessible to the user even after the user logs out and logs back in. When a dashboard is removed, the related AI Assistant chat discussion is also removed. Permissions for the AI Assistant chat discussions are identical to those for the related dashboard, meaning if dashboard access is revoked, access to the chat discussion is also revoked.

Opening the AI Assistant

The AI Assistant can be opened by clicking the dots menu icon in the top right corner of the QPR ProcessAnalyzer view and selecting AI Assistant from the menu. This will open the AI Assistant chat pane to the right side of the view.

Closing the AI Assistant

The AI Assistant can be closed by clicking the X icon in the top right corner of the AI Assistant chat pane.

Deleting Chat Contents

Chat contents can be deleted by hovering over a sent chat message and clicking the trashcan icon. All chat messages starting from that message are then deleted.

Regenerating the AI Assistant's Message

To regenerate a message from the AI Assistant, hover over the message and click the round arrow icon.

Available AI Functionality

The AI Assistant provides the following types of help to users:

Answering general questions about the analyzed process
Creating filter rules and root causes criteria
Explaining the chart that is currently selected
General knowledge about process mining

What Data Is Sent to OpenAI

The AI Assistant is based on the generative AI and large language models (LLM). When the AI Assistant is used following data is sent to the OpenAI service:

Model name
Project name
Case attribute names
Event attribute name
Event type names
Model description

When asked to explain a chart, the following information is sent:

Chart settings
Visualized data

@@ Line 1: / Line 1: @@
-== Take AI Assistant into use ==
+== Take AI Assistant Into Use ==
-* Create OpenAi account
+To enable AI Assistant:
-* Configure OpenAI API key
+# Create an OpenAI account and an OpenAI API key.
-* Set the LLM to use
+# In the PA_CONFIGURATION table in QPR ProcessAnalyzer database, define your OpenAI API key in the [[PA_Configuration_database_table#OpenAIAPIKey|OpenAIAPIKey]] field and which Large Language Model to use in the [[PA_Configuration_database_table#OpenAIDefaultModelName|OpenAIDefaultModelName]] field.
-==Available features==
+== AI Assistant Overview ==
-* Tell about the analyzed process
+The chat pane is the user interface for the AI Assistant. All users can use the AI Assistant, but they must have access to a dashboard to open it. Discussions are stored permanently and they are dashboard and user specific, meaning the chat history in a dashboard is accessible to the user even after the user logs out and logs back in. When a dashboard is removed, the related AI Assistant chat discussion is also removed. Permissions for the AI Assistant chat discussions are identical to those for the related dashboard, meaning if dashboard access is revoked, access to the chat discussion is also revoked.
-* Explain charts
-* Create filters and root causes criteria
+=== Opening the AI Assistant ===
+The AI Assistant can be opened by clicking the '''dots menu icon''' in the '''top right corner''' of the QPR ProcessAnalyzer view and selecting '''AI Assistant''' from the menu. This will open the AI Assistant chat pane to the right side of the view.
+=== Closing the AI Assistant ===
+The AI Assistant can be closed by clicking the '''X icon''' in the top right corner of the AI Assistant chat pane.
+=== Deleting Chat Contents ===
+Chat contents can be deleted by hovering over a sent chat message and clicking the trashcan icon. All chat messages starting from that message are then deleted.
+=== Regenerating the AI Assistant's Message ===
+To regenerate a message from the AI Assistant, hover over the message and click the round arrow icon.
+==Available AI Functionality==
+The AI Assistant provides the following types of help to users:
+* Answering general questions about the analyzed process
+* Creating filter rules and root causes criteria
+* Explaining the chart that is currently selected
 * General knowledge about process mining
-==What data is sent to OpenAI==
+==What Data Is Sent to OpenAI==
 The AI Assistant is based on the generative AI and large language models (LLM). When the AI Assistant is used following data is sent to the OpenAI service:
 * Model name