Back to all docs
API Reference / Kendo.Mvc.UI.Fluent / AIPromptBuilder
New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

AIPromptBuilder

Class

Defines the fluent API for configuring the Kendo AIPrompt for ASP.NET MVC.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:
C#
public class AIPromptBuilder : WidgetBuilderBase<AIPrompt, AIPromptBuilder>, IHtmlString

Inheritance: objectWidgetBuilderBase<AIPrompt, AIPromptBuilder>AIPromptBuilder

Implements: IHtmlString

Inherited Members WidgetBuilderBase<AIPrompt, AIPromptBuilder>.ToComponent()WidgetBuilderBase<AIPrompt, AIPromptBuilder>.Name(string)WidgetBuilderBase<AIPrompt, AIPromptBuilder>.Deferred(bool)WidgetBuilderBase<AIPrompt, AIPromptBuilder>.ModelMetadata(ModelMetadata)WidgetBuilderBase<AIPrompt, AIPromptBuilder>.HtmlAttributes(object)WidgetBuilderBase<AIPrompt, AIPromptBuilder>.HtmlAttributes(IDictionary<string, object>)WidgetBuilderBase<AIPrompt, AIPromptBuilder>.AsModule(bool)WidgetBuilderBase<AIPrompt, AIPromptBuilder>.Render()WidgetBuilderBase<AIPrompt, AIPromptBuilder>.ScriptAttributes(object, bool)WidgetBuilderBase<AIPrompt, AIPromptBuilder>.ScriptAttributes(IDictionary<string, object>, bool)WidgetBuilderBase<AIPrompt, AIPromptBuilder>.ToHtmlString()WidgetBuilderBase<AIPrompt, AIPromptBuilder>.ToClientTemplate()WidgetBuilderBase<AIPrompt, AIPromptBuilder>.ToString()WidgetBuilderBase<AIPrompt, AIPromptBuilder>.Componentobject.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

AIPromptBuilder(AIPrompt)

Initializes a new instance of the AIPrompt class.

C#
public AIPromptBuilder(AIPrompt component)
Parameters:componentAIPrompt

The component.

Methods

ActiveView(object)

Specifies the index of the active view or the name of the view.

C#
public AIPromptBuilder ActiveView(object value)
Parameters:valueobject

The value that configures the activeview.

Returns:

AIPromptBuilder

EncodedPromptOutputs(bool)

Specifies whether the prompt outputs are HTML-encoded before being displayed in the output view. When set to true (default), the output is encoded and displayed as plain text, preventing any HTML formatting or scripts from being rendered.

C#
public AIPromptBuilder EncodedPromptOutputs(bool value)
Parameters:valuebool

The value that configures the encodedpromptoutputs.

Returns:

AIPromptBuilder

Events(Action<AIPromptEventBuilder>)

Configures the client-side events.

C#
public AIPromptBuilder Events(Action<AIPromptEventBuilder> configurator)
Parameters:configuratorAction<AIPromptEventBuilder>

The client events action.

Returns:

AIPromptBuilder

Example:
C#
@(Html.Kendo().AIPrompt()
.Name("AIPrompt")
.Events(events =&gt; events
.CommandExecute("onCommandExecute")
)
)

Messages(Action<AIPromptMessagesSettingsBuilder>)

The text messages displayed in the component. Use this option to customize or localize the messages.

C#
public AIPromptBuilder Messages(Action<AIPromptMessagesSettingsBuilder> configurator)
Parameters:configuratorAction<AIPromptMessagesSettingsBuilder>

The action that configures the messages.

Returns:

AIPromptBuilder

OutputActions(Action<AIPromptOutputActionFactory>)

An array of action configurations for the output cards. Can contain strings for built-in actions or objects with custom action properties.Built-in actions: - "copy" - Copy output content to clipboard. - "retry" - Retry generating the output. - "discard" - Clears the output content and closes the popup.Custom actions trigger the outputAction event with the action command and output data.

C#
public AIPromptBuilder OutputActions(Action<AIPromptOutputActionFactory> configurator)
Parameters:configuratorAction<AIPromptOutputActionFactory>

The AIPromptOutputActionFactory for the outputactions setting.

Returns:

AIPromptBuilder

Returns the current instance of AIPromptBuilder .

OutputTemplate(string)

A template function for customizing the display of output content. This function is called when an output has finished streaming and final content needs to be rendered.The function receives an object with output (the output data) and content (the output text) properties and should return HTML string.

C#
public AIPromptBuilder OutputTemplate(string value)
Parameters:valuestring

The value that configures the outputtemplate.

Returns:

AIPromptBuilder

OutputTemplate<TModel>(TemplateBuilder<TModel>)

A template function for customizing the display of output content. This function is called when an output has finished streaming and final content needs to be rendered.The function receives an object with output (the output data) and content (the output text) properties and should return HTML string.

C#
public AIPromptBuilder OutputTemplate<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the outputtemplate.

Returns:

AIPromptBuilder

OutputTemplateHandler(string)

A template function for customizing the display of output content. This function is called when an output has finished streaming and final content needs to be rendered.The function receives an object with output (the output data) and content (the output text) properties and should return HTML string.

C#
public AIPromptBuilder OutputTemplateHandler(string value)
Parameters:valuestring

The value that configures the outputtemplate.

Returns:

AIPromptBuilder

OutputTemplateId(string)

A template function for customizing the display of output content. This function is called when an output has finished streaming and final content needs to be rendered.The function receives an object with output (the output data) and content (the output text) properties and should return HTML string.

C#
public AIPromptBuilder OutputTemplateId(string value)
Parameters:valuestring

The value that configures the outputtemplate.

Returns:

AIPromptBuilder

OutputTemplateView(MvcHtmlString)

A template function for customizing the display of output content. This function is called when an output has finished streaming and final content needs to be rendered.The function receives an object with output (the output data) and content (the output text) properties and should return HTML string.

C#
public AIPromptBuilder OutputTemplateView(MvcHtmlString value)
Parameters:valueMvcHtmlString

The value that configures the outputtemplate.

Returns:

AIPromptBuilder

PromptOutputs(Action<AIPromptPromptOutputFactory>)

An array of prompt outputs to display in the prompt view.

C#
public AIPromptBuilder PromptOutputs(Action<AIPromptPromptOutputFactory> configurator)
Parameters:configuratorAction<AIPromptPromptOutputFactory>

The action that configures the promptoutputs.

Returns:

AIPromptBuilder

PromptSuggestionItemTemplate(string)

The template of the prompt suggestion item. It can be a string, a function or a Kendo Template.

C#
public AIPromptBuilder PromptSuggestionItemTemplate(string value)
Parameters:valuestring

The value that configures the promptsuggestionitemtemplate.

Returns:

AIPromptBuilder

PromptSuggestionItemTemplate<TModel>(TemplateBuilder<TModel>)

The template of the prompt suggestion item. It can be a string, a function or a Kendo Template.

C#
public AIPromptBuilder PromptSuggestionItemTemplate<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the promptsuggestionitemtemplate.

Returns:

AIPromptBuilder

PromptSuggestionItemTemplateHandler(string)

The template of the prompt suggestion item. It can be a string, a function or a Kendo Template.

C#
public AIPromptBuilder PromptSuggestionItemTemplateHandler(string value)
Parameters:valuestring

The value that configures the promptsuggestionitemtemplate.

Returns:

AIPromptBuilder

PromptSuggestionItemTemplateId(string)

The template of the prompt suggestion item. It can be a string, a function or a Kendo Template.

C#
public AIPromptBuilder PromptSuggestionItemTemplateId(string value)
Parameters:valuestring

The value that configures the promptsuggestionitemtemplate.

Returns:

AIPromptBuilder

PromptSuggestionItemTemplateView(MvcHtmlString)

The template of the prompt suggestion item. It can be a string, a function or a Kendo Template.

C#
public AIPromptBuilder PromptSuggestionItemTemplateView(MvcHtmlString value)
Parameters:valueMvcHtmlString

The value that configures the promptsuggestionitemtemplate.

Returns:

AIPromptBuilder

PromptSuggestions(ICollection<string>)

Sets the PromptSuggestions collection

C#
public AIPromptBuilder PromptSuggestions(ICollection<string> value)
Parameters:valueICollection<string>

The collection

Returns:

AIPromptBuilder

PromptSuggestions(string)

Adds a suggestion to the PromptSuggestions collection.

C#
public AIPromptBuilder PromptSuggestions(string value)
Parameters:valuestring

The suggestion

Returns:

AIPromptBuilder

PromptTextArea(Action<AIPromptPromptTextAreaSettingsBuilder>)

Configuration options for the Kendo UI TextArea component used in the prompt view. Only specific properties from the Kendo UI TextArea are supported.

C#
public AIPromptBuilder PromptTextArea(Action<AIPromptPromptTextAreaSettingsBuilder> configurator)
Parameters:configuratorAction<AIPromptPromptTextAreaSettingsBuilder>

The action that configures the prompttextarea.

Returns:

AIPromptBuilder

Service(Action<AIPromptServiceSettingsBuilder>)

The URL of the AI service to use for generating outputs.

C#
public AIPromptBuilder Service(Action<AIPromptServiceSettingsBuilder> configurator)
Parameters:configuratorAction<AIPromptServiceSettingsBuilder>

The action that configures the service.

Returns:

AIPromptBuilder

Service(string, string, object)

Specifies the URL of the AI service to use for generating outputs.

C#
public AIPromptBuilder Service(string actionName, string controllerName, object routeValues)
Parameters:actionNamestring

The name of tha action.

controllerNamestring

The name of the controller.

routeValuesobject

The route values.

Returns:

AIPromptBuilder

Service(string, string, RouteValueDictionary)

Specifies the URL of the AI service to use for generating outputs.

C#
public AIPromptBuilder Service(string actionName, string controllerName, RouteValueDictionary routeValues)
Parameters:actionNamestring

The name of tha action.

controllerNamestring

