Skip to content

Latest commit

 

History

History
 
 

45.state-management

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
deploymentTemplates
deploymentTemplates
 
 
src
src
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
pom.xml
pom.xml
 
 

README.md

Save user and conversation data

This bot has been created using Bot Framework.

This sample demonstrates how to save user and conversation data in a bot. The bot maintains conversation state to track and direct the conversation and ask the user questions. The bot maintains user state to track the user's answers.

By default this bot uses MemoryStorage for Conversation and User state. Memory Storage is great for testing purposes, but in a production scenario you will need to use persistent storage.

Application.java contains commented examples of using Azure Blob Storage or Cosmos DB instead.

This sample is a Spring Boot app and uses the Azure CLI and azure-webapp Maven plugin to deploy to Azure.

Azure Blob Storage

To use Azure Blob Storage, create a Blob Storage account in your Azure subscription. You can then use the following code to create your storage layer, passing in your Blob Storage connection string and a blob container name.

Note: You do not need to create the container manually, the bot will create the container for you if it does not exist.

return new BlobsStorage("<blob-storage-connection-string>", "bot-state");

CosmosDB Storage

To use CosmosDB Storage, you need to create a CosmosDB instance in your Azure subscription. You can then use the following code to create your storage layer.

Note: It is your responsibility to create an appropriate database within your CosmosDB instance. However, you should not create the container within the database, as the bot will do this for you and ensure the container is configured correctly.

CosmosDbPartitionedStorageOptions options = new CosmosDbPartitionedStorageOptions();
options.setCosmosDbEndpoint("<endpoint-for-your-cosmosdb-instance>");
options.setAuthKey("<your-cosmosdb-auth-key>");
options.setDatabaseId("<your-database-id>");
options.setContainerId("<cosmosdb-container-id>");
return new CosmosDbPartitionedStorage(options);

Prerequisites

  • Java 1.8+
  • Install Maven
  • An account on Azure if you want to deploy to Azure.

To try this sample

  • From the root of this project folder:
    • Build the sample using mvn package
    • Run it by using java -jar .\target\bot-statemanagement-sample.jar

Testing the bot using Bot Framework Emulator

Bot Framework Emulator is a desktop application that allows bot developers to test and debug their bots on localhost or running remotely through a tunnel.

  • Install the latest Bot Framework Emulator from here

Connect to the bot using Bot Framework Emulator

  • Launch Bot Framework Emulator
  • File -> Open Bot
  • Enter a Bot URL of http://localhost:3978/api/messages

Deploy the bot to Azure

To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.

Bot State

A key to good bot design is to track the context of a conversation, so that your bot remembers things like the answers to previous questions. Depending on what your bot is used for, you may even need to keep track of state or store information for longer than the lifetime of the conversation. A bots state is information it remembers in order to respond appropriately to incoming messages. The Bot Builder SDK provides classes for storing and retrieving state data as an object associated with a user or a conversation.

Further reading