Reporting for ASP.NET Core - Integrate AI Assistant based on Azure OpenAI

C#
using System;

namespace ReportingApp {
    public static class EnvSettings {
        public static string AzureOpenAIEndpoint { get { return Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT"); } }
        public static string AzureOpenAIKey { get { return Environment.GetEnvironmentVariable("AZURE_OPENAI_APIKEY"); } }
        public static string DeploymentName { get { return "GPT4o"; } }
    }
}

C#
using Azure.AI.OpenAI;
using DevExpress.AspNetCore;
using DevExpress.AspNetCore.Reporting;
using DevExpress.Security.Resources;
using DevExpress.XtraReports.Web.Extensions;
using DevExpress.XtraReports.Web.WebDocumentViewer;
using ReportingApp;
using ReportingApp.Data;
using ReportingApp.Services;
using Microsoft.AspNetCore.Builder;
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using System;
using System.IO;
using Azure;
using DevExpress.AIIntegration;
using Microsoft.Extensions.AI;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddDevExpressControls();
builder.Services.AddScoped<ReportStorageWebExtension, CustomReportStorageWebExtension>();
builder.Services.AddMvc();
builder.Services.ConfigureReportingServices(configurator => {
    if(builder.Environment.IsDevelopment()) {
        configurator.UseDevelopmentMode();
    }
    configurator.ConfigureReportDesigner(designerConfigurator => {
        designerConfigurator.RegisterDataSourceWizardConnectionStringsProvider<CustomSqlDataSourceWizardConnectionStringsProvider>();
    });
    configurator.ConfigureWebDocumentViewer(viewerConfigurator => {
        viewerConfigurator.UseCachedReportSourceBuilder();
        viewerConfigurator.RegisterConnectionProviderFactory<CustomSqlDataConnectionProviderFactory>();
    });
});

builder.Services.AddDbContext<ReportDbContext>(options => options.UseSqlite(builder.Configuration.GetConnectionString("ReportsDataConnectionString")));
builder.Services.AddScoped<DocumentOperationService, AIDocumentOperationService>();

var azureOpenAIClient = new AzureOpenAIClient(
    new Uri(EnvSettings.AzureOpenAIEndpoint),
    new AzureKeyCredential(EnvSettings.AzureOpenAIKey));
    
var chatClient = azureOpenAIClient.AsChatClient(EnvSettings.DeploymentName);

builder.Services.AddSingleton(chatClient);
builder.Services.AddSingleton<IAIAssistantProvider, AIAssistantProvider>();
builder.Services.AddDevExpressAI(config =>
{
    config.RegisterOpenAIAssistants(azureOpenAIClient, EnvSettings.DeploymentName);
});

var app = builder.Build();
using(var scope = app.Services.CreateScope()) {
    var services = scope.ServiceProvider;
    services.GetService<ReportDbContext>().InitializeDatabase();
}
var contentDirectoryAllowRule = DirectoryAccessRule.Allow(new DirectoryInfo(Path.Combine(builder.Environment.ContentRootPath, "Content")).FullName);
AccessSettings.ReportingSpecificResources.TrySetRules(contentDirectoryAllowRule, UrlAccessRule.Allow());
DevExpress.XtraReports.Configuration.Settings.Default.UserDesignerOptions.DataBindingMode = DevExpress.XtraReports.UI.DataBindingMode.Expressions;
app.UseDevExpressControls();
System.Net.ServicePointManager.SecurityProtocol |= System.Net.SecurityProtocolType.Tls12;
if(app.Environment.IsDevelopment()) {
    app.UseDeveloperExceptionPage();
} else {
    app.UseExceptionHandler("/Home/Error");
    // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
    app.UseHsts();
}
app.UseHttpsRedirection();
app.UseStaticFiles();
app.UseRouting();

string contentPath = app.Environment.ContentRootPath;
AppDomain.CurrentDomain.SetData("DataDirectory", contentPath);

app.UseAuthorization();
app.MapControllerRoute(
    name: "default",
    pattern: "{controller=Home}/{action=Index}/{id?}");
app.Run();

C#
using System;
using System.Collections.Concurrent;
using System.IO;
using System.Threading.Tasks;
using DevExpress.AIIntegration.OpenAI.Services;
using DevExpress.AIIntegration.Services.Assistant;
using Microsoft.AspNetCore.Hosting;

namespace ReportingApp.Services {
    public class AIAssistantProvider : IAIAssistantProvider {
        private readonly IAIAssistantFactory assistantFactory;
        private readonly IWebHostEnvironment environment;

