ChatMessage Class

ChatMessagelinkLink to this section

Represents a chat message in the RadzenAIChat component.

Declaration

public ChatMessage()

AdditionalPropertieslinkLink to this section

Gets or sets additional data about the message, for example the files an answer changed or the credits it used. Streaming responses collect the AdditionalProperties of their updates here; render them with MessageFooterTemplate or UsageTemplate.

Declaration

public Microsoft.Extensions.AI.AdditionalPropertiesDictionary AdditionalProperties { get; set; }

Property Value

AttachmentslinkLink to this section

Gets or sets the files attached to the message.

Declaration

public List<ChatAttachment> Attachments { get; set; }

Property Value

CitationslinkLink to this section

Gets or sets the sources the answer is based on: citations the provider attached to the response and citations returned by tools.

Declaration

public List<ChatCitation> Citations { get; set; }

Property Value

ContentlinkLink to this section

Gets or sets the content of the message.

Declaration

public string Content { get; set; }

Property Value

IdlinkLink to this section

Gets or sets the unique identifier for the message.

Declaration

public string Id { get; set; }

Property Value

IsStreaminglinkLink to this section

Gets or sets whether this message is currently streaming.

Declaration

public bool IsStreaming { get; set; }

Property Value

IsUserlinkLink to this section

Gets or sets whether this message is from the user.

Declaration

public bool IsUser { get; set; }

Property Value

KindlinkLink to this section

Gets or sets the kind of the message. Default is Message; the other kinds are entries the application adds with ChatMessage).

Declaration

public ChatMessageKind Kind { get; set; }

Property Value

ReasoninglinkLink to this section

Gets or sets the reasoning the model produced before answering, when the model exposes it.

Declaration

public string Reasoning { get; set; }

Property Value

RolelinkLink to this section

Gets or sets the role associated with the message (e.g., "user", "assistant").

Declaration

public string Role { get; set; }

Property Value

TimestamplinkLink to this section

Gets or sets the timestamp when the message was created.

Declaration

public DateTime Timestamp { get; set; }

Property Value

ToolCallslinkLink to this section

Gets or sets the tool calls the assistant made while producing this message.

Declaration

public List<ChatToolCall> ToolCalls { get; set; }

Property Value

UsagelinkLink to this section

Gets or sets the token usage reported by the model for this response, when the provider reports it.

Declaration

public Microsoft.Extensions.AI.UsageDetails Usage { get; set; }

Property Value

UserIdlinkLink to this section

Gets or sets the ID of the user who sent the message.

Declaration

public string UserId { get; set; }

Property Value

GetPartslinkLink to this section

Splits the message into its parts in the order the assistant produced them: the text written before a tool call, the call, the text written after it. Tool calls are placed by TextPosition; calls with the same position keep their order in ToolCalls. Empty text is skipped. Each text part is rendered as Markdown on its own, so a call that falls inside a list or a code block splits that block in two.

Declaration

public IReadOnlyList<ChatMessagePart> GetParts()

Returns

MergeAdditionalPropertieslinkLink to this section

Merges additional data into AdditionalProperties.

Declaration

public void MergeAdditionalProperties(Microsoft.Extensions.AI.AdditionalPropertiesDictionary properties)

Parameters