Skip to content

Add Reason property to FunctionApprovalResponseContent for custom rejection messages #7140

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

Open
Copilot wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Add Reason property to FunctionApprovalResponseContent for custom rejection messages #7140

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
e881684
Initial plan
Copilot Dec 12, 2025
06be14f
Add Reason property to FunctionApprovalResponseContent and use it for…
Copilot Dec 12, 2025
7c2dfec
Update PR description with final status
Copilot Dec 12, 2025
32345c8
Remove build artifact nuget.exe
Copilot Dec 12, 2025
b35185b
Address PR review feedback: simplify docs and improve rejection messa…
Copilot Dec 12, 2025
72b1087
Add serialization and edge case tests for Reason property
Copilot Dec 12, 2025
c0990be
Merge branch 'main' into copilot/add-reject-message-support
stephentoub Dec 17, 2025
fb45994
Add optional reason parameter to FunctionApprovalRequestContent.Creat…
Copilot Dec 17, 2025
92bfbdb
Add API compatibility suppressions for CreateResponse method signatur…
Copilot Dec 17, 2025
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
11 changes: 11 additions & 0 deletions ...ibraries/Microsoft.Extensions.AI.Abstractions/Contents/FunctionApprovalResponseContent.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,15 @@ public FunctionApprovalResponseContent(string id, bool approved, FunctionCallCon
/// Gets the function call for which approval was requested.
/// </summary>
public FunctionCallContent FunctionCall { get; }

/// <summary>
/// Gets or sets the reason for the approval or rejection.
/// </summary>
/// <remarks>
/// When <see cref="Approved"/> is <see langword="false"/>, this can be used to provide
/// a custom rejection message. If not set, a default rejection message will be used.
/// When <see cref="Approved"/> is <see langword="true"/>, this may be used for logging,
/// tracing, or other informational purposes.
/// </remarks>
public string? Reason { get; set; }
}
6 changes: 5 additions & 1 deletion src/Libraries/Microsoft.Extensions.AI/ChatCompletion/FunctionInvokingChatClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1418,7 +1418,11 @@ private static (List<ApprovalResultWithRequestMessage>? approvals, List<Approval
/// <returns>The <see cref="AIContent"/> for the rejected function calls.</returns>
private static List<AIContent>? GenerateRejectedFunctionResults(List<ApprovalResultWithRequestMessage>? rejections) =>
rejections is { Count: > 0 } ?
rejections.ConvertAll(static m => (AIContent)new FunctionResultContent(m.Response.FunctionCall.CallId, "Error: Tool call invocation was rejected by user.")) :
rejections.ConvertAll(m =>
{
string result = m.Response.Reason ?? "Error: Tool call invocation was rejected by user.";
return (AIContent)new FunctionResultContent(m.Response.FunctionCall.CallId, result);
}) :
null;

/// <summary>
Expand Down
156 changes: 156 additions & 0 deletions .../Microsoft.Extensions.AI.Tests/ChatCompletion/FunctionInvokingChatClientApprovalsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,162 @@ public async Task MixedApprovedAndRejectedApprovalResponsesAreExecutedAndFailedA
await InvokeAndAssertStreamingAsync(options, input, downstreamClientOutput, streamingOutput, expectedDownstreamClientInput);
}

[Fact]
public async Task RejectedApprovalResponsesWithCustomReasonAsync()
{
var options = new ChatOptions
{
Tools =
[
new ApprovalRequiredAIFunction(AIFunctionFactory.Create(() => "Result 1", "Func1")),
AIFunctionFactory.Create((int i) => $"Result 2: {i}", "Func2"),
]
};

List<ChatMessage> input =
[
new ChatMessage(ChatRole.User, "hello"),
new ChatMessage(ChatRole.Assistant,
[
new FunctionApprovalRequestContent("callId1", new FunctionCallContent("callId1", "Func1")),
new FunctionApprovalRequestContent("callId2", new FunctionCallContent("callId2", "Func2", arguments: new Dictionary<string, object?> { { "i", 42 } }))
]) { MessageId = "resp1" },
new ChatMessage(ChatRole.User,
[
new FunctionApprovalResponseContent("callId1", false, new FunctionCallContent("callId1", "Func1"))
{
Reason = "User denied permission for this operation"
},
new FunctionApprovalResponseContent("callId2", false, new FunctionCallContent("callId2", "Func2", arguments: new Dictionary<string, object?> { { "i", 42 } }))
{
Reason = "Function Func2 is not allowed at this time"
}
]),
];

List<ChatMessage> expectedDownstreamClientInput =
[
new ChatMessage(ChatRole.User, "hello"),
new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId1", "Func1"), new FunctionCallContent("callId2", "Func2", arguments: new Dictionary<string, object?> { { "i", 42 } })]),
new ChatMessage(ChatRole.Tool,
[
new FunctionResultContent("callId1", result: "User denied permission for this operation"),
new FunctionResultContent("callId2", result: "Function Func2 is not allowed at this time")
]),
];

List<ChatMessage> downstreamClientOutput =
[
new ChatMessage(ChatRole.Assistant, "world"),
];

List<ChatMessage> output =
[
new ChatMessage(ChatRole.Assistant, [new FunctionCallContent("callId1", "Func1"), new FunctionCallContent("callId2", "Func2", arguments: new Dictionary<string, object?> { { "i", 42 } })]),
new ChatMessage(ChatRole.Tool,
[
new FunctionResultContent("callId1", result: "User denied permission for this operation"),
new FunctionResultContent("callId2", result: "Function Func2 is not allowed at this time")
]),
new ChatMessage(ChatRole.Assistant, "world"),
];

await InvokeAndAssertAsync(options, input, downstreamClientOutput, output, expectedDownstreamClientInput);

await InvokeAndAssertStreamingAsync(options, input, downstreamClientOutput, output, expectedDownstreamClientInput);
}

