PromptToReportRequest Class

A request to generate a report from the specified prompt.

Namespace: DevExpress.AIIntegration.Reporting.Common.Extensions

Assembly: DevExpress.AIIntegration.Reporting.Common.v26.1.dll

Declaration

C#

[DXBrowsable(true)]
public class PromptToReportRequest :
    TextRequest

VB.NET

<DXBrowsable(True)>
Public Class PromptToReportRequest
    Inherits TextRequest

Remarks

Describes a prompt-to-report operation, including the user prompt, an optional data source schema, and an optional existing report to update. You can also attach a host to enable interactive generation.

You can specify the following options:

PromptToReportRequest.Report

Specifies an existing report that the generation workflow should update.

PromptToReportRequest.ReportGenerationHost

Specifies a host that handles prompt clarifications and progress updates.

PromptToReportRequest.FixLayoutErrors

Specifies whether the generation workflow should attempt to fix report layout errors.

PromptToReportRequest.DataSourceSchema

Specifies a schema of a report’s data source.

Example

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

View Example: DevExpress Reports - Generate a Report Based on a User Prompt Within a Console App

C#

using Reporting.Generation.Console;
using Azure.AI.OpenAI;
using System.ClientModel;
using Microsoft.Extensions.AI;
using DevExpress.AIIntegration.Reporting.Common.Extensions;
using DevExpress.AIIntegration;
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.ForegroundColor = ConsoleColor.Red;
    Console.WriteLine(ex.Message);
    Console.ResetColor();
    Console.WriteLine();
}

Console.ReadLine();

VB.NET

Imports Azure.AI.OpenAI
Imports DevExpress.AIIntegration
Imports DevExpress.AIIntegration.Reporting
Imports DevExpress.AIIntegration.Reporting.Common.Extensions
Imports DevExpress.XtraReports.UI
Imports Microsoft.Extensions.AI
Imports Reporting.Generation.Console
Imports System.ClientModel
Module Program
    Sub Main()
        MainAsync().GetAwaiter().GetResult()
    End Sub

    Private Async Function MainAsync() As Task
        ' Retrieve the Azure OpenAI endpoint, key, and model from user environment variables.
        Dim endpoint As String = Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT", EnvironmentVariableTarget.User)
        If String.IsNullOrEmpty(endpoint) Then
            Throw New InvalidOperationException("AZURE_OPENAI_ENDPOINT is not set.")
        End If
        Dim apiKey As String = Environment.GetEnvironmentVariable("AZURE_OPENAI_API_KEY", EnvironmentVariableTarget.User)
        If String.IsNullOrEmpty(apiKey) Then
            Throw New InvalidOperationException("AZURE_OPENAI_API_KEY is not set.")
        End If

        Dim deploymentName As String = Environment.GetEnvironmentVariable("AZURE_OPENAI_DEPLOYMENT", EnvironmentVariableTarget.User)
        If String.IsNullOrEmpty(deploymentName) Then
            deploymentName = "gpt-5-mini"
        End If
        ' Create an Azure OpenAI client for working with the chat agent.
        Dim chatClient As IChatClient =
            (New AzureOpenAIClient(New Uri(endpoint), New ApiKeyCredential(apiKey))) _
            .GetChatClient(deploymentName) _
            .AsIChatClient()
        ' Create an AI extension container and enable reporting extensions.
        Dim container As AIExtensionsContainerDefault =
            AIExtensionsContainerConsole.CreateDefaultAIExtensionContainer(chatClient)
        container.RegisterReportingExtensions()
        ' Ask the user for a report description in natural language.
        System.Console.WriteLine("Input a prompt for report generation:")
        Dim prompt As String = System.Console.ReadLine()
        Try
            ' Enable interactive clarification questions and progress notifications.
            Dim host As New ConsoleAIReportGenerationHost()
            ' Build a generation request from the user prompt.
            Dim generationRequest As New PromptToReportRequest(
                userPrompt:=prompt,
                dataSourceSchema:=Nothing,
                report:=Nothing
            ) With {
                .ReportGenerationHost = host,
                .FixLayoutErrors = True
            }
            ' Generate a report layout and save it to a REPX file.
            Dim report As XtraReport =
                Await container.GeneratePromptToReportAsync(generationRequest, Nothing)
            report.SaveLayoutToXml("generatedReport.repx")
        Catch ex As Exception
            System.Console.WriteLine(ex.Message)
        End Try
        ' Keep the console window open.
        System.Console.ReadLine()
    End Function
End Module

Inheritance

Object

DevExpress.AIIntegration.Extensions.BaseRequest

TextRequest

PromptToReportRequest