Using Speech Markers in Default UI

Owned by Jon Borromeo (Deactivated)
Last updated: Mar 04, 2022 by Chitra Borker (Deactivated)

Digital DNA Studio supports the use of speech markers in the NLP conversation scripts (created in Dialogflow, Watson, etc.) that enable Conversation Engineers/Writers to control specific elements and features of the UI via commands or utterances from the user, during a conversation with the Digital Person.

The types of speech markers that you can configure in the Digital DNA Studio standard UI are described below:

Microphone and Chat Window Toggle (requires SDK12 or above)

This enables the user to tell the Digital Person to switch (ON/OFF) the Microphone or the Chat/Transcript Window during a conversation. 

Example of UI Feature Toggle - Microphone OFF

Conversation Engineers/Writers can use the “@feature” speech marker in the NLP conversation scripts that directs the Digital Person to deactivate or activate a UI feature in response to a user’s verbal request.

Example NLP conversation usage:
Sure, let me turn on your microphone. @feature(microphone, on)

Okay, @feature(microphone, off) I've turned off your microphone.

Sure, let me close the transcript @feature(transcript, off) for you.

Note: The UI Feature ON/OFF speech markers require Soul Machines SDK 12 or above.


Sample Dialogflow Intent:

Dialogflow Example Intent for UI Feature Toggle Speech Marker

Note: In IBM Watson implementations, the “@feature” speech marker in the conversation Response must be escaped with a backslash, e.g.: \@feature(microphone, on).

End session from corpus (requires SDK12 or above)

This enables the user to tell the Digital Person to end the session during a conversation without the need for manual input, e.g. using the sidebar menu to select the end session option.

When the user verbally requests to end the session, the Digital Person acknowledges and a “Goodbye” page is displayed to confirm the conversation session was ended intentionally and offers the opportunity for another conversation. This is the same page displayed when the user manually ends the session from the sidebar menu.

Conversation Engineers/Writers can use the “@close” speech marker in the NLP conversation scripts to end the session when the conversation has reached a natural conclusion.
This speech marker will end the conversation session immediately without requiring any manual input from the user.

Note: The End Session speech marker implementation requires Soul Machines SDK 12 or above.

Example NLP Conversation Usage:

Thanks, it was nice talking to you. Goodbye! @close()

Thanks. See you later! @close()

 

Sample Dialogflow Intent: