update readme

Author: pollyndos

CS/Program.cs

@@ -1,22 +1,17 @@
 using Azure;
 using Azure.AI.OpenAI;
+using DashboardAIAssistant.Services;
 using DevExpress.AIIntegration;
 using DevExpress.AspNetCore;
 using DevExpress.DashboardAspNetCore;
 using DevExpress.DashboardCommon;
 using DevExpress.DashboardWeb;
 using DevExpress.DataAccess.Excel;
-using DevExpress.DataAccess.Sql;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.AI;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
-using Microsoft.Extensions.Hosting.Internal;
-using DashboardAIAssistant;
-using DashboardAIAssistant.Services;
-using System;
-using System.IO;
 
 var builder = WebApplication.CreateBuilder(args);
 builder.Services

README.md

@@ -3,13 +3,13 @@
 [![](https://img.shields.io/badge/📖_How_to_use_DevExpress_Examples-e9f6fc?style=flat-square)](https://docs.devexpress.com/GeneralInformation/403183)
 [![](https://img.shields.io/badge/💬_Leave_Feedback-feecdd?style=flat-square)](#does-this-example-address-your-development-requirementsobjectives)
 <!-- default badges end -->
-# Dashboard for ASP.NET Core -- Integrate AI Assistant based on Azure OpenAI
+# Dashboard for ASP.NET Core — Integrate AI Assistant based on Azure OpenAI
 
-This example is an ASP.NET Core application with integrated DevExpress Reports and an AI assistant. User requests and assistant responses are displayed on-screen using the DevExtreme [`dxChat`](https://js.devexpress.com/jQuery/Documentation/24_2/ApiReference/UI_Components/dxChat/) component.
+This example is an ASP.NET Core application with integrated DevExpress Reports and an AI assistant. User requests and assistant responses are displayed on-screen using the DevExtreme [`dxChat`](https://js.devexpress.com/jQuery/Documentation/24_2/ApiReference/UI_Components/dxChat/) component. An AI Assistant [custom dashboard item](https://docs.devexpress.com/Dashboard/117546/web-dashboard/advanced-customization/create-a-custom-item) is based on the `dxChat` widget.
 
-![DevExpress BI Dashboard - Integrate AI Assistant](images/dashboard-ai-assistant.png)
+![DevExpress BI Dashboard - Integrate an AI Assistant](images/dashboard-ai-assistant.png)
 
-The AI Assistant reviews and analyzes all the data displayed in the dashboard to answer your questions. For a more focused analysis, you can select a specific dashboard item. Simply click the **Values** button in the AI Assistant custom item's caption and choose the desired widget. Any changes to dashboard data—such as updates to parameters or master filters—will automatically trigger a recreation of the AI Assistant.
+The AI Assistant reviews and analyzes all the data displayed in the dashboard to answer your questions. For a more focused analysis, you can select a specific dashboard item. Click the **Values** button in the AI Assistant custom item's caption and choose the desired widget. Any changes to dashboard data—such as updates to parameters or master filters—will automatically trigger a recreation of the AI Assistant. The dashboard data is exported in Excel format and passed to the AI Assistant.
 
 **Please note that AI Assistant initialization takes time. The assistant is ready for interaction once Microsoft Azure scans the source document on the server side.**
 
@@ -20,9 +20,9 @@ The AI Assistant reviews and analyzes all the data displayed in the dashboard to
 > [!NOTE]  
 > DevExpress AI-powered extensions follow the "bring your own key" principle. DevExpress does not offer a REST API and does not ship any built-in LLMs/SLMs. You need an active Azure/Open AI subscription to obtain the REST API endpoint, key, and model deployment name. These variables must be specified at application startup to register AI clients and enable DevExpress AI-powered Extensions in your application.
 
-You need to create an Azure OpenAI resource in the Azure portal to use AI Assistants for DevExpress BI Dashboard. Refer to the following help topic for details: [Microsoft - Create and deploy an Azure OpenAI Service resource](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/create-resource?pivots=web-portal).
+Create an Azure OpenAI resource in the Azure portal to use AI Assistants for DevExpress BI Dashboard. Refer to the following help topic for details: [Microsoft - Create and deploy an Azure OpenAI Service resource](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/create-resource?pivots=web-portal).
 
-Once you obtain a private endpoint and an API key, register them as `AZURE_OPENAI_ENDPOINT` and `AZURE_OPENAI_APIKEY` environment variables. The [EnvSettings.cs](./CS/ReportingApp/EnvSettings.cs) reads these settings. `DeploymentName` in this file is a name of your Azure model, for example, `GPT4o`:
+Once you obtain a private endpoint and an API key, register them as `AZURE_OPENAI_ENDPOINT` and `AZURE_OPENAI_APIKEY` environment variables. The [EnvSettings.cs](./CS/EnvSettings.cs) reads these settings. `DeploymentName` in this file is a name of your Azure model, for example, `GPT4o`:
 
 ```cs
 public static class EnvSettings {
@@ -32,9 +32,6 @@ public static class EnvSettings {
 }
 ```
 
->[!NOTE]
-> Availability of Azure Open AI Assistants depends on the region. Refer to the following article for more details: [Assistants (Preview)](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#assistants-preview).
-
 Files to Review: 
 - [EnvSettings.cs](./CS/EnvSettings.cs)
 
@@ -62,6 +59,9 @@ builder.Services.AddDevExpressAI(config =>
 // ...
 ```
 
+>[!NOTE]
+> Availability of Azure Open AI Assistants depends on the region. Refer to the following article for more details: [Assistants (Preview)](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#assistants-preview).
+
 Files to Review: 
 - [Program.cs](./CS/Program.cs)
 
@@ -82,11 +82,19 @@ Files to Review:
 - [AIAssistantProvider.cs](./CS/Services/AIAssistantProvider.cs)
 - [IAIAssistantProvider.cs](./CS/IAIAssistantProvider.cs)
 
-### Create a Custom Item with AI Assistant
+### Create a AI Assistant Custom Item
+
+This example implements a [custom item](https://docs.devexpress.com/Dashboard/117546/web-dashboard/advanced-customization/create-a-custom-item) based on the [`dxChat`](https://js.devexpress.com/jQuery/Documentation/Guide/UI_Components/Chat/Overview/) component. The 
+
+For instructions on how to implement a custom dashboard items, refer to tutorials in the following section: [Create a Custom Item for the Web Dashboard](https://docs.devexpress.com/Dashboard/117546/web-dashboard/advanced-customization/create-a-custom-item).
 
-This example implements a [custom item](https://docs.devexpress.com/Dashboard/117546/web-dashboard/advanced-customization/create-a-custom-item) based on the [`dxChat`](https://js.devexpress.com/jQuery/Documentation/Guide/UI_Components/Chat/Overview/) component.
+For the **AI Assistant** custom item implementation, review to the following file: [aiChatCustomItem.js](./CS/wwwroot/js/aiChatCustomItem.js)
 
-For the **AI Assistant** custom item implementation, refer to the following file: [aiChatCustomItem.js](./CS/wwwroot/js/aiChatCustomItem.js)
+The additional logic for the custom item is implemented in `handleDashboardInitialized` and `customizeChatCustomItemCaptionToolbar` in the [Index.cshtml](./CS/Pages/Index.cshtml) file. The `itemCaptionToolbarUpdated` event is used to add a **Select Widget** button to the item's caption. This button allows users to select a dashboard item for the AI Assistant. The `DashboardInitialized` event is handled to implement the one AI Assistant per dashboard logic.
+
+Files to Review:
+- [Index.cshtml](./CS/Pages/Index.cshtml)
+- [aiChatCustomItem.js](./CS/wwwroot/js/aiChatCustomItem.js)
 
 ### Register the Custom Item
 
@@ -112,15 +120,25 @@ Register the created custom item extension in the Wen Dashboard:
 </div>
 ```
 
-After you registered the extension the Assistant icon appears in the Dashboard Toolbox: 
+After you registered the extension the AI Assistant icon appears in the Dashboard Toolbox: 
 
 ![DevExpress BI Dashboard - AI Assistant Custom Item Icon](images/dashboard-toolbar-ai-assistant-item.png)
 
-Click the item to add an AI Assistant to the dashboard. Only one AI Assistant item is available per dashboard. You can ask the assistant questions in the Viewer mode.
+Click the item to add an AI Assistant item to the dashboard. Only one AI Assistant item is available per dashboard. You can ask the assistant questions in the Viewer mode.
 
 File to Review: 
 - [Index.cshtml](./CS/Pages/Index.cshtml)
 
+### Access the Assistant
+
+Each time a dashboard is initialized or its [dashboard state](https://docs.devexpress.com/Dashboard/DevExpress.DashboardCommon.DashboardState) changes, a new assistant is created and the dashboard data is exported in Excel format. This way the AI assistant is always provided with up-to-date data.
+
+Files to Review: 
+
+- [aiChatCustomItem.js](./CS/wwwroot/js/aiChatCustomItem.js)
+- [AIAssistantProvider.cs](./CS/Services/AIAssistantProvider.cs)
+- [AIChatController](./CS/Controllers/AIChatController.cs)
+
 ### Communicate with Assistant
 
 Each time a user sends a message, the [`onMessageEntered`](https://js.devexpress.com/jQuery/Documentation/24_2/ApiReference/UI_Components/dxChat/Configuration/#onMessageEntered) event handler passes the request to the assistant:
@@ -161,13 +179,16 @@ async onMessageEntered(e) {
 }
 ```
 
-[`AIChatController.GetAnswer`]() receives answers from the assistant.
+[`AIChatController.GetAnswer`](./CS/Controllers/AIChatController.cs#L38) receives answers from the assistant.
 
 ## Files to Review
 
+- [Program.cs](./CS/Program.cs)
+- [Index.cshtml](./CS/Pages/Index.cshtml)
+- [aiChatCustomItem.js](./CS/wwwroot/js/aiChatCustomItem.js)
 - [AIAssistantProvider.cs](./CS/Services/AIAssistantProvider.cs)
 - [IAIAssistantProvider.cs](./CS/IAIAssistantProvider.cs)
-- [Program.cs](./CS/Program.cs)
+- [AIChatController](./CS/Controllers/AIChatController.cs)
 
 ## Documentation