        private ConcurrentDictionary<string, IAIAssistant> Assistants { get; set; } = new ();
        public AIAssistantProvider(IAIAssistantFactory assistantFactory, IWebHostEnvironment environment) {
            this.assistantFactory = assistantFactory;
            this.environment = environment;
        }
        async Task LoadDocumentation(IAIAssistant assistant, string prompt) {
            var dirPath = Path.Combine(environment.ContentRootPath, "Data");
            var filePath = Path.Combine(dirPath, "documentation.pdf");

            using(FileStream stream = File.OpenRead(filePath)) {
                await assistant.InitializeAsync(new OpenAIAssistantOptions("documentation.pdf", stream, prompt));
            }
        }
        string GetPrompt(AssistantType assistantType) {
            switch(assistantType) {
                case AssistantType.UserAssistant:
                    return "You are a user interface assistant (you help people use a software program). Your role is to read information from documentation files in PDF format. You assist users by providing accurate answers to their questions based on information from these files. \r\n\r\nTasks:\r\nExtract relevant information from PDF documentation to answer user questions.\r\nClearly explain your reasoning process and give step by step solutions to ensure users understand how you arrived at your answers.\r\nAlways provide precise and accurate information based on content from the documentation file.\r\nIf you cannot find an answer based on provided documentation, explicitly state: 'The requested information cannot be found in documentation provided.'\r\n Respond in plain text only, without markdown, sources, footnotes, or annotations.";
                case AssistantType.DocumentAssistant:
                    return "You are a data analysis assistant. Your task is to read information from PDF files and provide users with accurate data-driven answers based on the contents of these files. \n Key Responsibilities: \n - Perform data analysis, including data summaries, calculations, filtering, and trend identification.\n - Clearly explain your analysis process to ensure users understand how you reached your conclusions.\n - Provide precise and accurate responses strictly based on data in the file.\n - If the requested information is not available in the provided file's content, state: \"The requested information cannot be found in the data provided.\"\n - Avoid giving responses when data is insufficient for a reliable answer.\n - Ask clarifying questions when a user’s query is unclear or lacks detail.\n - Your primary goal is to deliver helpful insights that directly address user questions. Do not make assumptions or infer details not supported by data. Respond in plain text only, without sources, footnotes, or annotations.\n Avoid giving information about provided file name, assistants' IDs and other internal data";
                default:
                    return "";
            }
        }
        public void DisposeAssistant(string assistantName) {
            if(Assistants.TryRemove(assistantName, out IAIAssistant assistant)) {
                assistant.Dispose();
            } else {
                throw new Exception("Assistant not found");
            }
        }
        public IAIAssistant GetAssistant(string assistantName) {
            if(!string.IsNullOrEmpty(assistantName) && Assistants.TryGetValue(assistantName, out var assistant)) {
                return assistant;
            } else {
                throw new Exception("Assistant not found");
            }
        }
        public async Task<string> CreateAssistant(AssistantType assistantType, Stream data) {
            var assistantName = Guid.NewGuid().ToString();
            var assistant = await assistantFactory.CreateAssistant(assistantName);
            Assistants.TryAdd(assistantName, assistant);

            var prompt = GetPrompt(assistantType);
            if(assistantType == AssistantType.UserAssistant) {
                await LoadDocumentation(assistant, prompt);
            } else {
                await assistant.InitializeAsync(new OpenAIAssistantOptions(Guid.NewGuid().ToString() + ".pdf", data, prompt));
            }
            return assistantName;
        }

        public Task<string> CreateAssistant(AssistantType assistantType) {
            return CreateAssistant(assistantType, null);
        }
    }
}

C#
using DevExpress.AIIntegration.Services.Assistant;
using System.IO;
using System.Threading.Tasks;

namespace ReportingApp.Services {
    public enum AssistantType {
        DocumentAssistant,
        UserAssistant
    }
    public interface IAIAssistantProvider {
        IAIAssistant GetAssistant(string assistantName);
        Task<string> CreateAssistant(AssistantType assistantType, Stream data);
        Task<string> CreateAssistant(AssistantType assistantType);
        void DisposeAssistant(string assistantName);
    }
}

C#
using System.IO;
using System.Threading.Tasks;
using DevExpress.XtraPrinting;
using DevExpress.XtraReports.Web.WebDocumentViewer;
using DevExpress.XtraReports.Web.WebDocumentViewer.DataContracts;

namespace ReportingApp.Services {
    public class AIDocumentOperationService : DocumentOperationService {
        private IAIAssistantProvider AIAssistantProvider { get; set; }

