| File: Contents\FunctionApprovalResponseContent.cs | Web Access |
| Project: src\src\Libraries\Microsoft.Extensions.AI.Abstractions\Microsoft.Extensions.AI.Abstractions.csproj (Microsoft.Extensions.AI.Abstractions) |
// Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. using System; using System.Diagnostics.CodeAnalysis; using Microsoft.Shared.DiagnosticIds; using Microsoft.Shared.Diagnostics; namespace Microsoft.Extensions.AI; /// <summary> /// Represents a response to a function approval request. /// </summary> [Experimental(DiagnosticIds.Experiments.AIFunctionApprovals, UrlFormat = DiagnosticIds.UrlFormat)] public sealed class FunctionApprovalResponseContent : UserInputResponseContent { /// <summary> /// Initializes a new instance of the <see cref="FunctionApprovalResponseContent"/> class. /// </summary> /// <param name="id">The ID that uniquely identifies the function approval request/response pair.</param> /// <param name="approved"><see langword="true"/> if the function call is approved; otherwise, <see langword="false"/>.</param> /// <param name="functionCall">The function call that requires user approval.</param> /// <exception cref="ArgumentNullException"><paramref name="id"/> is <see langword="null"/>.</exception> /// <exception cref="ArgumentException"><paramref name="id"/> is empty or composed entirely of whitespace.</exception> /// <exception cref="ArgumentNullException"><paramref name="functionCall"/> is <see langword="null"/>.</exception> public FunctionApprovalResponseContent(string id, bool approved, FunctionCallContent functionCall) : base(id) { Approved = approved; FunctionCall = Throw.IfNull(functionCall); } /// <summary> /// Gets a value indicating whether the user approved the request. /// </summary> public bool Approved { get; } /// <summary> /// Gets the function call for which approval was requested. /// </summary> public FunctionCallContent FunctionCall { get; } /// <summary> /// Gets or sets the optional reason for the approval or rejection. /// </summary> public string? Reason { get; set; } }