DevExpress.AIIntegration.Reporting.Common

AI-powered Extensions for DevExpress Reports

This package implements AI integration infrastructure for DevExpress Reporting. Use it to create or modify reports in code with your preferred AI assistant. The package also includes classes and interfaces that provide core functionality for platform-specific DevExpress AI-powered extensions and services.

Key Features

• Includes common model classes and interfaces shared by all DevExpress Reporting AI integration packages.
• Provides cross-platform extensions for AI-powered Reporting features, such as AI-assisted report generation.

Example

The following code sample initializes an AI client, creates a report request, and generates a report based on a user prompt:

using DevExpress.AIIntegration.Reporting.Common.Extensions;
using DevExpress.AIIntegration;
using Reporting.Generation.Console;
using DevExpress.XtraReports.UI;

// Retrieve the Azure OpenAI endpoint, key, and model from user environment variables.
string endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT", EnvironmentVariableTarget.User) ?? throw new InvalidOperationException("AZURE_OPENAI_ENDPOINT is not set.");
string apiKey = Environment.GetEnvironmentVariable("AZURE_OPENAI_API_KEY", EnvironmentVariableTarget.User) ?? throw new InvalidOperationException("AZURE_OPENAI_API_KEY is not set.");
string deploymentName = Environment.GetEnvironmentVariable("AZURE_OPENAI_DEPLOYMENT", EnvironmentVariableTarget.User) ?? "gpt-5.2";
// Create an Azure OpenAI client to work with the chat agent.
IChatClient chatClient = new AzureOpenAIClient(new Uri(endpoint), new ApiKeyCredential(apiKey))
    .GetChatClient(deploymentName)
    .AsIChatClient();
// Register chat client and reporting extensions.
AIExtensionsContainerDefault container = AIExtensionsContainerConsole.CreateDefaultAIExtensionContainer(chatClient);
container.RegisterReportingExtensions();
// Ask the user for a report description in natural language.
Console.WriteLine("Specify a prompt to generate the report:");
string prompt = Console.ReadLine();
try {
    // Create a host to handle clarification questions and progress notifications.
    ConsoleAIReportGenerationHost host = new ConsoleAIReportGenerationHost();
    // Build a generation request from the user prompt.
    PromptToReportRequest generationRequest = new PromptToReportRequest(userPrompt: prompt, dataSourceSchema: null, report: null) {
        ReportGenerationHost = host,
        FixLayoutErrors = true
    };
    // Generate a report layout and save it to a REPX file.
    XtraReport report = await container.GeneratePromptToReportAsync(generationRequest, default);
    report.SaveLayoutToXml("generatedReport.repx");
} catch (Exception ex) {
    Console.WriteLine($"Report generation failed: {ex.Message}");
}

Evaluation Period, Pricing Options, and Licensing Terms

Whether you own a license or want to start a 30-day evaluation period, register your DevExpress license key. To obtain your key, log in to the DevExpress Download Manager. Use your existing DevExpress.com account or create a new account for free. For additional registration instructions, see License Key for DevExpress Products.

If you purchase a license after evaluating a product, re-register your updated DevExpress license key to remove evaluation version warnings/messages.

This package is included in the following commercial subscriptions:

• DevExpress Reporting Subscription
• DevExpress Universal Subscription

See DevExpress Subscriptions & Licensing for subscription comparison tables, purchasing FAQ, and licensing information.

Documentation

• AI-Powered Functionality in DevExpress Reporting

Software Bill of Materials (SBOM)

To access SBOM files for DevExpress packages, please refer to the following article: Software Bill of Materials (SBOM) for DevExpress .NET assemblies/NuGet packages, JavaScript, VCL and other redistributable artifacts.

See Also: Information Security | Security - What You Need to Know

Useful Online Resources

• www.devexpress.com
• DevExpress Support Center
• DevExpress Blogs