Back to Devexpress

ReportPromptToReportBehaviorProperties Class

xtrareports-devexpress-dot-aiintegration-dot-winforms-dot-reporting-bda652a2.md

latest5.2 KB
Original Source

ReportPromptToReportBehaviorProperties Class

Contains ReportPromptToReportBehavior settings.

Namespace : DevExpress.AIIntegration.WinForms.Reporting

Assembly : DevExpress.AIIntegration.WinForms.Reporting.v25.2.dll

NuGet Package : DevExpress.AIIntegration.WinForms.Reporting

Declaration

csharp
public class ReportPromptToReportBehaviorProperties :
    ReportDesignerGenerationBehaviorProperties
vb
Public Class ReportPromptToReportBehaviorProperties
    Inherits ReportDesignerGenerationBehaviorProperties

The following members return ReportPromptToReportBehaviorProperties objects:

Remarks

Use ReportPromptToReportBehavior.Properties to access the behavior’s settings. The following settings are available:

ReportPromptToReportBehaviorProperties.FixLayoutErrorsSpecifies whether to automatically resolve report control overlapping.ReportPromptToReportBehaviorProperties.PredefinedPromptsSpecifies predefined prompts that can be used to create a report in the Report Wizard.ReportPromptToReportBehaviorProperties.RetryAttemptCountSpecifies the number of attempts to fix report layout errors that may appear in the LLM response.ReportPromptToReportBehaviorProperties.TemperatureControls output randomness. Lower temperatures (values between 0f and 0.5f) yield more predictable and focused outputs, while higher temperatures (values between 0.5f and 1f) produce more diverse and creative responses. The default value is 0f.

The following code registers a ReportPromptToReportBehavior and configures its settings:

csharp
using DevExpress.AIIntegration.WinForms.Reporting;
// ...
public partial class Form1 : Form {
    public Form1() {
        InitializeComponent();
        behaviorManager1.Attach<ReportPromptToReportBehavior>(reportDesigner1, behavior => {
          // Set the number of attempts.    
          behavior.Properties.RetryAttemptCount = 5;
          // Specify output randomness.
          behavior.Properties.Temperature = 0.6f;
          // Override the built-in prompts collection and display a custom promt.
          behavior.Properties.PredefinedPrompts = new[] {
            new AIReportPrompt() { Title = "Custom Prompt", Text = "Prompt text" }
          };
        });
    }
}
vb
Imports DevExpress.AIIntegration.WinForms.Reporting
' ...
Partial Public Class Form1
    Inherits Form

    Public Sub New()
        InitializeComponent()
        behaviorManager1.Attach(Of ReportPromptToReportBehavior)(reportDesigner1, Sub(behavior)
            ' Set the number of attempts.
            behavior.Properties.RetryAttemptCount = 5
            ' Specify output randomness.
            behavior.Properties.Temperature = 0.6F
            ' Override the built-in prompts collection and display a custom promt.
            behavior.Properties.PredefinedPrompts = {
                New AIReportPrompt() With {
                    .Title = "Custom Prompt",
                    .Text = "Prompt text"
                }
            }
        End Sub)
    End Sub
End Class

Review the following help topic for more information on how to use this functionality in the WinForms Report Designer: Prompt-to-Report Behavior in the WinForms Report Designer (CTP).

Inheritance

Object DevExpress.Utils.Base.BaseObject DevExpress.Utils.Base.BaseProperties DevExpress.Utils.Behaviors.BehaviorProperties DevExpress.AIIntegration.WinForms.Reporting.ReportDesignerGenerationBehaviorPropertiesBase DevExpress.AIIntegration.WinForms.Reporting.ReportDesignerGenerationBehaviorProperties ReportPromptToReportBehaviorProperties

See Also

ReportPromptToReportBehaviorProperties Members

DevExpress.AIIntegration.WinForms.Reporting Namespace