This reference guide details the attributes you can configure to affect the behavior of Zammo chatbots hosted on the webchat channel. A table is included with each property name and a description. Example code is available for each.

Additional Properties Available

The following table lists the available properties in UI Kit. Further information with code examples is available in the sections that follow after the table:

Property Description Type Default Value
stickyChat When set to true, this property indicates if the chat (session) should remain active across all the pages. By default is false, thereby resetting the chat session when the user changes pages or refreshes the browser. boolean false
ttl This time indicates how long a session should be maintained (if using sticky chat or if the user keeps the browser open). The time is in milliseconds. The default is 3600000 (1 hour). number 360000
shouldLoadDependencies UI Kit downloads its dependencies when loaded. The admin can manually import the dependencies by setting this value to false. The default is true. boolean true
shouldShowMicrophone Indicates if UI Kit should show a microphone icon when set to true for users to interact with their voice. The default is false. boolean false
shouldShowExtensionMenu Indicates if UI Kit should show an extension menu when set to true for users to interact with on the top left of the chat widget. By default, the extension menu contains a reset session icon. The default is false. boolean false
shouldAllowUserToDownloadTranscript When set to true, gives the user the option of downloading the transcript associated with the conversation. The default value is false. boolean false
shouldDisableBargeIn Indicates if UI Kit should disable the input when a user has entered or spoken a message. This functionality can be used to prevent double messages sent to the bot. The user experience can be impacted as the user may think the chatbot isn't working. boolean false
executionType Setting this value to executionType will allow the admin to control the execution flow of the UI Kit javascript widget. (for advanced users) string chatbot loads as normal
suggestedActionDirection Indicates if suggested actions are aligned in a horizontal or vertical direction. It can be set to vertical or horizontal. string vertical
shouldAllowFullScreen Indicates if users can toggle full-screen mode. Setting this to true allows the full-screen mode to be activated. boolean false
shouldAllowTypingEffect When set to true, provides a ChatGPT typing effect experience. boolean false
shouldAllowCopyToClipboard When set to true, allows users to copy messages to the clipboard. boolean false
typeSpeed Indicates the speed at which typing is displayed. number 20
shouldAllowLeaveFeedback When set to true, triggers a feedback option to users at the end of every string of bot responses boolean false
shouldShowAdditionalFeedback When using the shouldAllowLeaveFeedback property, by default the feedback interaction will trigger a modal to gather additional raw feedback from a user. Optionally, you can use this value to tell the system not to trigger the raw feedback modal. boolean true
shouldAllowReferences When set to true, allows users to inspect which sources or reference documents were used as part of the chatbot response. boolean false

Examples of each of the available UI Kit attributes are detailed below:

stickyChat

Indicates if the chat session should remain active across all the pages. The chat session is reset by default when the user changes pages or refreshes the browser. This functionality can be enabled by setting the property to true:

Code

<script id="ZammoBotUIKitScript" 
        src="<https://cdn.zammo.ai/zammo-bot-ui-kit/zammo-bot-ui-kit-latest.min.js>" 
        cssUrl="<https://cdn.zammo.ai/zammo-bot-ui-kit/zammo-bot-ui-kit-latest.min.css>" 
        zammoApiBaseUrl="<https://app.zammo.ai>" 
        webChatId="********-****-****-****-**********">
        stickyChat="true">
</script>f

ttl

This time indicates how long a session should be maintained (if using sticky chat or if the user keeps the browser open). The time is in milliseconds. The default value is 3600000 (1 hour).