        public AIDocumentOperationService(IAIAssistantProvider assistantProvider) {
            AIAssistantProvider = assistantProvider;
        }

        public override bool CanPerformOperation(DocumentOperationRequest request) {
            return true;
        }
        public override async Task<DocumentOperationResponse> PerformOperationAsync(DocumentOperationRequest request, PrintingSystemBase printingSystem, PrintingSystemBase printingSystemWithEditingFields) {
            using(var stream = new MemoryStream()) {
                printingSystem.ExportToPdf(stream, printingSystem.ExportOptions.Pdf);
                var assistantName = await AIAssistantProvider.CreateAssistant(AssistantType.DocumentAssistant, stream);
                return new DocumentOperationResponse {
                    DocumentId = request.DocumentId,
                    CustomData = assistantName,
                    Succeeded = true
                };
            }
        }
    }
}

Razor
@model DevExpress.XtraReports.Web.WebDocumentViewer.WebDocumentViewerModel
@await Html.PartialAsync("_AILayout")
<script>
    let aiTab;
    async function BeforeRender(sender, args) {
        const previewModel = args;
        const reportPreview = previewModel.reportPreview;
        const result = await fetch(`/AI/CreateUserAssistant`);
        const chatId = await result.text();
        aiTab = createAssistantTab(chatId);
        const model = aiTab.model;
        previewModel.tabPanel.tabs.push(aiTab);
        reportPreview.events.on('documentBuildingChanged', (args) => {
            if (args.newValue === true) {
                aiTab.visible = false;
                if (model.chatId) {
                    const formData = new FormData();
                    formData.append('chatId', model.chatId);
                    fetch(`/AI/CloseChat`, {
                        method: 'POST',
                        body: formData
                    });
                    model.chatId = '';
                }
            }
        });
    }

    async function DocumentReady(sender, args) {
        const response = await sender.PerformCustomDocumentOperation(null, true);
        if (response.customData && aiTab?.model) {
            aiTab.model.chatId = response.customData;
            aiTab.visible = true;
        }
    }
</script>

@{
    var viewerRender = Html.DevExpress().WebDocumentViewer("DocumentViewer")
        .Height("100%")
        .ClientSideEvents(configure => {
            configure.BeforeRender("BeforeRender");
            configure.DocumentReady("DocumentReady");
        })
        .Bind(Model);
    @viewerRender.RenderHtml()
}

@section Scripts {
    <link href="~/css/dx-reporting-skeleton-screen.css" rel="stylesheet" />
    <link rel="stylesheet" href="~/css/viewer.part.bundle.css" />
    <link rel="stylesheet" href="~/css/dx.material.blue.light.bundle.css" />
    <script src="~/js/reporting.thirdparty.bundle.js"></script>
    <script src="~/js/viewer.part.bundle.js"></script>
    <script src="~/js/aiIntegration.js"></script>

    @viewerRender.RenderScripts()
}

C#
using System.Threading.Tasks;
using ReportingApp.Services;
using Microsoft.AspNetCore.Mvc;

namespace ReportingApp.Controllers {
    public class AIController : ControllerBase {
        IAIAssistantProvider AIAssistantProvider { get; set; }

        public AIController(IAIAssistantProvider assistantProvider) {
            AIAssistantProvider = assistantProvider;
        }

        public async Task<string> CreateUserAssistant() {
            var assistantName = await AIAssistantProvider.CreateAssistant(AssistantType.UserAssistant);
            return assistantName;
        }

        public async Task<string> GetAnswer([FromForm] string chatId, [FromForm] string text) {
            var assistant = AIAssistantProvider.GetAssistant(chatId);
            return await assistant.GetAnswerAsync(text);
        }

