AIChatControl.AppendMessageAsync(String, ChatRole, List<IAIChatMessageContextItem>) Method

Adds a message to chat history.

Namespace: DevExpress.AIIntegration.WinForms.Chat

Assembly: DevExpress.AIIntegration.WinForms.Chat.v26.1.dll

NuGet Package: DevExpress.AIIntegration.WinForms.Chat

Declaration

C#

public Task AppendMessageAsync(
    string text,
    ChatRole role,
    List<IAIChatMessageContextItem> contexts = null
)

VB.NET

Public Function AppendMessageAsync(
    text As String,
    role As ChatRole,
    contexts As List(Of IAIChatMessageContextItem) = Nothing
) As Task

Parameters

Name	Type	Description
text	String	The message text.
role	Microsoft.Extensions.AI.ChatRole	The intended purpose of the message within a chat interaction.

Optional Parameters

Name	Type	Default	Description
contexts	List<IAIChatMessageContextItem>	null	A collection of context items associated with the message.

Returns

Type	Description
Task	A task that represents the asynchronous operation.

Remarks

Call the AppendMessageAsync method to add messages to the chat history without sending a request to the AI service. This approach is useful for system prompts, assistant hints, and supplemental context.

Example

The following example adds a system instruction before the control sends the user message:

C#

using DevExpress.AIIntegration.Blazor.Chat.WebView;
using Microsoft.Extensions.AI;

public Chat() {
    InitializeComponent();
    aiChatControl1.MessageSending += AiChatControl1_MessageSending;
}

async void AiChatControl1_MessageSending(object sender, AIChatControlMessageSendingEventArgs e) {
    await e.Chat.AppendMessageAsync("Translate text to Spanish", ChatRole.System);
}

VB.NET

Imports DevExpress.AIIntegration.Blazor.Chat.WebView
Imports Microsoft.Extensions.AI

Public Sub New()
    InitializeComponent()
    AddHandler aiChatControl1.MessageSending, AddressOf AiChatControl1_MessageSending
End Sub

Private Async Sub AiChatControl1_MessageSending(sender As Object, e As AIChatControlMessageSendingEventArgs)
    Await e.Chat.AppendMessageAsync("Translate text to Spanish", ChatRole.System)
End Sub

Refer to the following help topic for additional information: AI Chat Control