public MainDialog(BotServices services, BotConfiguration botConfig, ConversationState conversationState, UserState userState, EndpointService endpointService)
: base(nameof(MainDialog))
{
_services = services ?? throw new ArgumentNullException(nameof(services));
_botConfig = botConfig;
_conversationState = conversationState;
_userState = userState;
_endpointService = endpointService;
_onboardingState = _userState.CreateProperty <OnboardingState>(nameof(OnboardingState));
_parametersAccessor = _userState.CreateProperty <Dictionary <string, object> >("userInfo");
var dialogState = _conversationState.CreateProperty <DialogState>(nameof(DialogState));
AddDialog(new OnboardingDialog(_services, _onboardingState));
AddDialog(new EscalateDialog(_services));
AddDialog(new CustomSkillDialog(_services.SkillConfigurations, dialogState, endpointService));
// Initialize skill dispatcher
_skillRouter = new SkillRouter(_services.SkillDefinitions);
}
public OnboardingDialog(BotServices botServices, IStatePropertyAccessor <OnboardingState> accessor, IBotTelemetryClient telemetryClient)
: base(botServices, nameof(OnboardingDialog), telemetryClient)
{
_accessor = accessor;
InitialDialogId = nameof(OnboardingDialog);
var onboarding = new WaterfallStep[]
{
AskForName,
AskForLocation,
FinishOnboardingDialog,
};
// To capture built-in waterfall dialog telemetry, set the telemetry client
// to the new waterfall dialog and add it to the component dialog
TelemetryClient = telemetryClient;
AddDialog(new WaterfallDialog(InitialDialogId, onboarding)
{
TelemetryClient = telemetryClient
});
AddDialog(new TextPrompt(NamePrompt));
AddDialog(new TextPrompt(LocationPrompt));
}
public void ConfigureServices(IServiceCollection services)
{
// add background task queue
services.AddSingleton <IBackgroundTaskQueue, BackgroundTaskQueue>();
services.AddHostedService <QueuedHostedService>();
// Load the connected services from .bot file.
var botFilePath = Configuration.GetSection("botFilePath")?.Value;
var botFileSecret = Configuration.GetSection("botFileSecret")?.Value;
var botConfig = BotConfiguration.Load(botFilePath ?? throw new Exception("Please configure your bot file path in appsettings.json."), botFileSecret);
// Use Application Insights
services.AddBotApplicationInsights(botConfig);
// Initializes your bot service clients and adds a singleton that your Bot can access through dependency injection.
var languageModels = Configuration.GetSection("languageModels").Get <Dictionary <string, Dictionary <string, string> > >();
var skills = Configuration.GetSection("skills").Get <List <SkillDefinition> >();
List <SkillEvent> skillEvents = null;
var skillEventsConfig = Configuration.GetSection(SkillEventsConfigName);
if (skillEventsConfig != null)
{
skillEvents = skillEventsConfig.Get <List <SkillEvent> >();
}
var connectedServices = new BotServices(botConfig, languageModels, skills, skillEvents);
services.AddSingleton(sp => connectedServices);
var defaultLocale = Configuration.GetSection("defaultLocale").Get <string>();
// Initialize Bot State
var cosmosDbService = botConfig.Services.FirstOrDefault(s => s.Type == ServiceTypes.CosmosDB) ?? throw new Exception("Please configure your CosmosDb service in your .bot file.");
var cosmosDb = cosmosDbService as CosmosDbService;
var cosmosOptions = new CosmosDbStorageOptions()
{
CosmosDBEndpoint = new Uri(cosmosDb.Endpoint),
AuthKey = cosmosDb.Key,
CollectionId = cosmosDb.Collection,
DatabaseId = cosmosDb.Database,
};
var dataStore = new CosmosDbStorage(cosmosOptions);
var userState = new UserState(dataStore);
var conversationState = new ConversationState(dataStore);
var proactiveState = new ProactiveState(dataStore);
services.AddSingleton(dataStore);
services.AddSingleton(userState);
services.AddSingleton(conversationState);
services.AddSingleton(proactiveState);
services.AddSingleton(new BotStateSet(userState, conversationState));
var environment = _isProduction ? "production" : "development";
var service = botConfig.Services.FirstOrDefault(s => s.Type == ServiceTypes.Endpoint && s.Name == environment);
if (!(service is EndpointService endpointService))
{
throw new InvalidOperationException($"The .bot file does not contain an endpoint with name '{environment}'.");
}
services.AddSingleton(endpointService);
// Add the bot with options
services.AddBot <VirtualAssistant>(options =>
{
// Load the connected services from .bot file.
options.CredentialProvider = new SimpleCredentialProvider(endpointService.AppId, endpointService.AppPassword);
// Telemetry Middleware (logs activity messages in Application Insights)
var sp = services.BuildServiceProvider();
var telemetryClient = sp.GetService <IBotTelemetryClient>();
var appInsightsLogger = new TelemetryLoggerMiddleware(telemetryClient, logPersonalInformation: true);
options.Middleware.Add(appInsightsLogger);
// Catches any errors that occur during a conversation turn and logs them to AppInsights.
options.OnTurnError = async(context, exception) =>
{
CultureInfo.CurrentUICulture = new CultureInfo(context.Activity.Locale);
var responseBuilder = new MainResponses();
await responseBuilder.ReplyWith(context, MainResponses.ResponseIds.Error);
await context.SendActivityAsync(new Activity(type: ActivityTypes.Trace, text: $"Virtual Assistant Error: {exception.Message} | {exception.StackTrace}"));
telemetryClient.TrackExceptionEx(exception, context.Activity);
};
// Transcript Middleware (saves conversation history in a standard format)
var storageService = botConfig.Services.FirstOrDefault(s => s.Type == ServiceTypes.BlobStorage) ?? throw new Exception("Please configure your Azure Storage service in your .bot file.");
var blobStorage = storageService as BlobStorageService;
var transcriptStore = new AzureBlobTranscriptStore(blobStorage.ConnectionString, blobStorage.Container);
var transcriptMiddleware = new TranscriptLoggerMiddleware(transcriptStore);
options.Middleware.Add(transcriptMiddleware);
// Typing Middleware (automatically shows typing when the bot is responding/working)
options.Middleware.Add(new ShowTypingMiddleware());
options.Middleware.Add(new SetLocaleMiddleware(defaultLocale ?? "en-us"));
options.Middleware.Add(new EventDebuggerMiddleware());
options.Middleware.Add(new AutoSaveStateMiddleware(userState, conversationState));
options.Middleware.Add(new ProactiveStateMiddleware(proactiveState));
//// Translator is an optional component for scenarios when an Assistant needs to work beyond native language support
// var translatorKey = Configuration.GetValue<string>("translatorKey");
// if (!string.IsNullOrEmpty(translatorKey))
// {
// options.Middleware.Add(new TranslationMiddleware(new string[] { "en", "fr", "it", "de", "es" }, translatorKey, false));
// }
// else
// {
// throw new InvalidOperationException("Microsoft Text Translation API key is missing. Please add your translation key to the 'translatorKey' setting.");
// }
});
}
public void ConfigureServices(IServiceCollection services)
{
services.AddMvc().SetCompatibilityVersion(Microsoft.AspNetCore.Mvc.CompatibilityVersion.Version_2_2);
// add background task queue
services.AddSingleton <IBackgroundTaskQueue, BackgroundTaskQueue>();
services.AddHostedService <QueuedHostedService>();
// Load the connected services from .bot file.
var botFilePath = Configuration.GetSection("botFilePath")?.Value;
var botFileSecret = Configuration.GetSection("botFileSecret")?.Value;
var botConfig = BotConfiguration.Load(botFilePath ?? throw new Exception("Please configure your bot file path in appsettings.json."), botFileSecret);
// Use Application Insights
services.AddBotApplicationInsights(botConfig);
// Initializes your bot service clients and adds a singleton that your Bot can access through dependency injection.
var languageModels = Configuration.GetSection("languageModels").Get <Dictionary <string, Dictionary <string, string> > >();
var skills = Configuration.GetSection("skills").Get <List <SkillDefinition> >();
List <SkillEvent> skillEvents = null;
var skillEventsConfig = Configuration.GetSection(SkillEventsConfigName);
if (skillEventsConfig != null)
{
skillEvents = skillEventsConfig.Get <List <SkillEvent> >();
}
var connectedServices = new BotServices(botConfig, languageModels, skills, skillEvents);
services.AddSingleton(sp => connectedServices);
var imageAssetLocation = Configuration.GetSection("imageAssetLocation").Get <string>();
services.AddSingleton(sp => imageAssetLocation);
var defaultLocale = Configuration.GetSection("configuration").Get <string>();
var supportedLanguages = languageModels.Select(l => l.Key).ToArray();
var responseManager = new ResponseManager(
supportedLanguages,
new MainDialogResponses());
// Register bot responses for all supported languages.
services.AddSingleton(sp => responseManager);
// Initialize Bot State
var cosmosDbService = botConfig.Services.FirstOrDefault(s => s.Type == ServiceTypes.CosmosDB) ?? throw new Exception("Please configure your CosmosDb service in your .bot file.");
var cosmosDb = cosmosDbService as CosmosDbService;
var cosmosOptions = new CosmosDbStorageOptions()
{
CosmosDBEndpoint = new Uri(cosmosDb.Endpoint),
AuthKey = cosmosDb.Key,
CollectionId = cosmosDb.Collection,
DatabaseId = cosmosDb.Database,
};
var dataStore = new CosmosDbStorage(cosmosOptions);
var userState = new UserState(dataStore);
var conversationState = new ConversationState(dataStore);
var proactiveState = new ProactiveState(dataStore);
services.AddSingleton(dataStore);
services.AddSingleton(userState);
services.AddSingleton(conversationState);
services.AddSingleton(proactiveState);
services.AddSingleton(new BotStateSet(userState, conversationState));
var environment = _isProduction ? "production" : "development";
var service = botConfig.Services.FirstOrDefault(s => s.Type == ServiceTypes.Endpoint && s.Name == environment);
if (!(service is EndpointService endpointService))
{
throw new InvalidOperationException($"The .bot file does not contain an endpoint with name '{environment}'.");
}
services.AddSingleton(endpointService);
services.AddSingleton <IBot, VirtualAssistant>();
// HttpContext required for path resolution
services.AddSingleton <IHttpContextAccessor, HttpContextAccessor>();
// Add the http adapter to enable MVC style bot API
services.AddSingleton <IBotFrameworkHttpAdapter>((sp) =>
{
var credentialProvider = new SimpleCredentialProvider(endpointService.AppId, endpointService.AppPassword);
var telemetryClient = sp.GetService <IBotTelemetryClient>();
var botFrameworkHttpAdapter = new BotFrameworkHttpAdapter(credentialProvider)
{
OnTurnError = async(context, exception) =>
{
CultureInfo.CurrentUICulture = new CultureInfo(context.Activity.Locale);
var responseBuilder = new MainResponses();
await responseBuilder.ReplyWith(context, MainResponses.ResponseIds.Error);
await context.SendActivityAsync(new Activity(type: ActivityTypes.Trace, text: $"Virtual Assistant Error: {exception.Message} | {exception.StackTrace}"));
telemetryClient.TrackExceptionEx(exception, context.Activity);
}
};
// Telemetry Middleware (logs activity messages in Application Insights)
var appInsightsLogger = new TelemetryLoggerMiddleware(telemetryClient, logPersonalInformation: true);
botFrameworkHttpAdapter.Use(appInsightsLogger);
// Transcript Middleware (saves conversation history in a standard format)
var storageService = botConfig.Services.FirstOrDefault(s => s.Type == ServiceTypes.BlobStorage) ?? throw new Exception("Please configure your Azure Storage service in your .bot file.");
var blobStorage = storageService as BlobStorageService;
var transcriptStore = new AzureBlobTranscriptStore(blobStorage.ConnectionString, blobStorage.Container);
var transcriptMiddleware = new TranscriptLoggerMiddleware(transcriptStore);
botFrameworkHttpAdapter.Use(transcriptMiddleware);
// Typing Middleware (automatically shows typing when the bot is responding/working)
botFrameworkHttpAdapter.Use(new ShowTypingMiddleware());
botFrameworkHttpAdapter.Use(new SetLocaleMiddleware(defaultLocale ?? "en-us"));
botFrameworkHttpAdapter.Use(new EventDebuggerMiddleware());
botFrameworkHttpAdapter.Use(new AutoSaveStateMiddleware(userState, conversationState));
botFrameworkHttpAdapter.Use(new ProactiveStateMiddleware(proactiveState));
return(botFrameworkHttpAdapter);
});
}
public EnterpriseDialog(BotServices botServices, string dialogId, IBotTelemetryClient telemetryClient)
: base(dialogId, telemetryClient)
{
_services = botServices;
TelemetryClient = telemetryClient;
}
public void ConfigureServices(IServiceCollection services)
{
// Load the connected services from .bot file.
var botFilePath = Configuration.GetSection("botFilePath")?.Value;
var botFileSecret = Configuration.GetSection("botFileSecret")?.Value;
var botConfig = BotConfiguration.Load(botFilePath ?? @".\CustomAssistant.bot", botFileSecret);
services.AddSingleton(sp => botConfig ?? throw new InvalidOperationException($"The .bot config file could not be loaded."));
// Initializes your bot service clients and adds a singleton that your Bot can access through dependency injection.
var skills = Configuration.GetSection("skills").Get <List <SkillDefinition> >();
var connectedServices = new BotServices(botConfig, skills);
services.AddSingleton(sp => connectedServices);
var defaultLocale = Configuration.GetSection("defaultLocale").Get <string>();
// Initialize Bot State
var cosmosDbService = botConfig.Services.FirstOrDefault(s => s.Type == ServiceTypes.CosmosDB) ?? throw new Exception("Please configure your CosmosDb service in your .bot file.");
var cosmosDb = cosmosDbService as CosmosDbService;
var cosmosOptions = new CosmosDbStorageOptions()
{
CosmosDBEndpoint = new Uri(cosmosDb.Endpoint),
AuthKey = cosmosDb.Key,
CollectionId = cosmosDb.Collection,
DatabaseId = cosmosDb.Database,
};
var dataStore = new CosmosDbStorage(cosmosOptions);
var userState = new UserState(dataStore);
var conversationState = new ConversationState(dataStore);
services.AddSingleton(dataStore);
services.AddSingleton(userState);
services.AddSingleton(conversationState);
services.AddSingleton(new BotStateSet(userState, conversationState));
// Add the bot with options
services.AddBot <VirtualAssistant>(options =>
{
// Load the connected services from .bot file.
var environment = _isProduction ? "production" : "development";
var service = botConfig.Services.FirstOrDefault(s => s.Type == ServiceTypes.Endpoint && s.Name == environment);
if (!(service is EndpointService endpointService))
{
throw new InvalidOperationException($"The .bot file does not contain an endpoint with name '{environment}'.");
}
options.CredentialProvider = new SimpleCredentialProvider(endpointService.AppId, endpointService.AppPassword);
// Telemetry Middleware (logs activity messages in Application Insights)
var appInsightsService = botConfig.Services.FirstOrDefault(s => s.Type == ServiceTypes.AppInsights) ?? throw new Exception("Please configure your AppInsights connection in your .bot file.");
var instrumentationKey = (appInsightsService as AppInsightsService).InstrumentationKey;
var appInsightsLogger = new TelemetryLoggerMiddleware(instrumentationKey, logUserName: true, logOriginalMessage: true);
options.Middleware.Add(appInsightsLogger);
// Catches any errors that occur during a conversation turn and logs them to AppInsights.
options.OnTurnError = async(context, exception) =>
{
await context.SendActivityAsync("Sorry, it looks like something went wrong. Please try again.");
await context.SendActivityAsync(new Activity(type: ActivityTypes.Trace, text: $"Virtual Assistant Error: {exception.Message} | {exception.StackTrace}"));
connectedServices.TelemetryClient.TrackException(exception);
};
// Transcript Middleware (saves conversation history in a standard format)
var storageService = botConfig.Services.FirstOrDefault(s => s.Type == ServiceTypes.BlobStorage) ?? throw new Exception("Please configure your Azure Storage service in your .bot file.");
var blobStorage = storageService as BlobStorageService;
var transcriptStore = new AzureBlobTranscriptStore(blobStorage.ConnectionString, blobStorage.Container);
var transcriptMiddleware = new TranscriptLoggerMiddleware(transcriptStore);
options.Middleware.Add(transcriptMiddleware);
// Typing Middleware (automatically shows typing when the bot is responding/working)
options.Middleware.Add(new ShowTypingMiddleware());
options.Middleware.Add(new SetLocaleMiddleware(defaultLocale ?? "en"));
options.Middleware.Add(new EventDebuggerMiddleware());
options.Middleware.Add(new AutoSaveStateMiddleware(userState, conversationState));
//// Translator is an optional component for scenarios when an Assistant needs to work beyond native language support
//var translatorKey = Configuration.GetValue<string>("translatorKey");
//if (!string.IsNullOrEmpty(translatorKey))
//{
// options.Middleware.Add(new TranslationMiddleware(new string[] { "en", "fr", "it", "de", "es" }, translatorKey, false));
//}
//else
//{
// throw new InvalidOperationException("Microsoft Text Translation API key is missing. Please add your translation key to the 'translatorKey' setting.");
//}
});
}
public EnterpriseDialog(BotServices botServices, string dialogId)
: base(dialogId)
{
_services = botServices;
}
public CustomSkillDialog(BotServices botServices)
: base(nameof(CustomSkillDialog))
{
AddDialog(new SkillDialog(botServices.CosmosDbOptions, botServices.TelemetryClient));
}