mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
dd1e615dad
* .NET: Add A2AAgentOptions and align A2AAgent constructors with ChatClientAgent pattern Adds a new A2AAgentOptions class (Id, Name, Description, Clone) and an options-based constructor on A2AAgent, mirroring ChatClientAgent/ChatClientAgentOptions. The existing parameter-based constructor is preserved for backward compatibility and now delegates to the options-based one. Extension methods are extended with options-based overloads: - A2AClientExtensions.AsAIAgent(IA2AClient, A2AAgentOptions, ...) - A2AAgentCardExtensions.AsAIAgent(AgentCard, A2AAgentOptions, ...) - A2ACardResolverExtensions.GetAIAgentAsync(A2ACardResolver, A2AAgentOptions, ...) For card-based creation, user-supplied options override values from the agent card; Name and Description fall back to card values when not set. Options are cloned when stored on the agent to prevent post-construction mutation, matching the ChatClientAgent pattern. Resolves #5870. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Address PR review comments - Add Throw.IfNull(client) in A2AClientExtensions.AsAIAgent - Add Throw.IfNull(card) in A2AAgentCardExtensions.AsAIAgent - Clarify httpClient docs in A2ACardResolverExtensions.GetAIAgentAsync: it applies to the created A2A client, not to card discovery - Rename test methods from GetAIAgent_* to AsAIAgent_* to match the API under test Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
88 lines
4.7 KiB
C#
88 lines
4.7 KiB
C#
// Copyright (c) Microsoft. All rights reserved.
|
|
|
|
using System.Net.Http;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using Microsoft.Agents.AI;
|
|
using Microsoft.Agents.AI.A2A;
|
|
using Microsoft.Extensions.Logging;
|
|
using Microsoft.Shared.Diagnostics;
|
|
|
|
namespace A2A;
|
|
|
|
/// <summary>
|
|
/// Provides extension methods for <see cref="A2ACardResolver"/>
|
|
/// to simplify the creation of A2A agents.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// These extensions bridge the gap between A2A SDK client objects
|
|
/// and the Microsoft Agent Framework.
|
|
/// <para>
|
|
/// They allow developers to easily create AI agents that can interact
|
|
/// with A2A agents by handling the conversion from A2A clients to
|
|
/// <see cref="A2AAgent"/> instances that implement the <see cref="AIAgent"/> interface.
|
|
/// </para>
|
|
/// </remarks>
|
|
public static class A2ACardResolverExtensions
|
|
{
|
|
/// <summary>
|
|
/// Retrieves an instance of <see cref="AIAgent"/> for an existing A2A agent.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// This method can be used to access A2A agents that support the
|
|
/// <see href="https://github.com/a2aproject/A2A/blob/main/docs/topics/agent-discovery.md#1-well-known-uri">Well-Known URI</see>
|
|
/// discovery mechanism.
|
|
/// </remarks>
|
|
/// <param name="resolver">The <see cref="A2ACardResolver" /> to use for the agent creation.</param>
|
|
/// <param name="httpClient">The <see cref="HttpClient"/> to use for HTTP requests.</param>
|
|
/// <param name="options">
|
|
/// Optional <see cref="A2AClientOptions"/> controlling protocol binding preference.
|
|
/// When not provided, defaults to preferring HTTP+JSON first, with JSON-RPC as fallback.
|
|
/// </param>
|
|
/// <param name="loggerFactory">The logger factory for enabling logging within the agent.</param>
|
|
/// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.</param>
|
|
/// <returns>An <see cref="AIAgent"/> instance backed by the A2A agent.</returns>
|
|
public static async Task<AIAgent> GetAIAgentAsync(this A2ACardResolver resolver, HttpClient? httpClient = null, A2AClientOptions? options = null, ILoggerFactory? loggerFactory = null, CancellationToken cancellationToken = default)
|
|
{
|
|
// Obtain the agent card from the resolver.
|
|
var agentCard = await resolver.GetAgentCardAsync(cancellationToken).ConfigureAwait(false);
|
|
|
|
return agentCard.AsAIAgent(httpClient, options, loggerFactory);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Retrieves an instance of <see cref="AIAgent"/> for an existing A2A agent.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// This method can be used to access A2A agents that support the
|
|
/// <see href="https://github.com/a2aproject/A2A/blob/main/docs/topics/agent-discovery.md#1-well-known-uri">Well-Known URI</see>
|
|
/// discovery mechanism. When <paramref name="agentOptions"/> is provided, any non-null values override
|
|
/// the corresponding values from the resolved <see cref="AgentCard"/>.
|
|
/// </remarks>
|
|
/// <param name="resolver">The <see cref="A2ACardResolver" /> to use for the agent creation.</param>
|
|
/// <param name="agentOptions">
|
|
/// Configuration options that control the agent's identity. When provided, non-null values override the
|
|
/// corresponding values from the resolved agent card.
|
|
/// </param>
|
|
/// <param name="httpClient">
|
|
/// The <see cref="HttpClient"/> to use for HTTP requests made by the created A2A client.
|
|
/// This is not used for fetching the agent card; the resolver uses its own configured client for that.
|
|
/// </param>
|
|
/// <param name="clientOptions">
|
|
/// Optional <see cref="A2AClientOptions"/> controlling protocol binding preference.
|
|
/// When not provided, defaults to preferring HTTP+JSON first, with JSON-RPC as fallback.
|
|
/// </param>
|
|
/// <param name="loggerFactory">The logger factory for enabling logging within the agent.</param>
|
|
/// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.</param>
|
|
/// <returns>An <see cref="AIAgent"/> instance backed by the A2A agent.</returns>
|
|
public static async Task<AIAgent> GetAIAgentAsync(this A2ACardResolver resolver, A2AAgentOptions agentOptions, HttpClient? httpClient = null, A2AClientOptions? clientOptions = null, ILoggerFactory? loggerFactory = null, CancellationToken cancellationToken = default)
|
|
{
|
|
_ = Throw.IfNull(agentOptions);
|
|
|
|
// Obtain the agent card from the resolver.
|
|
var agentCard = await resolver.GetAgentCardAsync(cancellationToken).ConfigureAwait(false);
|
|
|
|
return agentCard.AsAIAgent(agentOptions, httpClient, clientOptions, loggerFactory);
|
|
}
|
|
}
|