AI Assistant for QPR ProcessAnalyzer: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
Line 8: Line 8:
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.
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 AI Assistant ===
=== Opening and closing AI Assistant ===
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.
When in a dashboard, AI Assistant can be opened by clicking the dots menu icon in the top right corner and selecting '''AI Assistant''' from the menu. This will open the AI Assistant chat pane to the right side of the dashboard. AI Assistant can be closed by clicking the X icon on in the header of the chat pane.


=== Closing AI Assistant ===
=== Closing AI Assistant ===

Revision as of 20:36, 22 May 2024

Take AI Assistant Into Use

To enable AI Assistant:

  1. Create an OpenAI account and an OpenAI API key.
  2. 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 and closing AI Assistant

When in a dashboard, AI Assistant can be opened by clicking the dots menu icon in the top right corner and selecting AI Assistant from the menu. This will open the AI Assistant chat pane to the right side of the dashboard. AI Assistant can be closed by clicking the X icon on in the header of the chat pane.

Closing 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

AI Assistant is based on the large language model (LLM) offered by OpenAI through their API. When the AI Assistant is used, the following data is sent to the OpenAI API as a prompt to the LLM:

  • Model name
  • Project name
  • Case attribute names
  • Event attribute names
  • Event type names
  • Model description field (available in Model Properties dialog)

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

  • Chart settings (shown in chart settings Advanced tab)
  • Data the chart is visualizing

Note: AI Assistant does not make separate queries to the model, but it only sees information that is shown to the user in the dashboard.

Terms of Usage

AI Assistant uses the OpenAI API for which the OpenAI's Business Terms are applied, available in https://openai.com/policies/business-terms. Note that OpenAI does not use the customer data to train LLM's. All data is encryption at rest (AES-256) and in transit (TLS 1.2+). More information about privacy for OpenAI's services: https://openai.com/enterprise-privacy/.