AI Assistant for QPR ProcessAnalyzer: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
AI Assistant is generative AI based chat dialog where users can use QPR ProcessAnalyzer by interacting with natural language. AI Assistant can for example explain charts and analyses, and create filters based on user description. AI Assistant can also answer question about the analyzed model, when training material is provided beforehand.


== Take AI Assistant into Use ==
== Take AI Assistant into Use ==
In QPR Cloud, the AI Assistant is disabled by default. To take the AI Assistant into use, please sent a request to customercare@qpr.com and the AI Assistant will be enabled for your environment.


In QPR Cloud, AI Assistant is not enabled by default. To take the AI Assistant into use, please sent a request to customercare@qpr.com and the AI Assistant will be enabled for your environment.
To enable the AI Assistant for customers using an on-premise system, the system administrator need to configure following:
 
# Create an OpenAI account in https://openai.com, and create an OpenAI API key. Note that the OpenAI API is a paid service and a credit card is needed for payments.
For customers using an on-premise system, to start using AI Assistant the system administrator need to configure the following:
# Create an OpenAI account in https://openai.com, and create an OpenAI API key.
# In the PA_CONFIGURATION table in QPR ProcessAnalyzer database, define your OpenAI API key in the [[PA_Configuration_database_table#OpenAIAPIKey|OpenAIAPIKey]] field.
# In the PA_CONFIGURATION table in QPR ProcessAnalyzer database, define your OpenAI API key in the [[PA_Configuration_database_table#OpenAIAPIKey|OpenAIAPIKey]] field.
# Optionally, define which large language model to use in the [[PA_Configuration_database_table#OpenAIDefaultModelName|OpenAIDefaultModelName]] field.
# Optionally, define which large language model to use in the [[PA_Configuration_database_table#OpenAIDefaultModelName|OpenAIDefaultModelName]] field.


You can also fine-tune the LLM, for it better suit to your use. For example, the LLM can be fine-tuned with background information regarding the analyzed process and operations. More information about fine-tuning OpenAI LLM's: https://platform.openai.com/docs/guides/fine-tuning.
You can also fine-tune the large language model, so that it better suits to your use. For example, the large language modelcan be fine-tuned with background information regarding the analyzed process and the broader business environment. More information about fine-tuning OpenAI large language models, please contact QPR or check out the OpenAI technical instructions: https://platform.openai.com/docs/guides/fine-tuning.


== AI Assistant Overview ==
==Available AI Functionality==
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 AI Assistant provides the following kind of assistance to users:
* AI Assistant can answer questions about the analyzed process. The answer are based on the information used to train the LLM. To train the LLM, you can provide information in the model's description field. Alternatively, for larger data sets, fine-tuning can be used (more above).
* AI Assistant can create filters and root causes criteria based on user description. For example, you can ask "Show cases with Delivery Created" (assuming that the model has Delivery Created events). You can also ask: "Filter cases where Company Code is Germany" (assuming that the model has the Company Code case attribute and it has a value Germany). You may ask: "Why there are Customer Return events?" and it will create a root causes criteria for the [[Root_Causes|Root Causes analysis]].
* AI Assistant can explain charts in the dashboard. To ask for an explanation, select the chart and click the '''Explain the selected chart''' button. The response contains a general description what this analysis or visualization is showing, and also it makes observations and findings regarding the the shown data. If you still want more information about the chart, please ask from the AI Assistant!


=== Opening and Closing AI Assistant ===
== Using 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.
The chat pane is used to interact with the AI Assistant which is available for all users in dashboards. Discussions are stored permanently, so the chat history in a dashboard is accessible to the user even after the user logs out and logs back in. There is a separate discussion in each dashboard. Discussions are also user specific, so users cannot see each other's discussions.
 
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 Chat Pane ===
When in a dashboard, the 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. The AI Assistant can be closed by clicking the X icon on in the header of the chat pane.


=== Deleting Messages ===
=== Deleting Messages ===
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. Also the entire chat discussion can be deleted by clicking the trashcan in the header of the chat pane.
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. Also the entire chat discussion can be deleted by clicking the trashcan in the header of the chat pane.


Keeping the chat history is useful when you want to continue a previous discussion because AI Assistants remembers the visible chat history when answering to subsequent messages. On the other hand, if you don't want to provide the chat history as a context when continuing the discussion, the chat can be deleted (either partly or entirely).
Keeping the chat history is useful when you want to continue a previous discussion because the AI Assistant remembers the visible chat history when answering to subsequent messages. On the other hand, if you don't want to provide the chat history as a context when continuing the discussion, the chat can be deleted (either partly or entirely).


=== Regenerating Answer ===
=== Regenerating Answer ===
To regenerate the last message from the AI Assistant, hover over the message and click the round arrow icon. You can use the regeneration to provide a different answer from the AI Assistant in case you are not satisfied with the previous answer. Alternatively, you can elaborate you request or question so that the AI Assistant is able to provide a better response.
To regenerate the last message from the AI Assistant, hover over the message and click the round arrow icon. You can use the regeneration to provide a different answer from the AI Assistant in case you are not satisfied with the previous answer. Alternatively, you can elaborate you request or question so that the AI Assistant is able to provide a better response.
==Available AI Functionality==
The AI Assistant provides the following kind of assistance to users:
* AI Assistant can answer questions about the analyzed process. The answer are based on the information that is trained to the LLM. There are following ways to train the LLM: provide information as prompt in the discussion or fine-tuning.
* AI Assistant can create filters and root causes criteria based on user description. For example, you can ask "Show cases that have Delivery Created." (assuming that the model has Delivery Created events). You can also ask: "Filter cases where company code is Germany" (assuming that the model has Company Code case attribute and it has value Germany).
* AI Assistant can explain chart in the dashboard. To ask for an explanation, select the chart and click the '''Explain the selected chart''' button. The response has a general explanation what this analysis or visualization is showing, and also it makes finding and observations regarding the the shown data.


