Digital human instructions
Supported commands

6min
Custom Data
Sometimes you may need to pass your own custom data from your NLP system into your website (e.g. adding an item to the users shopping cart). Any fields you set in the instructions field will be passed on to your web page via Instructions message (build your own via SDK).
If you are using Hosted Experience, custom data will be made available via JS Events. For more detail, see Event handling﻿ .
JSON
|
{
    "instructions": {
        "customData": {
            "productId": "ABC123"
    	}
    }
}
{
    "instructions": {
        "customData": {
            "productId": "ABC123"
    	}
    }
}
﻿
﻿
Display HTML
Passes through either HTML content, or an HTML src file as a message for the client to display. If you are using Hosted Experience, this content will be rendered into the page for you automatically. For more detail, see Displaying content﻿ .
html: Allows you to pass the HTML you wish to display. Must be stringified.
src:  Allows you to instruct the client to load the referenced HTML file by absolute URL. 
JSON
|
{
    "instructions": {
        "displayHtml": {
            "html": "an html string",
            "src": "https://my-server.com/style.html"
    	}
    }
}
{
    "instructions": {
        "displayHtml": {
            "html": "an html string",
            "src": "https://my-server.com/style.html"
    	}
    }
}
﻿
﻿
Add speech-to-text hint phrase
Hint phrases describe likely responses from the user in reply. These are used to increase the accuracy of voice transcription. Values set will apply until replaced.
JSON
|
{
    "instructions": {
        "extraHintPhrases": {
            "phrases": ["wet", "rainy", "drizzle"]
        }
	}
}
{
    "instructions": {
        "extraHintPhrases": {
            "phrases": ["wet", "rainy", "drizzle"]
        }
	}
}
﻿

Personality Engine
Intructs UneeQ to use the Personality Engine to respond to the end user rather than use the response sent from the NLP.
enabled: If set true, the personality engine will respond to the user
userName:  Allows you to set the end users name. Note: Must be set on the first use of the personality engine. 
JSON
|
{
    "instructions": {
      "personalityEngine": {
        "enabled": true,
        "userName": "David"
      }
}
{
    "instructions": {
      "personalityEngine": {
        "enabled": true,
        "userName": "David"
      }
}
﻿
﻿
Behavior tags (old)
Synapse
Docs powered by
Archbee
TABLE OF CONTENTS
Custom Data
Display HTML
Add speech-to-text hint phrase
Personality Engine