The Close Conversation Data Operation closes Conversation Chat Bots. After this Data Operation is run, even if those messages sent through the same interface will be parsed as part of a new Conversation.
Enterprise Feature
This Data Operation requires an ENTERPRISE license. If you would like to enable this feature for your Airkit Organization, please contact your Airkit representative or contact [email protected].
Use Cases
- The user has completed what they set out to do when they began their Conversation, and their next message should start a Conversation over from the beginning.
- If you do not want to allow users to resume a Conversation once they have gone for a long enough period of time without replying, this Data Operation can be used to make sure the user will start a new Conversation rather than continue their old one.
Data Operation Properties
Conversation
Expects type text. This text should correspond to the identifier that a Conversation got assigned upon being initialized; this identifier will be stored under channels.message.conversationId in the relevant Session.
This property defines the Conversation that the Close Conversation Data Operation will end.
Run Results
By default, Airkit stores the output of this Data Operation in an auto-created variable called conversation that can then be passed into subsequent operations. The value of conversation indicates whether or not the Conversation was successfully closed.
Conversations can only be closed if the Conversation is occurring in deployment.
Unlike most Data Operations, the Close Conversation Data Operation cannot be run without referring to a deployed application. Before you can test any instance of this Data Operation, it must be able to refer to a published Conversation Chat Bot. For more on how to publish a Conversation Chat Bot, see Configuring Conversation Chat Bots.