        public ActionResult CloseChat([FromForm] string chatId) {
            AIAssistantProvider.DisposeAssistant(chatId);
            return Ok();
        }
    }
}

JavaScript
let lastUserQuery;

const assistant = {
    id: 'assistant',
    name: 'Virtual Assistant',
};

const user = {
    id: 'user',
};

function normilizeAIResponse(text) {
    text = text.replace(/【\d+:\d+†[^\】]+】/g, "");
    let html = marked.parse(text);
    if (/<p>\.\s*<\/p>\s*$/.test(html))
        html = html.replace(/<p>\.\s*<\/p>\s*$/, "")
    return html;
}

function copyText(text) {
    navigator.clipboard.writeText(text);
}

async function getAIResponse(text, id) {
    const formData = new FormData();
    formData.append('text', text);
    formData.append('chatId', id);
    lastUserQuery = text;
    const response = await fetch(`/AI/GetAnswer`, {
        method: 'POST',
        body: formData
    });
    return await response.text();
}

function RenderAssistantMessage(instance, message) {
    instance.option({ typingUsers: [] });
    instance.renderMessage({ timestamp: new Date(), text: message, author: assistant.name, id: assistant.id });
}

async function refreshAnswer(instance) {
    const items = instance.option('items');
    const newItems = items.slice(0, -1);
    instance.option({ items: newItems });
    instance.option({ typingUsers: [assistant] });
    const aiResponse = await getAIResponse(lastUserQuery, assistant.id);
    setTimeout(() => {
        instance.option({ typingUsers: [] });
        RenderAssistantMessage(instance, aiResponse);
    }, 200);
}

function createAssistantTab(chatId) {
    assistant.id = chatId;
    const model = {
        title: 'AI Assistant',
        showAvatar: false,
        showUserName: false,
        showMessageTimestamp: false,
        user: user,
        messageTemplate: (data, container) => {
            const { message } = data;

            if (message.author.id && message.author.id !== assistant.id)
                return message.text;

            const $textElement = $('<div>')
                .html(normilizeAIResponse(message.text))
                .appendTo(container);
            const $buttonContainer = $('<div>')
                .addClass('dx-bubble-button-containder');
            $('<div>')
                .dxButton({
                    icon: 'copy',
                    stylingMode: 'text',
                    onClick: () => {
                        const text = $textElement.text();
                        copyText(text);
                    }
                })
                .appendTo($buttonContainer);
            $('<div>')
                .dxButton({
                    icon: 'refresh',
                    stylingMode: 'text',
                    onClick: () => {
                        refreshAnswer(data.component);
                    },
                })
                .appendTo($buttonContainer);
            $buttonContainer.appendTo(container);
        },
        onMessageEntered: async (e) => {
            const instance = e.component;
            instance.renderMessage(e.message);
            instance.option({ typingUsers: [assistant] });
            const userInput = e.message.text;

            var response = await getAIResponse(userInput, assistant.id);
            RenderAssistantMessage(instance, response);
        }
    };

    return new DevExpress.Analytics.Utils.TabInfo({
        text: 'AI Assistant',
        template: 'dxrd-ai-panel',
        imageTemplateName: 'dxrd-ai-icon',
        imageClassName: 'aitab',
        model: model
    });
}

Razor
@model DevExpress.XtraReports.Web.ReportDesigner.ReportDesignerModel

<script>
    async function BeforeRender(sender, args) {
        const result = await fetch(`/AI/CreateUserAssistant`);
        const chatId = await result.text();
        const tab = createAssistantTab(chatId);
        args.tabPanel.tabs.push(tab);
    }
</script>

@await Html.PartialAsync("_AILayout")
@{
    var designerRender = Html.DevExpress().ReportDesigner("reportDesigner")
        .Height("100%")
        .ClientSideEvents(configure => {
            configure.BeforeRender("BeforeRender");
        })
        .Bind(Model);
    @designerRender.RenderHtml()
}

@section Scripts {
    <link href="~/css/dx-reporting-skeleton-screen.css" rel="stylesheet" />
    <link rel="stylesheet" href="~/css/viewer.part.bundle.css" />
    <link rel="stylesheet" href="~/css/designer.part.bundle.css" />
    <link rel="stylesheet" href="~/css/ace/ace.bundle.css" />
    <link rel="stylesheet" href="~/css/dx.material.blue.light.bundle.css" />

    <script src="~/js/reporting.thirdparty.bundle.js"></script>
    <script src="~/js/viewer.part.bundle.js"></script>
    <script src="~/js/designer.part.bundle.js"></script>
    <script src="~/js/aiIntegration.js"></script>

    @designerRender.RenderScripts()
}