The name of the controller.

routeValuesRouteValueDictionary

The route values.

Returns:

AIPromptBuilder

Service(string, string)

Specifies the URL of the AI service to use for generating outputs.

C#
public AIPromptBuilder Service(string actionName, string controllerName)
Parameters:actionNamestring

The name of the action.

controllerNamestring

The name of the controller.

Returns:

AIPromptBuilder

Service(string)

Specifies the URL of the AI service to use for generating outputs.

C#
public AIPromptBuilder Service(string value)
Parameters:valuestring

The url.

Returns:

AIPromptBuilder

ShowOutputRating(bool)

Specifies if the output rating should be displayed on the output card. > Note: This property is deprecated. Use the outputActions configuration instead.

C#
[Obsolete("This option is obsolete since Q3 2025 and will be removed in future releases")]
public AIPromptBuilder ShowOutputRating(bool value)
Parameters:valuebool

The value that configures the showoutputrating.

Returns:

AIPromptBuilder

ShowOutputSubtitleTooltip()

Controls whether the subtitle of the card in the output view displays a tooltip containing the full content of the subtitle, which is the prompt used to generate the output.

C#
public AIPromptBuilder ShowOutputSubtitleTooltip()
Returns:

AIPromptBuilder

ShowOutputSubtitleTooltip(bool)

Controls whether the subtitle of the card in the output view displays a tooltip containing the full content of the subtitle, which is the prompt used to generate the output.

C#
public AIPromptBuilder ShowOutputSubtitleTooltip(bool value)
Parameters:valuebool

The value that configures the showoutputsubtitletooltip.

Returns:

AIPromptBuilder

SpeechToText()

Configures speech-to-text functionality for the prompt input. When true, enables speech-to-text with default settings. When false, disables the feature. When an object, configures custom speech-to-text options.

C#
public AIPromptBuilder SpeechToText()
Returns:

AIPromptBuilder

SpeechToText(Action<AIPromptSpeechToTextSettingsBuilder>)

Configures speech-to-text functionality for the prompt input. When true, enables speech-to-text with default settings. When false, disables the feature. When an object, configures custom speech-to-text options.

C#
public AIPromptBuilder SpeechToText(Action<AIPromptSpeechToTextSettingsBuilder> configurator)
Parameters:configuratorAction<AIPromptSpeechToTextSettingsBuilder>

The action that configures the speechtotext.

Returns:

AIPromptBuilder

SpeechToText(bool)

Configures speech-to-text functionality for the prompt input. When true, enables speech-to-text with default settings. When false, disables the feature. When an object, configures custom speech-to-text options.

C#
public AIPromptBuilder SpeechToText(bool enabled)
Parameters:enabledbool

Enables or disables the speechtotext option.

Returns:

AIPromptBuilder

ToolbarItems(Action<AIPromptToolbarItemFactory>)

An array of toolbar items to display in the header Toolbar. They will be rendered after the items generated from the configurations of the views.

C#
public AIPromptBuilder ToolbarItems(Action<AIPromptToolbarItemFactory> configurator)
Parameters:configuratorAction<AIPromptToolbarItemFactory>

The action that configures the toolbaritems.

Returns:

AIPromptBuilder

Views(Action<AIPromptViewFactory>)

An array of view configurations.

C#
public AIPromptBuilder Views(Action<AIPromptViewFactory> configurator)
Parameters:configuratorAction<AIPromptViewFactory>

The action that configures the views.

Returns:

AIPromptBuilder

In this article
DefinitionConstructorsAIPromptBuilder(AIPrompt)MethodsActiveView(object)EncodedPromptOutputs(bool)Events(Action<AIPromptEventBuilder>)Messages(Action<AIPromptMessagesSettingsBuilder>)OutputActions(Action<AIPromptOutputActionFactory>)OutputTemplate(string)OutputTemplate<TModel>(TemplateBuilder<TModel>)OutputTemplateHandler(string)OutputTemplateId(string)OutputTemplateView(MvcHtmlString)PromptOutputs(Action<AIPromptPromptOutputFactory>)PromptSuggestionItemTemplate(string)PromptSuggestionItemTemplate<TModel>(TemplateBuilder<TModel>)PromptSuggestionItemTemplateHandler(string)PromptSuggestionItemTemplateId(string)PromptSuggestionItemTemplateView(MvcHtmlString)PromptSuggestions(ICollection<string>)PromptSuggestions(string)PromptTextArea(Action<AIPromptPromptTextAreaSettingsBuilder>)Service(Action<AIPromptServiceSettingsBuilder>)Service(string, string, object)Service(string, string, RouteValueDictionary)Service(string, string)Service(string)ShowOutputRating(bool)ShowOutputSubtitleTooltip()ShowOutputSubtitleTooltip(bool)SpeechToText()SpeechToText(Action<AIPromptSpeechToTextSettingsBuilder>)SpeechToText(bool)ToolbarItems(Action<AIPromptToolbarItemFactory>)Views(Action<AIPromptViewFactory>)
Not finding the help you need?
Contact Support