==What Data Is Sent to OpenAI==
==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:
AI Assistant is based on the large language models (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
* Model and project name
* Project name
* Case and event attribute names
* Case attribute names
* Event attribute names
* Event type names
* Event type names
* Model description field (available in [[QPR_ProcessAnalyzer_Project_Workspace#Editing_Model_Settings|Model Properties]] dialog)
* Model description field (available in [[QPR_ProcessAnalyzer_Project_Workspace#Editing_Model_Settings|Model Properties]] dialog)


When asked to explain a chart, the following information is sent:
Additionally, when user asks to explain a chart, the following information is sent:
* Chart settings (shown in chart settings [[QPR_ProcessAnalyzer_Chart#Advanced_Settings|Advanced tab]])
* Chart settings (shown in chart settings [[QPR_ProcessAnalyzer_Chart#Advanced_Settings|Advanced tab]])
* Data the chart is visualizing
* 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.
Additional information how data is handled:
 
* AI Assistant does not make additional queries to the model data, 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 (https://openai.com/policies/business-terms).
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/.
* OpenAI does not use the customer data to train LLM's.
* In OpenAI services, all data is encryption at rest (AES-256) and in transit (TLS 1.2+).
* More information about privacy for OpenAI services: https://openai.com/enterprise-privacy/.

Latest revision as of 05:56, 4 June 2024

AI Assistant is generative AI based chat dialog where users can use QPR ProcessAnalyzer by interacting with natural language. AI Assistant can for example explain charts and analyses, and create filters based on user description. AI Assistant can also answer question about the analyzed model, when training material is provided beforehand.

Take AI Assistant into Use

In QPR Cloud, the AI Assistant is disabled by default. To take the AI Assistant into use, please sent a request to customercare@qpr.com and the AI Assistant will be enabled for your environment.

To enable the AI Assistant for customers using an on-premise system, the system administrator need to configure following:

  1. Create an OpenAI account in https://openai.com, and create an OpenAI API key. Note that the OpenAI API is a paid service and a credit card is needed for payments.
  2. In the PA_CONFIGURATION table in QPR ProcessAnalyzer database, define your OpenAI API key in the OpenAIAPIKey field.
  3. Optionally, define which large language model to use in the OpenAIDefaultModelName field.

You can also fine-tune the large language model, so that it better suits to your use. For example, the large language modelcan be fine-tuned with background information regarding the analyzed process and the broader business environment. More information about fine-tuning OpenAI large language models, please contact QPR or check out the OpenAI technical instructions: https://platform.openai.com/docs/guides/fine-tuning.

Available AI Functionality

The AI Assistant provides the following kind of assistance to users:

  • AI Assistant can answer questions about the analyzed process. The answer are based on the information used to train the LLM. To train the LLM, you can provide information in the model's description field. Alternatively, for larger data sets, fine-tuning can be used (more above).
  • AI Assistant can create filters and root causes criteria based on user description. For example, you can ask "Show cases with Delivery Created" (assuming that the model has Delivery Created events). You can also ask: "Filter cases where Company Code is Germany" (assuming that the model has the Company Code case attribute and it has a value Germany). You may ask: "Why there are Customer Return events?" and it will create a root causes criteria for the Root Causes analysis.
  • AI Assistant can explain charts in the dashboard. To ask for an explanation, select the chart and click the Explain the selected chart button. The response contains a general description what this analysis or visualization is showing, and also it makes observations and findings regarding the the shown data. If you still want more information about the chart, please ask from the AI Assistant!

Using AI Assistant

The chat pane is used to interact with the AI Assistant which is available for all users in dashboards. Discussions are stored permanently, so the chat history in a dashboard is accessible to the user even after the user logs out and logs back in. There is a separate discussion in each dashboard. Discussions are also user specific, so users cannot see each other's discussions.

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 Chat Pane

When in a dashboard, the 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. The AI Assistant can be closed by clicking the X icon on in the header of the chat pane.

Deleting Messages

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. Also the entire chat discussion can be deleted by clicking the trashcan in the header of the chat pane.

Keeping the chat history is useful when you want to continue a previous discussion because the AI Assistant remembers the visible chat history when answering to subsequent messages. On the other hand, if you don't want to provide the chat history as a context when continuing the discussion, the chat can be deleted (either partly or entirely).

Regenerating Answer

To regenerate the last message from the AI Assistant, hover over the message and click the round arrow icon. You can use the regeneration to provide a different answer from the AI Assistant in case you are not satisfied with the previous answer. Alternatively, you can elaborate you request or question so that the AI Assistant is able to provide a better response.

What Data Is Sent to OpenAI

AI Assistant is based on the large language models (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 and project name
  • Case and event attribute names
  • Event type names
  • Model description field (available in Model Properties dialog)

Additionally, when user asks to explain a chart, the following information is sent:

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

Additional information how data is handled:

  • AI Assistant does not make additional queries to the model data, but it only sees information that is shown to the user in the dashboard.
  • AI Assistant uses the OpenAI API for which the OpenAI's Business Terms are applied (https://openai.com/policies/business-terms).
  • OpenAI does not use the customer data to train LLM's.
  • In OpenAI services, all data is encryption at rest (AES-256) and in transit (TLS 1.2+).
  • More information about privacy for OpenAI services: https://openai.com/enterprise-privacy/.