[Fact]
public async Task MixedApprovalResponsesWithCustomAndDefaultReasonsAsync()
{
var options = new ChatOptions
{
Tools =
[
new ApprovalRequiredAIFunction(AIFunctionFactory.Create(() => "Result 1", "Func1")),
AIFunctionFactory.Create((int i) => $"Result 2: {i}", "Func2"),
AIFunctionFactory.Create((string s) => $"Result 3: {s}", "Func3"),
]
};

List<ChatMessage> input =
[
new ChatMessage(ChatRole.User, "hello"),
new ChatMessage(ChatRole.Assistant,
[
new FunctionApprovalRequestContent("callId1", new FunctionCallContent("callId1", "Func1")),
new FunctionApprovalRequestContent("callId2", new FunctionCallContent("callId2", "Func2", arguments: new Dictionary<string, object?> { { "i", 42 } })),
new FunctionApprovalRequestContent("callId3", new FunctionCallContent("callId3", "Func3", arguments: new Dictionary<string, object?> { { "s", "test" } }))
]) { MessageId = "resp1" },
new ChatMessage(ChatRole.User,
[
new FunctionApprovalResponseContent("callId1", false, new FunctionCallContent("callId1", "Func1")) { Reason = "Custom rejection for Func1" },
new FunctionApprovalResponseContent("callId2", false, new FunctionCallContent("callId2", "Func2", arguments: new Dictionary<string, object?> { { "i", 42 } })),
new FunctionApprovalResponseContent("callId3", true, new FunctionCallContent("callId3", "Func3", arguments: new Dictionary<string, object?> { { "s", "test" } }))
]),
];

List<ChatMessage> expectedDownstreamClientInput =
[
new ChatMessage(ChatRole.User, "hello"),
new ChatMessage(ChatRole.Assistant,
[
new FunctionCallContent("callId1", "Func1"),
new FunctionCallContent("callId2", "Func2", arguments: new Dictionary<string, object?> { { "i", 42 } }),
new FunctionCallContent("callId3", "Func3", arguments: new Dictionary<string, object?> { { "s", "test" } })
]),
new ChatMessage(ChatRole.Tool,
[
new FunctionResultContent("callId1", result: "Custom rejection for Func1"),
new FunctionResultContent("callId2", result: "Error: Tool call invocation was rejected by user.")
]),
new ChatMessage(ChatRole.Tool, [new FunctionResultContent("callId3", result: "Result 3: test")]),
];

List<ChatMessage> downstreamClientOutput =
[
new ChatMessage(ChatRole.Assistant, "world"),
];

List<ChatMessage> nonStreamingOutput =
[
new ChatMessage(ChatRole.Assistant,
[
new FunctionCallContent("callId1", "Func1"),
new FunctionCallContent("callId2", "Func2", arguments: new Dictionary<string, object?> { { "i", 42 } }),
new FunctionCallContent("callId3", "Func3", arguments: new Dictionary<string, object?> { { "s", "test" } })
]),
new ChatMessage(ChatRole.Tool,
[
new FunctionResultContent("callId1", result: "Custom rejection for Func1"),
new FunctionResultContent("callId2", result: "Error: Tool call invocation was rejected by user.")
]),
new ChatMessage(ChatRole.Tool, [new FunctionResultContent("callId3", result: "Result 3: test")]),
new ChatMessage(ChatRole.Assistant, "world"),
];

List<ChatMessage> streamingOutput =
[
new ChatMessage(ChatRole.Assistant,
[
new FunctionCallContent("callId1", "Func1"),
new FunctionCallContent("callId2", "Func2", arguments: new Dictionary<string, object?> { { "i", 42 } }),
new FunctionCallContent("callId3", "Func3", arguments: new Dictionary<string, object?> { { "s", "test" } })
]),
new ChatMessage(ChatRole.Tool,
[
new FunctionResultContent("callId1", result: "Custom rejection for Func1"),
new FunctionResultContent("callId2", result: "Error: Tool call invocation was rejected by user."),
new FunctionResultContent("callId3", result: "Result 3: test")
]),
new ChatMessage(ChatRole.Assistant, "world"),
];

await InvokeAndAssertAsync(options, input, downstreamClientOutput, nonStreamingOutput, expectedDownstreamClientInput);

await InvokeAndAssertStreamingAsync(options, input, downstreamClientOutput, streamingOutput, expectedDownstreamClientInput);
}

[Fact]
public async Task ApprovedInputsAreExecutedAndFunctionResultsAreConvertedAsync()
{
Expand Down
Loading