Bixby Developer Center

User Persistence

This sample capsule demonstrates how to persist data for multiple users across conversations by storing state information in a remote database. While the sample works with either restDB or Airtable, the principles can be applied to any remote storage service.

Download Capsule


Because you cannot submit a capsule with the example namespace, in order to test a sample capsule on a device, you must change the id in the capsule.bxb file from example to your organization's namespace before making a private submission.

For example, if your namespace is acme, change example.userDataPersistence to acme.userDataPersistence.

Database Setup

Test accounts have already been created at both restDB and Airtable to let you try the services out live. Simply update the capsule.config.modekey in file to exampleRestDB or exampleAirtable respectively.

Follow the instructions in the capsule's GitHub repository to set up your integration:

Using the Capsule

The sample capsule allows each user to manage an "army" of a single Boss concept and multiple Minion concepts. The boss and minion(s) will be persisted across conversation by storing them as user data.

The capsule's NL training matches the CRUD (create, read, update, delete) operations typical for databases.

  • Read: "summon my army"
  • Create/Update: "crown Guru as the big boss"; "enlist Kevin, Bobby and Stewart"
  • Delete: "disband my army"

Follow the capsule's README file for a more in-depth discussion.