Configure the conversational search module for your SmartHub pages

Overview

The Conversational Search module allows you to integrate a Conversational Bot in a SmartHub or external web page. The conversational search module supports three types of integrations:

SinglePage: This integration runs standalone in a SmartHub page, taking up entire page.
Assistant: This integration is added to a results page and is rendered on the side panel. The user has the ability to manually collapse and expand the panel.
Hybrid: This integration combines the SinglePage and Assistant integrations by adding the conversational bot to a results page and using the query from the main SmartHub search box to start a conversation. This integration is usually rendered in the middle of the page, above the search results.

Additionally, the conversational search module offers additional actions known as ContentActions. For more information, see the Conversational Bot Parameters.

Configuration procedure

The Conversational Search Module can be configured or modified using the UI Editor in Advanced Mode. For information about how to access the UI Editor as well as who can access it, see How to Use the UI Editor.

SH.ConversationalSearchBot.CustomSettings = {
    "ConversationalBot": { <settings object described in table below>}
}
                                                

Conversational Bot Parameters

Setting	Description	Default value
Enabled	This setting enables or disables the Conversational Bot. The possible values for this setting are: true false	true
ParentSelector	This setting specifies the parent selector that is used for appending the compiled template of the Conversational Bot.	".conversationalSearch"
ConversationalBotName	This setting displays the name of the Conversational Bot, as configured in the SmartHub administration portal. For more information, see Configure the conversational bot settings.	"Conversational Bot"
ChatHistoryMessagesLimit	This setting specifies the Chat History messages limit	5
ChatHistoryCharactersLimit	This setting specifies the Chat History characters limit.	500000
CharacterRenderingSpeed	This setting specifies the time (in milliseconds) that a Conversational Bot message character is rendered.	10
Mode	This setting specifies the mode that the Conversational Bot uses. Possible values are: SinglePage Assistant Hybrid For more information, see the overview section.	"SinglePage"
SinglePageSearchTemplatePath	This setting specifies the path to the template used when rendering in SinglePage Mode.	SH.RootLevelURL + "/modules/ConversationalSearch/templates/s inglePageConversationalSearchTemplate.ht ml"
AssistantSearchTemplatePath	This setting specifies the path to the template used when rendering in Assistant and Hybrid Mode.	SH.RootLevelURL + "/modules/ConversationalSearch/templates/a ssistantConversationalSearchTemplate.html"
HybridModeCollapseStatus	This setting specifies the state that the Conversational Bot will render in during Hybrid Mode. The possible values are: Collapsed Expanded	"expanded"
HybridModeSearchEvent	This setting specifies the event that the Conversational Bot will listen for in order to start a conversation while in hybrid mode.	"newQuery"
UserReplyTemplatePath	This setting specifies the path for the template that renders the user message.	SH.RootLevelURL + "/modules/ConversationalSearch/templates/u serReplyTemplate.html"
UserAvatarPath	This setting specifies the path for the avatar used by the user. By default the avatar is the user’s profile picture.	""
BotLoadingTemplatePath	This setting specifies the path for the template that renders the loading animation for the bot before a reply.	SH.RootLevelURL + "/modules/ConversationalSearch/templates/b otLoadingTemplate.html"
BotReplyTemplatePath	This setting specifies the path for the template that renders the bot message.	SH.RootLevelURL + "/modules/ConversationalSearch/templates/b otReplyTemplate.html"
BotAvatarPath	This setting specifies the path for the avatar used by the bot.	SH.RootLevelURL + "/modules/chatbot/images/chatbotIcon.png"
SourceDocumentsTemplatePath	This setting specifies the path for the template that renders the list containing the source documents for the generated answer	SH.RootLevelURL + "/modules/ConversationalSearch/templates/s ourceDocumentsTemplate.html"
ShowContentActions	This setting allows you to enable Content Actions. The possible values are: true false	true
ContentActionsTemplatePath	This setting specifies the path for the template that renders the Content Actions.	SH.RootLevelURL + "/modules/ConversationalSearch/templates/c ontentActionsTemplate.html"
ContentActionsEvent	This setting specifies the event that triggers the Content Actions rendering. The possible values are: beforeUserInteraction newConversation	"beforeUserInteraction"
ModuleDetails	This setting is used to configure different text snippets from the module	-

ModuleDetails Parameters

Setting	Description	Default value
SearchBoxPlaceholder	This setting specifies the placeholder text for the searchbox	"Search...".toLocaleString()
Send	This setting specifies the tooltip for the send button	"Send".toLocaleString()
NewConversation	This setting specifies the tooltip for the new conversation button	"New Conversation".toLocaleString()
Title	This setting specifies the visible name when the Conversational Bot is used in Hybrid or Assistant mode.	"Assistant".toLocaleString()
Disclaimer	This setting specifies the Upland Disclaimer for using Generative AI.	"The BA Insight Smart Hub Conversational Chat Bot provided by Upland Software, Inc. allows our customers and their users to access certain services, including AI- powered tools and resources provided by third parties with whom our customers may have existing contractual relationships, through integrations with Upland Software's applications and online services. As such, as between you and Upland, you acknowledge and agree to use these AI tools or resources at their own risk and discretion. The decision to implement or rely on these tools rests solely with you. As between you and Upland, you accept full responsibility for any consequences, damages, or losses that may arise from their use, and it is your responsibility to assess and evaluate the suitability, compatibility, and potential risks associated with the use of these tools for your specific needs. You should exercise caution and undertake proper due diligence before using any AI tool or resource.".toLocaleString()
ErrorMessage	This setting specifies the error message that the Conversational Bot will show when there is an error with the Conversational Search Service	"Something went wrong. Please contact the administrator.".toLocaleString()
SourceDocumentsMessage	This setting specifies the message shown before listing the source documents	"This information was extracted from:".toLocaleString()

Note the following:

The html elements specified in the ParentSelector setting will have to exist in the html of the page. The elements can be added via the UI Editor in Advanced Mode.