/// <summary>
/// Initializes a new instance of the <see cref="PictureBot"/> class.
/// </summary>
/// <param name="accessors">A class containing <see cref="IStatePropertyAccessor{T}"/> used to manage state.</param>
/// <param name="loggerFactory">A <see cref="ILoggerFactory"/> that is hooked to the Azure App Service provider.</param>
/// <seealso cref="https://docs.microsoft.com/en-us/aspnet/core/fundamentals/logging/?view=aspnetcore-2.1#windows-eventlog-provider"/>
public PictureBot(PictureBotAccessors accessors, ILoggerFactory loggerFactory)
{
if (loggerFactory == null)
{
throw new System.ArgumentNullException(nameof(loggerFactory));
}
_logger = loggerFactory.CreateLogger <PictureBot>();
_logger.LogTrace("EchoBot turn start.");
_accessors = accessors ?? throw new System.ArgumentNullException(nameof(accessors));
}
/// <summary>
/// Initializes a new instance of the <see cref="PictureBot"/> class.
/// </summary>
/// <param name="accessors">A class containing <see cref="IStatePropertyAccessor{T}"/> used to manage state.</param>
/// <param name="loggerFactory">A <see cref="ILoggerFactory"/> that is hooked to the Azure App Service provider.</param>
/// <seealso cref="https://docs.microsoft.com/en-us/aspnet/core/fundamentals/logging/?view=aspnetcore-2.1#windows-eventlog-provider"/>
public PictureBot(PictureBotAccessors accessors, ILoggerFactory loggerFactory, BotServices services)
{
_services = services ?? throw new System.ArgumentNullException(nameof(services));
// Make sure we have our required LUIS models
if (!_services.LuisServices.ContainsKey(LuisPictureBot))
{
throw new System.ArgumentException($"Invalid configuration. Please check your '.bot' file for a LUIS service named '{LuisPictureBot}'.");
}
if (loggerFactory == null)
{
throw new System.ArgumentNullException(nameof(loggerFactory));
}
_logger = loggerFactory.CreateLogger <PictureBot>();
_logger.LogTrace("PictureBot turn start.");
_accessors = accessors ?? throw new System.ArgumentNullException(nameof(accessors));
// The DialogSet needs a DialogState accessor, it will call it when it has a turn context.
_dialogs = new DialogSet(_accessors.DialogStateAccessor);
// This array defines how the Waterfall will execute.
// We can define the different dialogs and their steps here
// allowing for overlap as needed. In this case, it's fairly simple
// but in more complex scenarios, you may want to separate out the different
// dialogs into different files.
var main_waterfallsteps = new WaterfallStep[]
{
GreetingAsync,
MainMenuAsync,
};
var search_waterfallsteps = new WaterfallStep[]
{
// Add SearchDialog water fall steps
SearchRequestAsync,
SearchAsync
};
// Add named dialogs to the DialogSet. These names are saved in the dialog state.
_dialogs.Add(new WaterfallDialog("mainDialog", main_waterfallsteps));
_dialogs.Add(new WaterfallDialog("searchDialog", search_waterfallsteps));
// The following line allows us to use a prompt within the dialogs
_dialogs.Add(new TextPrompt("searchPrompt"));
}
/// <summary>
/// Initializes a new instance of the <see cref="PictureBot"/> class.
/// </summary>
/// <param name="accessors">A class containing <see cref="IStatePropertyAccessor{T}"/> used to manage state.</param>
/// <param name="loggerFactory">A <see cref="ILoggerFactory"/> that is hooked to the Azure App Service provider.</param>
/// <seealso cref="https://docs.microsoft.com/en-us/aspnet/core/fundamentals/logging/?view=aspnetcore-2.1#windows-eventlog-provider"/>
public PictureBot(PictureBotAccessors accessors, ILoggerFactory loggerFactory, LuisRecognizer recognizer)
{
if (loggerFactory == null)
{
throw new System.ArgumentNullException(nameof(loggerFactory));
}
// Lab 2.2.3 Add instance of LUIS Recognizer
_recognizer = recognizer ?? throw new ArgumentNullException(nameof(recognizer));
_logger = loggerFactory.CreateLogger <PictureBot>();
_logger.LogTrace("PictureBot turn start.");
_accessors = accessors ?? throw new System.ArgumentNullException(nameof(accessors));
// The DialogSet needs a DialogState accessor, it will call it when it has a turn context.
_dialogs = new DialogSet(_accessors.DialogStateAccessor);
// This array defines how the Waterfall will execute.
// We can define the different dialogs and their steps here
// allowing for overlap as needed. In this case, it's fairly simple
// but in more complex scenarios, you may want to separate out the different
// dialogs into different files.
var main_waterfallsteps = new WaterfallStep[]
{
GreetingAsync,
MainMenuAsync,
};
var search_waterfallsteps = new WaterfallStep[]
{
// Add SearchDialog water fall steps
SearchRequestAsync,
SearchAsync,
SearchBingAsync
};
// Add named dialogs to the DialogSet. These names are saved in the dialog state.
_dialogs.Add(new WaterfallDialog("mainDialog", main_waterfallsteps));
_dialogs.Add(new WaterfallDialog("searchDialog", search_waterfallsteps));
// The following line allows us to use a prompt within the dialogs
_dialogs.Add(new TextPrompt("searchPrompt"));
_dialogs.Add(new ChoicePrompt("bingPrompt"));
}
/// <summary>
/// Initializes a new instance of the <see cref="PictureBot"/> class.
/// </summary>
/// <param name="accessors">A class containing <see cref="IStatePropertyAccessor{T}"/> used to manage state.</param>
/// <param name="loggerFactory">A <see cref="ILoggerFactory"/> that is hooked to the Azure App Service provider.</param>
/// <seealso cref="https://docs.microsoft.com/en-us/aspnet/core/fundamentals/logging/?view=aspnetcore-2.1#windows-eventlog-provider"/>
public PictureBot(PictureBotAccessors accessors, LuisRecognizer luisRecognizer, ILogger <PictureBot> logger)
{
//On each turn, we receive an active instance of PictureBotAccessors, LuisRecognizer, and the logger
//via dependency injection. We must also recreate the DialogSet on each turn.
//Assign all the private variables to match the injected values
//---YOUR CODE HERE---
//Create a new DialogSet based on the DialogStateAccessor of the PictureBotAccessors
//---YOUR CODE HERE---
//Add new waterfall dialogs for our "main" and "search" dialogs
//---YOUR CODE HERE---
//Add prompts as well. Bot.Builder comes with several out of the box,
//including TextPrompt and ConfirmPrompt
//---YOUR CODE HERE---
}
/// <summary>
/// Initializes a new instance of the <see cref="PictureBot"/> class.
/// </summary>
/// <param name="accessors">A class containing <see cref="IStatePropertyAccessor{T}"/> used to manage state.</param>
/// <param name="loggerFactory">A <see cref="ILoggerFactory"/> that is hooked to the Azure App Service provider.</param>
/// <seealso cref="https://docs.microsoft.com/en-us/aspnet/core/fundamentals/logging/?view=aspnetcore-2.1#windows-eventlog-provider"/>
public PictureBot(PictureBotAccessors accessors, LuisRecognizer luisRecognizer, ILogger <PictureBot> logger)
{
//On each turn, we receive an active instance of PictureBotAccessors, LuisRecognizer, and the logger
//via dependency injection. We must also recreate the DialogSet on each turn.
//Assign all the private variables to match the injected values
_logger = logger;
_logger.LogTrace("PizzaBot turn start.");
_accessors = accessors;
_luisRecognizer = luisRecognizer;
//Create a new DialogSet based on the DialogStateAccessor of the PictureBotAccessors
_dialogs = new DialogSet(_accessors.DialogStateAccessor);
//Add new waterfall dialogs for our "main" and "search" dialogs
var mainDialogSteps = new WaterfallStep[]
{
GreetingAsync,
MainMenuAsync
};
var searchDialogSteps = new WaterfallStep[]
{
SearchRequestAsync,
SearchAsync,
SearchBingAsync
};
_dialogs.Add(new WaterfallDialog(MAIN_DIALOG, mainDialogSteps));
_dialogs.Add(new WaterfallDialog(SEARCH_DIALOG, searchDialogSteps));
//Add prompts as well. Bot.Builder comes with several out of the box,
//including TextPrompt and ConfirmPrompt
_dialogs.Add(new TextPrompt(SEARCH_PROMPT));
_dialogs.Add(new ConfirmPrompt(BING_PROMPT));
}
/// <summary>
/// This method gets called by the runtime. Use this method to add services to the container.
/// </summary>
/// <param name="services">The <see cref="IServiceCollection"/> specifies the contract for a collection of service descriptors.</param>
/// <seealso cref="IStatePropertyAccessor{T}"/>
/// <seealso cref="https://docs.microsoft.com/en-us/aspnet/web-api/overview/advanced/dependency-injection"/>
/// <seealso cref="https://docs.microsoft.com/en-us/azure/bot-service/bot-service-manage-channels?view=azure-bot-service-4.0"/>
public void ConfigureServices(IServiceCollection services)
{
var secretKey = Configuration.GetSection("botFileSecret")?.Value;
var botFilePath = Configuration.GetSection("botFilePath")?.Value;
// Add botConfiguration singleton
// See https://aka.ms/about-bot-file to learn more about .bot file its use and bot configuration.
var botConfig = BotConfiguration.Load(botFilePath ?? @".\BotConfiguration.bot", secretKey);
services.AddSingleton(sp => botConfig ?? throw new InvalidOperationException($"The .bot config file could not be loaded. ({botConfig})"));
// Add BotServices singleton.
// Create the connected services from .bot file.
services.AddSingleton(sp => new BotServices(botConfig));
// The Memory Storage used here is for local bot debugging only. When the bot
// is restarted, everything stored in memory will be gone.
IStorage dataStore = new MemoryStorage();
// For production bots use the Azure Blob or
// Azure CosmosDB storage providers. For the Azure
// based storage providers, add the Microsoft.Bot.Builder.Azure
// Nuget package to your solution. That package is found at:
// https://www.nuget.org/packages/Microsoft.Bot.Builder.Azure/
// Uncomment the following lines to use Azure Blob Storage
// //Storage configuration name or ID from the .bot file.
// const string StorageConfigurationId = "<STORAGE-NAME-OR-ID-FROM-BOT-FILE>";
// var blobConfig = botConfig.FindServiceByNameOrId(StorageConfigurationId);
// if (!(blobConfig is BlobStorageService blobStorageConfig))
// {
// throw new InvalidOperationException($"The .bot file does not contain an blob storage with name '{StorageConfigurationId}'.");
// }
// // Default container name.
// const string DefaultBotContainer = "botstate";
// var storageContainer = string.IsNullOrWhiteSpace(blobStorageConfig.Container) ? DefaultBotContainer : blobStorageConfig.Container;
// IStorage dataStore = new Microsoft.Bot.Builder.Azure.AzureBlobStorage(blobStorageConfig.ConnectionString, storageContainer);
// Create Conversation State object.
// The Conversation State object is where we persist anything at the conversation-scope.
////var conversationState = new ConversationState(dataStore);
////options.State.Add(conversationState);
services.AddSingleton(dataStore);
var userState = new UserState(dataStore);
var conversationState = new ConversationState(dataStore);
services.AddSingleton(userState);
services.AddSingleton(conversationState);
// The BotStateSet enables read() and write() in parallel on multiple BotState instances.
services.AddSingleton(new BotStateSet(userState, conversationState));
services.AddBot <PictureBot>(options =>
{
// Retrieve current endpoint.
var environment = _isProduction ? "production" : "development";
var service = botConfig.Services.Where(s => s.Type == "endpoint" && s.Name == environment).FirstOrDefault();
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);
// Creates a logger for the application to use.
ILogger logger = _loggerFactory.CreateLogger <PictureBot>();
// Catches any errors that occur during a conversation turn and logs them.
options.OnTurnError = async(context, exception) =>
{
logger.LogError($"Exception caught : {exception}");
await context.SendActivityAsync("Sorry, it looks like something went wrong.");
};
var middleware = options.Middleware;
// Add middleware below with "middleware.Add(...."
// Typing Middleware (automatically shows typing when the bot is responding/working)
options.Middleware.Add(new ShowTypingMiddleware());
// Add Regex below
middleware.Add(new RegExpRecognizerMiddleware()
.AddIntent("search", new Regex("search picture(?:s)*(.*)|search pic(?:s)*(.*)", RegexOptions.IgnoreCase))
.AddIntent("share", new Regex("share picture(?:s)*(.*)|share pic(?:s)*(.*)", RegexOptions.IgnoreCase))
.AddIntent("order", new Regex("order picture(?:s)*(.*)|order print(?:s)*(.*)|order pic(?:s)*(.*)", RegexOptions.IgnoreCase))
.AddIntent("help", new Regex("help(.*)", RegexOptions.IgnoreCase)));
});
// Create and register state accesssors.
// Acessors created here are passed into the IBot-derived class on every turn.
services.AddSingleton <PictureBotAccessors>(sp =>
{
// Create the custom state accessor.
// State accessors enable other components to read and write individual properties of state.
var accessors = new PictureBotAccessors(conversationState)
{
PictureState = conversationState.CreateProperty <PictureState>(PictureBotAccessors.PictureStateName),
DialogStateAccessor = conversationState.CreateProperty <DialogState>("DialogState"),
};
return(accessors);
});
}
/// <summary>
/// This method gets called by the runtime. Use this method to add services to the container.
/// </summary>
/// <param name="services">The <see cref="IServiceCollection"/> specifies the contract for a collection of service descriptors.</param>
/// <seealso cref="IStatePropertyAccessor{T}"/>
/// <seealso cref="https://docs.microsoft.com/en-us/aspnet/web-api/overview/advanced/dependency-injection"/>
/// <seealso cref="https://docs.microsoft.com/en-us/azure/bot-service/bot-service-manage-channels?view=azure-bot-service-4.0"/>
public void ConfigureServices(IServiceCollection services)
{
services.AddBot <PictureBot>(options =>
{
var secretKey = Configuration.GetSection("botFileSecret")?.Value;
var botFilePath = Configuration.GetSection("botFilePath")?.Value;
// Loads .bot configuration file and adds a singleton that your Bot can access through dependency injection.
var botConfig = BotConfiguration.Load(botFilePath ?? @".\BotConfiguration.bot", secretKey);
services.AddSingleton(sp => botConfig ?? throw new InvalidOperationException($"The .bot config file could not be loaded. ({botConfig})"));
// Retrieve current endpoint.
var environment = _isProduction ? "production" : "development";
var service = botConfig.Services.Where(s => s.Type == "endpoint" && s.Name == environment).FirstOrDefault();
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);
// Creates a logger for the application to use.
ILogger logger = _loggerFactory.CreateLogger <PictureBot>();
// Catches any errors that occur during a conversation turn and logs them.
options.OnTurnError = async(context, exception) =>
{
logger.LogError($"Exception caught : {exception}");
await context.SendActivityAsync("Sorry, it looks like something went wrong.");
};
// The Memory Storage used here is for local bot debugging only. When the bot
// is restarted, everything stored in memory will be gone.
IStorage dataStore = new MemoryStorage();
// For production bots use the Azure Blob or
// Azure CosmosDB storage providers. For the Azure
// based storage providers, add the Microsoft.Bot.Builder.Azure
// Nuget package to your solution. That package is found at:
// https://www.nuget.org/packages/Microsoft.Bot.Builder.Azure/
// Uncomment the following lines to use Azure Blob Storage
// //Storage configuration name or ID from the .bot file.
// const string StorageConfigurationId = "<STORAGE-NAME-OR-ID-FROM-BOT-FILE>";
// var blobConfig = botConfig.FindServiceByNameOrId(StorageConfigurationId);
// if (!(blobConfig is BlobStorageService blobStorageConfig))
// {
// throw new InvalidOperationException($"The .bot file does not contain an blob storage with name '{StorageConfigurationId}'.");
// }
// // Default container name.
// const string DefaultBotContainer = "botstate";
// var storageContainer = string.IsNullOrWhiteSpace(blobStorageConfig.Container) ? DefaultBotContainer : blobStorageConfig.Container;
// IStorage dataStore = new Microsoft.Bot.Builder.Azure.AzureBlobStorage(blobStorageConfig.ConnectionString, storageContainer);
// Create Conversation State object.
// The Conversation State object is where we persist anything at the conversation-scope.
var conversationState = new ConversationState(dataStore);
options.State.Add(conversationState);
var middleware = options.Middleware;
// Add middleware below with "middleware.Add(...."
// Add Regex below
middleware.Add(new RegExpRecognizerMiddleware()
.AddIntent("search", new Regex("search picture(?:s)*(.*)|search pic(?:s)*(.*)", RegexOptions.IgnoreCase))
.AddIntent("share", new Regex("share picture(?:s)*(.*)|share pic(?:s)*(.*)", RegexOptions.IgnoreCase))
.AddIntent("order", new Regex("order picture(?:s)*(.*)|order print(?:s)*(.*)|order pic(?:s)*(.*)", RegexOptions.IgnoreCase))
.AddIntent("help", new Regex("help(.*)", RegexOptions.IgnoreCase)));
});
// Create and register state accesssors.
// Acessors created here are passed into the IBot-derived class on every turn.
services.AddSingleton <PictureBotAccessors>(sp =>
{
var options = sp.GetRequiredService <IOptions <BotFrameworkOptions> >().Value;
if (options == null)
{
throw new InvalidOperationException("BotFrameworkOptions must be configured prior to setting up the state accessors");
}
var conversationState = options.State.OfType <ConversationState>().FirstOrDefault();
if (conversationState == null)
{
throw new InvalidOperationException("ConversationState must be defined and added before adding conversation-scoped state accessors.");
}
// Create the custom state accessor.
// State accessors enable other components to read and write individual properties of state.
var accessors = new PictureBotAccessors(conversationState)
{
PictureState = conversationState.CreateProperty <PictureState>(PictureBotAccessors.PictureStateName),
DialogStateAccessor = conversationState.CreateProperty <DialogState>("DialogState"),
};
return(accessors);
});
// Create and register a LUIS recognizer.
services.AddSingleton(sp =>
{
// Get LUIS information
var luisApp = new LuisApplication("LuisAppId",
"LuisSubscriptionKey",
"LuisEndpoint");
// Specify LUIS options. These may vary for your bot.
var luisPredictionOptions = new LuisPredictionOptions
{
IncludeAllIntents = true,
};
// Create the recognizer
var recognizer = new LuisRecognizer(luisApp, luisPredictionOptions, true, null);
return(recognizer);
});
}
/// <summary>
/// This method gets called by the runtime. Use this method to add services to the container.
/// </summary>
/// <param name="services">The <see cref="IServiceCollection"/> specifies the contract for a collection of service descriptors.</param>
/// <seealso cref="IStatePropertyAccessor{T}"/>
/// <seealso cref="https://docs.microsoft.com/en-us/aspnet/web-api/overview/advanced/dependency-injection"/>
/// <seealso cref="https://docs.microsoft.com/en-us/azure/bot-service/bot-service-manage-channels?view=azure-bot-service-4.0"/>
public void ConfigureServices(IServiceCollection services)
{
//The original example couples much of bot init into a single anonymous method,
//but here it is split up for readability and to resolve race conditions
//Retrieve the secretKey and botFilePath from the app configuration
var secretKey = Configuration.GetSection("botFileSecret")?.Value;
var botFilePath = Configuration.GetSection("botFilePath")?.Value;
//Use BotConfiguration.Load to create an instance of BotConfiguration
//based on the file path. Use as a default.
//(Optional) - Throw an Exception if this is null
//(Optional) - Add this to the services container as a singleton
var botConfig = BotConfiguration.Load(botFilePath ?? @".\BotConfiguration.bot", secretKey)
?? throw new InvalidOperationException("Error reading bot file. Please ensure you have valid botFilePath and botFileSecret set for your environment.");
services.AddSingleton(botConfig);
//Use the AddBot<T> extension to IServiceCollection to inject both
//your bot and BotFrameworkOptions into the services collection
services.AddBot <PictureBot>(options =>
{
//Retrieve the endpoint for the given environment
//You can use "FindServiceByNameOrId" and cast to EndpointService
//(optional) - Throw an exception if it cannot be found
var environment = _isProduction ? "production" : "development";
var endpointService = botConfig.FindServiceByNameOrId(environment) as EndpointService
?? throw new InvalidOperationException($"The .bot file does not contain an endpoint with name '{environment}'.");
//Add a SimpleCredentialProvider to the options.
//This is important for setting up the route that intercepts bot traffic
options.CredentialProvider = new SimpleCredentialProvider(endpointService.AppId, endpointService.AppPassword);
//Set up the datastore to hold conversation state data.
//We will use a MemoryStorage for this example, but production apps
//should always leverage Azure Blob or CosmosDB storage providers.
//(Or roll your own!)
IStorage dataStore = new MemoryStorage();
//Create the conversation state based on the datastore
//and add it to the options.
var conversationState = new ConversationState(dataStore);
options.State.Add(conversationState);
//Add the RegExpRecognizer as middleware.
//Note that this is not included in the Microsoft.Bot.Builder libraries;
//instead, it is part of this source distribution!
var middleware = options.Middleware;
middleware.Add(new RegExpRecognizerMiddleware()
.AddIntent("SearchPics", new Regex("search picture(?:s)*(.*)|search pic(?:s)*(.*)", RegexOptions.IgnoreCase))
.AddIntent("Share", new Regex("share picture(?:s)*(.*)|share pic(?:s)*(.*)", RegexOptions.IgnoreCase))
.AddIntent("Order", new Regex("order picture(?:s)*(.*)|order print(?:s)*(.*)|order pic(?:s)*(.*)", RegexOptions.IgnoreCase))
.AddIntent("Help", new Regex("help(.*)", RegexOptions.IgnoreCase)));
//Since we have external dependencies, something is bound to go wrong!
//Setup a callback for OnTurnError to log errors and/or send data to the user
options.OnTurnError = async(context, exception) =>
{
_loggerFactory.CreateLogger <PictureBot>().LogError(exception, $"Uncaught exception in bot!");
await context.SendActivityAsync($"Sorry, it looks like something went wrong. Exception: {exception.Message}");
};
});
// Create and register state accesssors.
// Acessors created here are passed into the IBot-derived class on every turn.
services.AddSingleton <PictureBotAccessors>(sp =>
{
//Retrieve the IOptions<BotFrameworkOptions> from the IServiceProvider
//(It's added via AddBot!)
var options = sp.GetRequiredService <IOptions <BotFrameworkOptions> >().Value;
if (options == null)
{
throw new InvalidOperationException("BotFrameworkOptions must be configured prior to setting up the state accessors");
}
//Retrieve the ConversationState.It is the first state "OfType<ConversationState>()"
var conversationState = options.State.OfType <ConversationState>().FirstOrDefault();
if (conversationState == null)
{
throw new InvalidOperationException("ConversationState must be defined and added before adding conversation-scoped state accessors.");
}
//return a new instance of PictureBotAccessors based on this conversationState.
//You will have to also add additional properties for PictureState and DialogState
//DialogState is provided by BotBuilder; PictureState is from this code base
var accessors = new PictureBotAccessors(conversationState)
{
PictureState = conversationState.CreateProperty <PictureState>(PictureBotAccessors.PictureStateName),
DialogStateAccessor = conversationState.CreateProperty <DialogState>(PictureBotAccessors.DialogStateName)
};
return(accessors);
});
//Add LUIS to the services collection
//so we can access it at any point in our bot
services.AddSingleton(sp =>
{
var appId = Configuration.GetSection("LuisAppId").Value;
var key = Configuration.GetSection("LuisKey").Value;
var endpoint = Configuration.GetSection("LuisEndpoint").Value;
//Create a new LuisApplication based on these credentials
var luisApp = new LuisApplication(appId, key, endpoint);
//Optionally you can also create LuisPredictionOptions which may vary from bot to bot
var luisPredictionOptions = new LuisPredictionOptions
{
IncludeAllIntents = true,
};
// Create and inject the recognizer
var recognizer = new LuisRecognizer(luisApp, luisPredictionOptions, true, null);
return(recognizer);
});
}
/// <summary>
/// This method gets called by the runtime. Use this method to add services to the container.
/// </summary>
/// <param name="services">The <see cref="IServiceCollection"/> specifies the contract for a collection of service descriptors.</param>
/// <seealso cref="IStatePropertyAccessor{T}"/>
/// <seealso cref="https://docs.microsoft.com/en-us/aspnet/web-api/overview/advanced/dependency-injection"/>
/// <seealso cref="https://docs.microsoft.com/en-us/azure/bot-service/bot-service-manage-channels?view=azure-bot-service-4.0"/>
public void ConfigureServices(IServiceCollection services)
{
services.AddBot <PictureBot>(options =>
{
// Creates a logger for the application to use.
ILogger logger = _loggerFactory.CreateLogger <PictureBot>();
var secretKey = Configuration.GetSection("botFileSecret")?.Value;
var botFilePath = Configuration.GetSection("botFilePath")?.Value;
// Loads .bot configuration file and adds a singleton that your Bot can access through dependency injection.
BotConfiguration botConfig = null;
try
{
botConfig = BotConfiguration.Load(botFilePath ?? @".\BotConfiguration.bot", secretKey);
}
catch
{
var msg = @"Error reading bot file. Please ensure you have valid botFilePath and botFileSecret set for your environment.
- You can find the botFilePath and botFileSecret in the Azure App Service application settings.
- If you are running this bot locally, consider adding a appsettings.json file with botFilePath and botFileSecret.
- See https://aka.ms/about-bot-file to learn more about .bot file its use and bot configuration.
";
logger.LogError(msg);
throw new InvalidOperationException(msg);
}
services.AddSingleton(sp => botConfig);
// Retrieve current endpoint.
var environment = _isProduction ? "production" : "development";
var service = botConfig.Services.Where(s => s.Type == "endpoint" && s.Name == environment).FirstOrDefault();
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);
// Catches any errors that occur during a conversation turn and logs them.
options.OnTurnError = async(context, exception) =>
{
logger.LogError($"Exception caught : {exception}");
await context.SendActivityAsync("Sorry, it looks like something went wrong.");
};
// The Memory Storage used here is for local bot debugging only. When the bot
// is restarted, everything stored in memory will be gone.
IStorage dataStore = new MemoryStorage();
// For production bots use the Azure Blob or
// Azure CosmosDB storage providers. For the Azure
// based storage providers, add the Microsoft.Bot.Builder.Azure
// Nuget package to your solution. That package is found at:
// https://www.nuget.org/packages/Microsoft.Bot.Builder.Azure/
// Uncomment the following lines to use Azure Blob Storage
// //Storage configuration name or ID from the .bot file.
// const string StorageConfigurationId = "<STORAGE-NAME-OR-ID-FROM-BOT-FILE>";
// var blobConfig = botConfig.FindServiceByNameOrId(StorageConfigurationId);
// if (!(blobConfig is BlobStorageService blobStorageConfig))
// {
// throw new InvalidOperationException($"The .bot file does not contain an blob storage with name '{StorageConfigurationId}'.");
// }
// // Default container name.
// const string DefaultBotContainer = "botstate";
// var storageContainer = string.IsNullOrWhiteSpace(blobStorageConfig.Container) ? DefaultBotContainer : blobStorageConfig.Container;
// IStorage dataStore = new Microsoft.Bot.Builder.Azure.AzureBlobStorage(blobStorageConfig.ConnectionString, storageContainer);
// Create Conversation State object.
// The Conversation State object is where we persist anything at the conversation-scope.
var conversationState = new ConversationState(dataStore);
options.State.Add(conversationState);
});
// Create and register state accesssors.
// Acessors created here are passed into the IBot-derived class on every turn.
services.AddSingleton <PictureBotAccessors>(sp =>
{
var options = sp.GetRequiredService <IOptions <BotFrameworkOptions> >().Value;
if (options == null)
{
throw new InvalidOperationException("BotFrameworkOptions must be configured prior to setting up the state accessors");
}
var conversationState = options.State.OfType <ConversationState>().FirstOrDefault();
if (conversationState == null)
{
throw new InvalidOperationException("ConversationState must be defined and added before adding conversation-scoped state accessors.");
}
// Create the custom state accessor.
// State accessors enable other components to read and write individual properties of state.
var accessors = new PictureBotAccessors(conversationState)
{
// CounterState = conversationState.CreateProperty<PictureState>(PictureBotAccessors.CounterStateName),
};
return(accessors);
});
}
