RadzenInlineAIPrompt Class

RadzenInlineAIPromptlinkLink to this section

An AI assistant for a text field: a button that opens a RadzenAIPrompt in a popup and applies the result to the bound value. Bind Value to the same value as the field; set TargetId to the id of the input or textarea so that a selection inside it becomes the context and only the selection is replaced.

Declaration

public RadzenInlineAIPrompt()

AppendTextlinkLink to this section

Gets or sets the text of the button that appends the output to the value. Default is "Append".

Declaration

public string AppendText { get; set; }

Property Value

AppliedlinkLink to this section

Gets or sets the callback invoked after the output is applied to the value, with the new value.

Declaration

public EventCallback<string> Applied { get; set; }

Property Value

ButtonStylelinkLink to this section

Gets or sets the style of the button. Default is Base.

Declaration

public ButtonStyle ButtonStyle { get; set; }

Property Value

CloselinkLink to this section

Gets or sets the callback invoked when the popup closes.

Declaration

public EventCallback Close { get; set; }

Property Value

CommandslinkLink to this section

Gets or sets the commands that refine the output, for example shorter, formal or translate.

Declaration

public IEnumerable<AIPromptCommand> Commands { get; set; }

Property Value

DisabledlinkLink to this section

Gets or sets whether the button is disabled.

Declaration

public bool Disabled { get; set; }

Property Value

DiscardTextlinkLink to this section

Gets or sets the text of the button that discards the output. Default is "Discard".

Declaration

public string DiscardText { get; set; }

Property Value

ErrorlinkLink to this section

Gets or sets the callback invoked when a request fails.

Declaration

public EventCallback<Exception> Error { get; set; }

Property Value

GeneratedlinkLink to this section

Gets or sets the callback invoked when the model produces an output.

Declaration

public EventCallback<AIPromptGeneratedEventArgs> Generated { get; set; }

Property Value

IconlinkLink to this section

Gets or sets the icon of the button. Default is auto_awesome.

Declaration

public string Icon { get; set; }

Property Value

IconColorlinkLink to this section

Gets or sets the color of the icon.

Declaration

public string IconColor { get; set; }

Property Value

IsOpenlinkLink to this section

Gets whether the popup is open.

Declaration

public bool IsOpen { get; }

Property Value

MaxTokenslinkLink to this section

Gets or sets the maximum number of output tokens.

Declaration

public int? MaxTokens { get; set; }

Property Value

ModelIdlinkLink to this section

Gets or sets the model. Uses the model of AIChatServiceOptions when not set.

Declaration

public string ModelId { get; set; }

Property Value

OpenlinkLink to this section

Gets or sets the callback invoked when the popup opens.

Declaration

public EventCallback Open { get; set; }

Property Value

OutputlinkLink to this section

Gets the output of the last generation, until it is applied or discarded.

Declaration

public string Output { get; }

Property Value

OutputTemplatelinkLink to this section

Gets or sets the template that renders the output instead of markdown.

Declaration

public RenderFragment<string> OutputTemplate { get; set; }

Property Value

PlaceholderlinkLink to this section

Gets or sets the placeholder of the prompt input.

Declaration

public string Placeholder { get; set; }

Property Value

ReplaceSelectionTextlinkLink to this section

Gets or sets the text of the replace button when a selection is replaced. Default is "Replace selection".

Declaration

public string ReplaceSelectionText { get; set; }

Property Value

ReplaceTextlinkLink to this section

Gets or sets the text of the button that replaces the value with the output. Default is "Replace".

Declaration

public string ReplaceText { get; set; }

Property Value

ShadelinkLink to this section

Gets or sets the shade of the button.

Declaration

public Shade Shade { get; set; }

Property Value

ShowButtonlinkLink to this section

Gets or sets whether the button that opens the popup is rendered. Set to false and call ElementReference) to open the popup from your own trigger. Default is true.

Declaration

public bool ShowButton { get; set; }

Property Value

SizelinkLink to this section

Gets or sets the size of the button. Default is Small.

Declaration

public ButtonSize Size { get; set; }

Property Value

SuggestionslinkLink to this section

Gets or sets the prompts offered as buttons, for example "Fix grammar" or "Make it shorter".

Declaration

public IEnumerable<string> Suggestions { get; set; }

Property Value

SystemPromptlinkLink to this section

Gets or sets the system prompt. The default asks the model to return only the resulting text without explanations or markdown.

Declaration

public string SystemPrompt { get; set; }

Property Value

TargetIdlinkLink to this section

Gets or sets the id of the input or textarea the assistant works on. When set, the text selected in it when the popup opens is used as context and replaced by the result; without a selection, or without a target, the whole Value is used.

Declaration

public string TargetId { get; set; }

Property Value

TemperaturelinkLink to this section

Gets or sets the sampling temperature.

Declaration

public double? Temperature { get; set; }

Property Value

TextlinkLink to this section

Gets or sets the text of the button. The button shows only the icon when not set.

Declaration

public string Text { get; set; }

Property Value

TitlelinkLink to this section

Gets or sets the title of the button and the accessible name of the popup. Default is "AI assistant".

Declaration

public string Title { get; set; }

Property Value

ValuelinkLink to this section

Gets or sets the text of the field the assistant works on.

Declaration

public string Value { get; set; }

Property Value

ValueChangedlinkLink to this section

Gets or sets the callback invoked when the assistant changes the value.

Declaration

public EventCallback<string> ValueChanged { get; set; }

Property Value

VariantlinkLink to this section

Gets or sets the variant of the button. Default is Text.

Declaration

public Variant Variant { get; set; }

Property Value

BuildRenderTreelinkLink to this section

Declaration

protected override void BuildRenderTree(Rendering.RenderTreeBuilder __builder)

Parameters

CloseAsynclinkLink to this section

Closes the popup.

Declaration

public Task CloseAsync()

Returns

GetComponentCssClasslinkLink to this section

Declaration

protected override string GetComponentCssClass()

Returns

OpenAsynclinkLink to this section

Opens the popup anchored to the button, or to the component itself when ShowButton is false.

Declaration

public Task OpenAsync()

Returns

OpenAsynclinkLink to this section

Opens the popup anchored to the button, or to the component itself when ShowButton is false.

Declaration

public Task OpenAsync(ElementReference anchor)

Parameters

Returns