Files
agent-framework/dotnet/src/Microsoft.Agents.AI.Workflows/ExternalResponse.cs
T
Jacob AlberandGitHub 6e8c7c42c8 .NET: [BREAKING] feat: Improve Agent hosting inside Workflows (#3142)
* refactor: Rename AggregateTurnMessagesExecutor

* feat: Rework Agent Hosting for Configurability and HIL support

* Adds support for selecting whether updates and/or full responses are
  emitted to events
* Adds support for HIL/FunctionCalls (including interception)
* Implements internal support for ExternalRequests from any executor
  (not just RequestPort)

* test: Add tests for new AIAgentHostExecutor functionality

* feat: Unify non-Handoff Agent Hosting

* doc: More explicit documentation for `overwrite` in RouteBuilder
2026-01-23 19:45:29 +00:00

56 lines
2.9 KiB
C#

// Copyright (c) Microsoft. All rights reserved.
using System;
using System.Diagnostics.CodeAnalysis;
using Microsoft.Agents.AI.Workflows.Checkpointing;
namespace Microsoft.Agents.AI.Workflows;
/// <summary>
/// Represents a request from an external input port.
/// </summary>
/// <param name="PortInfo">The port invoked.</param>
/// <param name="RequestId">The unique identifier of the corresponding request.</param>
/// <param name="Data">The data contained in the response.</param>
public record ExternalResponse(RequestPortInfo PortInfo, string RequestId, PortableValue Data)
{
/// <summary>
/// Attempts to retrieve the underlying data as the specified type.
/// </summary>
/// <typeparam name="TValue">The type to which the data should be cast or converted.</typeparam>
/// <returns>The data cast to the specified type, or null if the data cannot be cast to the specified type.</returns>
public TValue? DataAs<TValue>() => this.Data.As<TValue>();
/// <summary>
/// Determines whether the underlying data is of the specified type.
/// </summary>
/// <typeparam name="TValue">The type to compare with the underlying data.</typeparam>
/// <returns>true if the underlying data is of type TValue; otherwise, false.</returns>
public bool DataIs<TValue>() => this.Data.Is<TValue>();
/// <summary>
/// Determines whether the underlying data can be retrieved as the specified type.
/// </summary>
/// <typeparam name="TValue">The type to which the underlying data is to be cast if available.</typeparam>
/// <param name="value">When this method returns, contains the value of type <typeparamref name="TValue"/> if the data is
/// available and compatible.</param>
/// <returns>true if the data is present and can be cast to <typeparamref name="TValue"/>; otherwise, false.</returns>
public bool DataIs<TValue>([NotNullWhen(true)] out TValue? value) => this.Data.Is(out value);
/// <summary>
/// Attempts to retrieve the underlying data as the specified type.
/// </summary>
/// <param name="targetType">The type to which the data should be cast or converted.</param>
/// <returns>The data cast to the specified type, or null if the data cannot be cast to the specified type.</returns>
public object? DataAs(Type targetType) => this.Data.AsType(targetType);
/// <summary>
/// Attempts to retrieve the underlying data as the specified type.
/// </summary>
/// <param name="targetType">The type to which the data should be cast or converted.</param>
/// <param name="value">When this method returns <see langword="true"/>, contains the value of type
/// <paramref name="targetType"/> if the data is available and compatible.</param>
/// <returns>true if the data is present and can be cast to <paramref name="targetType"/>; otherwise, false.</returns>
public bool DataIs(Type targetType, [NotNullWhen(true)] out object? value) => this.Data.IsType(targetType, out value);
}