Skip to content

Commit d79d4cd

Browse files
Apply suggestions from code review
Co-authored-by: DirkPieterse <dirk.pieterse@devexpress.com>
1 parent 60c6c5d commit d79d4cd

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
<!-- default badges end -->
66
# Dashboard for ASP.NET Core — Integrate AI Assistant based on Azure OpenAI
77

8-
This example is an ASP.NET Core application with integrated DevExpress BI Dashboard 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. The AI Assistant is implemented as a [custom dashboard item](https://docs.devexpress.com/Dashboard/117546/web-dashboard/advanced-customization/create-a-custom-item) based on the `dxChat` widget.
8+
This is an example of an ASP.NET Core application with an integrated DevExpress BI Dashboard 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. The AI Assistant is implemented as a [custom dashboard item](https://docs.devexpress.com/Dashboard/117546/web-dashboard/advanced-customization/create-a-custom-item) based on the `dxChat` widget.
99

1010
![DevExpress BI Dashboard - Integrate an AI Assistant](images/dashboard-ai-assistant.png)
1111

12-
The AI Assistant reviews and analyzes all data displayed in the dashboard to answer your questions. You can narrow down available data if you select a specific dashboard item. Click the **Select widget** button in the AI Assistant custom item's caption and choose the desired widget. Note that updates to parameters or master filters, or any other data changes automatically trigger the AI Assistant recreation.
12+
The AI Assistant reviews and analyzes all data displayed in the dashboard to answer your questions. You can filter the available data if you select a specific dashboard item. Click the **Select widget** button in the AI Assistant custom item's caption and choose the desired widget. Note that updates to parameters or master filters or any other data changes automatically trigger the AI Assistant recreation.
1313

1414
**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.**
1515

@@ -22,7 +22,7 @@ The AI Assistant reviews and analyzes all data displayed in the dashboard to ans
2222
2323
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).
2424

25-
Once you obtain a private endpoint and an API key, register them as `AZURE_OPENAI_ENDPOINT` and `AZURE_OPENAI_APIKEY` environment variables. Open [EnvSettings.cs](./CS/EnvSettings.cs) to review code that reads these settings. `DeploymentName` in this file is a name of your Azure model, for example, `GPT4o`:
25+
Once you obtain a private endpoint and API key, register them as `AZURE_OPENAI_ENDPOINT` and `AZURE_OPENAI_APIKEY` environment variables. Open [EnvSettings.cs](./CS/EnvSettings.cs) to review the code that reads these settings. `DeploymentName` in this file is a name of your Azure model, for example, `GPT4o`:
2626

2727
```cs
2828
public static class EnvSettings {
@@ -37,7 +37,7 @@ Files to Review:
3737

3838
### Register AI Services
3939

40-
Register AI services in your application. Add the following code to the _Program.cs_ file:
40+
Add the following code to the _Program.cs_ file to register AI services in your application:
4141

4242
```cs
4343
using DevExpress.AIIntegration;
@@ -123,7 +123,7 @@ Register the created custom item extension in the Web Dashboard:
123123
</div>
124124
```
125125

126-
After you registered the extension, the AI Assistant icon appears in the Dashboard Toolbox:
126+
After you register the extension, the AI Assistant icon appears in the Dashboard Toolbox:
127127

128128
![DevExpress BI Dashboard - AI Assistant Custom Item Icon](images/dashboard-toolbar-ai-assistant-item.png)
129129

0 commit comments

Comments
 (0)