Skip to content

Skip messages that have no text when rendering conversations as part of evaluation prompts #6349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 30, 2025
+16 −5
Merged

Skip messages that have no text when rendering conversations as part of evaluation prompts #6349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions src/Libraries/Microsoft.Extensions.AI.Evaluation/ChatMessageExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,9 @@ conversationHistory[lastMessageIndex] is ChatMessage lastMessage &&
/// <remarks>
/// <para>
/// This function only considers the <see cref="ChatMessage.Text"/> and ignores any <see cref="AIContent"/>s
/// present within the <see cref="ChatMessage.Contents"/> of the <paramref name="message"/> that are not
/// <see cref="TextContent"/>s.
/// (present within the <see cref="ChatMessage.Contents"/> of the <paramref name="message"/>) that are not
/// <see cref="TextContent"/>s. If the <paramref name="message"/> does not contain any <see cref="TextContent"/>s
/// then this function returns an empty string.
/// </para>
/// <para>
/// The returned string is prefixed with the <see cref="ChatMessage.Role"/> and
Expand All @@ -112,6 +113,12 @@ public static string RenderText(this ChatMessage message)
{
_ = Throw.IfNull(message);

if (!message.Contents.OfType<TextContent>().Any())
{
// Don't render messages (such as messages with role ChatRole.Tool) that don't contain any textual content.
return string.Empty;
}

string? author = message.AuthorName;
string role = message.Role.Value;
string? content = message.Text;
Expand All @@ -129,8 +136,10 @@ public static string RenderText(this ChatMessage message)
/// <remarks>
/// <para>
/// This function only considers the <see cref="ChatMessage.Text"/> and ignores any <see cref="AIContent"/>s
/// present within the <see cref="ChatMessage.Contents"/> of the <paramref name="messages"/> that are not
/// <see cref="TextContent"/>s.
/// (present within the <see cref="ChatMessage.Contents"/> of the <paramref name="messages"/>) that are not
/// <see cref="TextContent"/>s. Any <paramref name="messages"/> that contain no <see cref="TextContent"/>s will be
/// skipped and will not be rendered. If none of the <paramref name="messages"/> include any
/// <see cref="TextContent"/>s then this function will return an empty string.
/// </para>
/// <para>
/// The rendered <paramref name="messages"/> are each prefixed with the <see cref="ChatMessage.Role"/> and
Expand Down
4 changes: 3 additions & 1 deletion src/Libraries/Microsoft.Extensions.AI.Evaluation/ChatResponseExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ public static class ChatResponseExtensions
/// <para>
/// This function only considers the <see cref="ChatResponse.Text"/> and ignores any <see cref="AIContent"/>s
/// (present within the <see cref="ChatMessage.Contents"/> of the <see cref="ChatResponse.Messages"/>) that are not
/// <see cref="TextContent"/>s.
/// <see cref="TextContent"/>s. Any <see cref="ChatResponse.Messages"/> that contain no <see cref="TextContent"/>s
/// will be skipped and will not be rendered. If none of the <see cref="ChatResponse.Messages"/> include any
/// <see cref="TextContent"/>s then this function will return an empty string.
/// </para>
/// <para>
/// The rendered <see cref="ChatResponse.Messages"/> are each prefixed with the <see cref="ChatMessage.Role"/> and
Expand Down
Loading