Files
semantic-kernel/samples/dotnet/graph-api-skills/Program.cs
T
af03e00a79 Feature serviceregistry (#993)
### Motivation, Context and Description

This PR introduces several changes aimed to simplify the kernel and
enhancing its extensibility for AI services management. The changes
include the following:

1. Kernel simplification and extensibility: The code responsible for AI
services management, such as registration and resolution, has been moved
out of the Kernel and KernelConfig classes into a new class called
AIServiceProvider. This restructuring promotes the principle of Single
Responsibility, ensuring that each class has a clear and focused
purpose.

2. Hosting apps customization: With the introduction of the
AIServiceProvider, hosting applications now have the flexibility to
provide their own implementation of the provider if needed. This
promotes extensibility, allowing the hosting apps to tailor the AI
service management according to their specific requirements.

3. AI services registration improvements: A new method called
WithAiService has been added, which enables the registration of any new
AI service that is not currently supported.

4. Improved kernel builder interface: The Add* methods for AI services
registration have been moved from the KernelConfig class to the
KernelBuilder. This change aligns the interface with other KernelBilder
methods, such as WithLogger and WithMemory, creating a more cohesive and
intuitive kernel builder interface.

---------

Co-authored-by: Shawn Callegari <[email protected]>
Co-authored-by: Lee Miller <[email protected]>
2023-05-22 15:21:48 -07:00

214 lines
9.8 KiB
C#

// Copyright (c) Microsoft. All rights reserved.
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Reflection;
using System.Threading.Tasks;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Logging;
using Microsoft.Graph;
using Microsoft.SemanticKernel;
using Microsoft.SemanticKernel.Orchestration;
using Microsoft.SemanticKernel.SkillDefinition;
using Microsoft.SemanticKernel.Skills.MsGraph;
using Microsoft.SemanticKernel.Skills.MsGraph.Connectors;
using Microsoft.SemanticKernel.Skills.MsGraph.Connectors.Client;
using Microsoft.SemanticKernel.Skills.MsGraph.Connectors.CredentialManagers;
using DayOfWeek = System.DayOfWeek;
namespace MsGraphSkillsExample;
/// <summary>
/// The static plan below is meant to emulate a plan generated from the following request:
/// "Summarize the content of cheese.txt and send me an email with the summary and a link to the file.
/// Then add a reminder to follow-up next week."
/// </summary>
public sealed class Program
{
// ReSharper disable once InconsistentNaming
public static async Task Main()
{
#region Initialization
// Load configuration
IConfigurationRoot configuration = new ConfigurationBuilder()
.AddJsonFile(path: "appsettings.json", optional: false, reloadOnChange: true)
.AddJsonFile(path: "appsettings.Development.json", optional: true, reloadOnChange: true)
.AddEnvironmentVariables()
.AddUserSecrets<Program>()
.Build();
// Initialize logger
using ILoggerFactory loggerFactory = LoggerFactory.Create(builder =>
{
builder.AddConfiguration(configuration.GetSection("Logging"))
.AddConsole()
.AddDebug();
});
ILogger<Program> logger = loggerFactory.CreateLogger<Program>();
MsGraphConfiguration? candidateGraphApiConfig = configuration.GetRequiredSection("MsGraph").Get<MsGraphConfiguration>()
?? throw new InvalidOperationException("Missing configuration for Microsoft Graph API.");
// Workaround for nested types not working IConfigurationSection.Get<T>()
// See https://github.com/dotnet/runtime/issues/77677
configuration.GetSection("MsGraph:Scopes").Bind(candidateGraphApiConfig.Scopes);
if (candidateGraphApiConfig.Scopes == null)
{
throw new InvalidOperationException("Missing Scopes configuration for Microsoft Graph API.");
}
MsGraphConfiguration graphApiConfiguration = candidateGraphApiConfig;
string? defaultCompletionServiceId = configuration["DefaultCompletionServiceId"];
if (string.IsNullOrWhiteSpace(defaultCompletionServiceId))
{
throw new InvalidOperationException("'DefaultCompletionServiceId' is not set in configuration.");
}
string? currentAssemblyDirectory = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
if (string.IsNullOrWhiteSpace(currentAssemblyDirectory))
{
throw new InvalidOperationException("Unable to determine current assembly directory.");
}
#endregion
// Initialize the Graph API client with interactive authentication and local caching.
// Note that LocalUserMSALCredentialManager is NOT safe for multi-user and cloud-service deployments.
// TODO: Include sample code credential manager for multi-user and cloud service scenario.
// TODO: the var is never used
LocalUserMSALCredentialManager credentialManager = await LocalUserMSALCredentialManager.CreateAsync();
// For more details on creating a Graph API client and choosing authentication provider see:
// https://learn.microsoft.com/graph/sdks/create-client
// https://learn.microsoft.com/graph/sdks/choose-authentication-providers
// Add authentication handler.
IList<DelegatingHandler> handlers = GraphClientFactory.CreateDefaultHandlers(
CreateAuthenticationProvider(await LocalUserMSALCredentialManager.CreateAsync(), graphApiConfiguration));
// Add logging handler to log Graph API requests and responses request IDs.
using MsGraphClientLoggingHandler loggingHandler = new(logger);
handlers.Add(loggingHandler);
// Create the Graph client.
using HttpClient httpClient = GraphClientFactory.Create(handlers);
GraphServiceClient graphServiceClient = new(httpClient);
// Initialize SK Graph API Skills we'll be using in the plan.
CloudDriveSkill oneDriveSkill = new(new OneDriveConnector(graphServiceClient), loggerFactory.CreateLogger<CloudDriveSkill>());
TaskListSkill todoSkill = new(new MicrosoftToDoConnector(graphServiceClient), loggerFactory.CreateLogger<TaskListSkill>());
EmailSkill outlookSkill = new(new OutlookMailConnector(graphServiceClient), loggerFactory.CreateLogger<EmailSkill>());
// Initialize the Semantic Kernel and and register connections with OpenAI/Azure OpenAI instances.
KernelBuilder builder = Kernel.Builder
.WithLogger(loggerFactory.CreateLogger<IKernel>());
if (configuration.GetSection("AzureOpenAI:ServiceId").Value != null)
{
AzureOpenAIConfiguration? azureOpenAIConfiguration = configuration.GetSection("AzureOpenAI").Get<AzureOpenAIConfiguration>();
if (azureOpenAIConfiguration != null)
{
builder.WithAzureTextCompletionService(
deploymentName: azureOpenAIConfiguration.DeploymentName,
endpoint: azureOpenAIConfiguration.Endpoint,
apiKey: azureOpenAIConfiguration.ApiKey,
serviceId: azureOpenAIConfiguration.ServiceId,
setAsDefault: azureOpenAIConfiguration.ServiceId == defaultCompletionServiceId);
}
}
if (configuration.GetSection("OpenAI:ServiceId").Value != null)
{
OpenAIConfiguration? openAIConfiguration = configuration.GetSection("OpenAI").Get<OpenAIConfiguration>();
if (openAIConfiguration != null)
{
builder.WithOpenAITextCompletionService(
modelId: openAIConfiguration.ModelId,
apiKey: openAIConfiguration.ApiKey,
serviceId: openAIConfiguration.ServiceId,
setAsDefault: openAIConfiguration.ServiceId == defaultCompletionServiceId);
}
}
IKernel sk = builder.Build();
var onedrive = sk.ImportSkill(oneDriveSkill, "onedrive");
var todo = sk.ImportSkill(todoSkill, "todo");
var outlook = sk.ImportSkill(outlookSkill, "outlook");
string skillParentDirectory = RepoUtils.RepoFiles.SampleSkillsPath();
IDictionary<string, ISKFunction> summarizeSkills =
sk.ImportSemanticSkillFromDirectory(skillParentDirectory, "SummarizeSkill");
//
// The static plan below is meant to emulate a plan generated from the following request:
// "Summarize the content of cheese.txt and send me an email with the summary and a link to the file. Then add a reminder to follow-up next week."
//
string? pathToFile = configuration["OneDrivePathToFile"];
if (string.IsNullOrWhiteSpace(pathToFile))
{
throw new InvalidOperationException("OneDrivePathToFile is not set in configuration.");
}
// Get file content
SKContext fileContentResult = await sk.RunAsync(pathToFile,
onedrive["GetFileContentAsync"],
summarizeSkills["Summarize"]);
if (fileContentResult.ErrorOccurred)
{
throw new InvalidOperationException($"Failed to get file content: {fileContentResult.LastErrorDescription}");
}
string fileSummary = fileContentResult.Result;
// Get my email address
SKContext emailAddressResult = await sk.RunAsync(string.Empty, outlook["GetMyEmailAddressAsync"]);
string myEmailAddress = emailAddressResult.Result;
// Create a link to the file
SKContext fileLinkResult = await sk.RunAsync(pathToFile, onedrive["CreateLinkAsync"]);
string fileLink = fileLinkResult.Result;
// Send me an email with the summary and a link to the file.
ContextVariables emailMemory = new($"{fileSummary}{Environment.NewLine}{Environment.NewLine}{fileLink}");
emailMemory.Set(EmailSkill.Parameters.Recipients, myEmailAddress);
emailMemory.Set(EmailSkill.Parameters.Subject, $"Summary of {pathToFile}");
await sk.RunAsync(emailMemory, outlook["SendEmailAsync"]);
// Add a reminder to follow-up next week.
ContextVariables followUpTaskMemory = new($"Follow-up about {pathToFile}.");
DateTimeOffset nextMonday = TaskListSkill.GetNextDayOfWeek(DayOfWeek.Monday, TimeSpan.FromHours(9));
followUpTaskMemory.Set(TaskListSkill.Parameters.Reminder, nextMonday.ToString("o"));
await sk.RunAsync(followUpTaskMemory, todo["AddTaskAsync"]);
logger.LogInformation("Done!");
}
/// <summary>
/// Create a delegated authentication callback for the Graph API client.
/// </summary>
private static DelegateAuthenticationProvider CreateAuthenticationProvider(
LocalUserMSALCredentialManager credentialManager,
MsGraphConfiguration config)
=> new(
async (requestMessage) =>
{
requestMessage.Headers.Authorization = new AuthenticationHeaderValue(
scheme: "bearer",
parameter: await credentialManager.GetTokenAsync(
config.ClientId,
config.TenantId,
config.Scopes.ToArray(),
config.RedirectUri));
});
}