// Copyright (c) Microsoft. All rights reserved.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Runtime.CompilerServices;
using System.Text.Json;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Agents.CopilotStudio.Client;
using Microsoft.Agents.Core.Models;
using Microsoft.Extensions.AI;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Abstractions;
using Microsoft.Shared.Diagnostics;
namespace Microsoft.Agents.AI.CopilotStudio;
///
/// Represents a Copilot Studio agent in the cloud.
///
public class CopilotStudioAgent : AIAgent
{
private readonly ILogger _logger;
///
/// The client used to interact with the Copilot Agent service.
///
public CopilotClient Client { get; }
private static readonly AIAgentMetadata s_agentMetadata = new("copilot-studio");
///
/// Initializes a new instance of the class.
///
/// A client used to interact with the Copilot Agent service.
/// Optional logger factory to use for logging.
public CopilotStudioAgent(CopilotClient client, ILoggerFactory? loggerFactory = null)
{
this.Client = client;
this._logger = (loggerFactory ?? NullLoggerFactory.Instance).CreateLogger();
}
///
protected sealed override ValueTask CreateSessionCoreAsync(CancellationToken cancellationToken = default)
=> new(new CopilotStudioAgentSession());
///
/// Get a new instance using an existing conversation id, to continue that conversation.
///
/// The conversation id to continue.
/// A new instance.
public ValueTask CreateSessionAsync(string conversationId)
=> new(new CopilotStudioAgentSession() { ConversationId = conversationId });
///
protected override ValueTask SerializeSessionCoreAsync(AgentSession session, JsonSerializerOptions? jsonSerializerOptions = null, CancellationToken cancellationToken = default)
{
Throw.IfNull(session);
if (session is not CopilotStudioAgentSession typedSession)
{
throw new InvalidOperationException("The provided session is not compatible with the agent. Only sessions created by the agent can be serialized.");
}
return new(typedSession.Serialize(jsonSerializerOptions));
}
///
protected override ValueTask DeserializeSessionCoreAsync(JsonElement serializedState, JsonSerializerOptions? jsonSerializerOptions = null, CancellationToken cancellationToken = default)
=> new(CopilotStudioAgentSession.Deserialize(serializedState, jsonSerializerOptions));
///
protected override async Task RunCoreAsync(
IEnumerable messages,
AgentSession? session = null,
AgentRunOptions? options = null,
CancellationToken cancellationToken = default)
{
Throw.IfNull(messages);
// Ensure that we have a valid session to work with.
// If the session ID is null, we need to start a new conversation and set the session ID accordingly.
session ??= await this.CreateSessionAsync(cancellationToken).ConfigureAwait(false);
if (session is not CopilotStudioAgentSession typedSession)
{
throw new InvalidOperationException("The provided session is not compatible with the agent. Only sessions created by the agent can be used.");
}
typedSession.ConversationId ??= await this.StartNewConversationAsync(cancellationToken).ConfigureAwait(false);
// Invoke the Copilot Studio agent with the provided messages.
string question = string.Join("\n", messages.Select(m => m.Text));
var responseMessages = ActivityProcessor.ProcessActivityAsync(this.Client.AskQuestionAsync(question, typedSession.ConversationId, cancellationToken), streaming: false, this._logger);
var responseMessagesList = new List();
await foreach (var message in responseMessages.ConfigureAwait(false))
{
responseMessagesList.Add(message);
}
// TODO: Review list of ChatResponse properties to ensure we set all availble values.
// Setting ResponseId and MessageId end up being particularly important for streaming consumers
// so that they can tell things like response boundaries.
return new AgentResponse(responseMessagesList)
{
AgentId = this.Id,
ResponseId = responseMessagesList.LastOrDefault()?.MessageId,
};
}
///
protected override async IAsyncEnumerable RunCoreStreamingAsync(
IEnumerable messages,
AgentSession? session = null,
AgentRunOptions? options = null,
[EnumeratorCancellation] CancellationToken cancellationToken = default)
{
Throw.IfNull(messages);
// Ensure that we have a valid session to work with.
// If the session ID is null, we need to start a new conversation and set the session ID accordingly.
session ??= await this.CreateSessionAsync(cancellationToken).ConfigureAwait(false);
if (session is not CopilotStudioAgentSession typedSession)
{
throw new InvalidOperationException("The provided session is not compatible with the agent. Only sessions created by the agent can be used.");
}
typedSession.ConversationId ??= await this.StartNewConversationAsync(cancellationToken).ConfigureAwait(false);
// Invoke the Copilot Studio agent with the provided messages.
string question = string.Join("\n", messages.Select(m => m.Text));
var responseMessages = ActivityProcessor.ProcessActivityAsync(this.Client.AskQuestionAsync(question, typedSession.ConversationId, cancellationToken), streaming: true, this._logger);
// Enumerate the response messages
await foreach (ChatMessage message in responseMessages.ConfigureAwait(false))
{
// TODO: Review list of ChatResponse properties to ensure we set all availble values.
// Setting ResponseId and MessageId end up being particularly important for streaming consumers
// so that they can tell things like response boundaries.
yield return new AgentResponseUpdate(message.Role, message.Contents)
{
AgentId = this.Id,
AdditionalProperties = message.AdditionalProperties,
AuthorName = message.AuthorName,
RawRepresentation = message.RawRepresentation,
ResponseId = message.MessageId,
MessageId = message.MessageId,
};
}
}
private async Task StartNewConversationAsync(CancellationToken cancellationToken)
{
string? conversationId = null;
await foreach (IActivity activity in this.Client.StartConversationAsync(emitStartConversationEvent: true, cancellationToken).ConfigureAwait(false))
{
if (activity.Conversation is not null)
{
conversationId = activity.Conversation.Id;
}
}
if (string.IsNullOrEmpty(conversationId))
{
throw new InvalidOperationException("Failed to start a new conversation.");
}
return conversationId!;
}
///
public override object? GetService(Type serviceType, object? serviceKey = null)
=> base.GetService(serviceType, serviceKey)
?? (serviceType == typeof(CopilotClient) ? this.Client
: serviceType == typeof(AIAgentMetadata) ? s_agentMetadata
: null);
}