Configure the conversational search module for your SmartHub pages

• Overview

  • Configuration procedure

  • Conversational Bot ID

    • Conversational Bot Parameters

    • ModuleDetails Parameters

    • SmartPreviewsDetails Parameters

• Using Conversational Search filters

  • Limitations

  • Add and edit your Conversational Search filters

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.

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

Additionally, if you would like to use the functionality of traditional SmartHub search and SmartHub conversational search from a single page, you can configure a content container module through the UI Editor to display related document results in a split-screen view. After doing so, you must enable the SplitScreenMode parameter and configure the RelatedDocuments 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 Using the UI Editor.

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

Conversational Bot ID

Conversational Bot Parameters

ModuleDetails Parameters

SmartPreviewsDetails Parameters

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.

• When specifying SmartPreviewsDetails parameters, you must update the property values (DocumentSourceTitleField, DocumentSourceUrlField, and DocumentChunkBodyField) according to the source system you are working with.

  • These properties must match the ones configured in the Original Document Properties field of the conversational bot settings to ensure SmartPreviews functions correctly.

• The split screen feature is available only when the Conversational Search Bot is running in the SinglePage mode. In desktop mode, queries are executed only when the Related Documents side panel is expanded.

• Changes made at ContentContainer level are still supported and are done through the UI Editor.

  • The following ContentContainer settings should not be changed: TriggerNewQueryOn and QueryTemplate.

Using Conversational Search filters

You can configure filters that users can apply to their Conversational Search chats. These filters work similar to SmartHub refiners, but they are applied to the knowledge sources that are used by your chosen LLM to provide answers. For example, if you filter by filetype:pdf, the LLM will only use pdf files to find an answer. Once configured, users will be able to apply a filter and select the desired value from the ConversationalSearch.html page. When filters are applied, the number of filters is displayed.

After applying filters, they will be taken into consideration when a subsequent question is asked. They will not be used for any question that was asked before the filter was applied. Users also have the option to clear their applied filters, and all filters will be cleared when a new conversation is started or the page is refreshed.

Limitations

Note the following limitations with Conversational Search filters:

• Conversational Search refiners are only supported in SinglePage mode. Hybrid or Assistant modes are not currently supported because of conflicts with page refiners.

• Currently, only one facet container is supported per page.

• All refiner types are compatible, with the following limitations:

  • The refiners must be On Demand facets. In other words, the data-preload-values refiner setting property must be false.

  • The results count must be disabled. In other words, the data-show-count refiner setting property must be false.

  • Only the general apply button must be available for the Refinement Panel, and the individual apply buttons must not be enabled. In other words, the data-general-apply-button refiner setting property must be true, and the data-general-apply-button refiner setting property must be true

  • Each facet must have a Conversational Search Bot Id assigned. Only one Conversational Search Bot Id is supported per page. The value must match the bot ID in the Conversational Search settings. For example, using the example in the Configuration procedure section, the Conversational Search Bot Id is “ConversationalSearchBot”.

Add and edit your Conversational Search filters

1. When configuring Conversational search, ensure that the mode is set to SinglePage and there are no additional search refiners enabled.

2. In the SmartHub UI Editor, click Advanced Mode > Advanced HTML Edit.

3. In the HTML settings file, add the following line that corresponds to the facet panel:

   <div class="coveo-facet-column"></div>

4. The FederatorBackends parameter must be updated for the data-expression attribute in the CoveoTab element to correspond to the selected Search Engines from the Conversational Search Bot settings.

   <a class="CoveoTab" data-icon="fas fa-globe" data-id="b29924a9-ec32-4c10-8892-a544b69ee121" 
   data-expression='{searchboxquery} FederatorBackends:"BackendA;BackendB"' data-caption="Everything" data-automation-id="everythingVertical"></a>

   The search engines that are specified in this parameter MUST be enabled in the Search Engines section of the SmartHub General Settings.

5. Return to Basic Mode in the UI editor and select the Refiners tab. This tab allows you to add a new refiner, but you must ensure that you follow the limitations stated above.

6. Click Apply and Save.

The following are the default facets that are configured on the ConversationalSearch.html page:

<div class="coveo-facet-column">
    <div class="CoveoFacet" data-conversational-search-bot- id="ConversationalSearchBot" data-default-state="collapsed" data-title="Result type" data-field="@filetype" data-lookup-field="@filetype" 
    data-available-sorts="occurrencesdescending,occurrencesascending, alphaascending, alphadescending" 
    data-enable-settings="false" data-searchbox-position="bottom" data- preload-values="false" data-enable-toggling-operator="false" 
    data-enable-facet-search="true" data-show-apply-button="false" data-is-dynamic- facet="false" data-use-radio-buttons="false" data-general-apply-button="true"
    data-show-count="false">
    </div>
    <div class="CoveoFacet" data-conversational-search-bot- id="ConversationalSearchBot" data-default-state="collapsed" data- title="ContentSource" data-field="@ContentSource"
    data-lookup- field="@ContentSource" data-available-sorts="occurrencesdescending,occurrencesascending,alphaascending,alphadescending" 
    data-enable-settings="false" data-searchbox-position="bottom" data- preload-values="false" data-enable-toggling-operator="false" data-enable- facet-search="true" 
    data-show-apply-button="false" data-is-dynamic- facet="false" data-use-radio-buttons="false" data-general-apply-button="true"
    data-show-count="false">
    </div>
    <div class="CoveoFacetDatepicker" data-conversational-search-bot- id="ConversationalSearchBot" data-start="auto" data-end="auto" data-default- state="collapsed" data-title="Modified Date"
    data-field="@date" data-lookup- field="@date" data-available-sorts="occurrencesdescending, occurrencesascending, alphaascending, alphadescending" data-preload-values="false">
    </div>
    <div class="CoveoFacet" data-conversational-search-bot- id="ConversationalSearchBot" data-default-state="collapsed" data- title="Display Author" data-field="@DisplayAuthor" 
    data-lookup- field="@DisplayAuthor" data-available-sorts="occurrencesdescending,occurrencesascending, alphaascending, alphadescendi ng" data-enable-settings="false" 
    data-searchbox-position="bottom" data- preload-values="false" data-enable-toggling-operator="false" data-enable- facet-search="true" data-show-apply-button="false" 
    data-is-dynamic-facet="false" data-use-radio-buttons="false" data-general-apply-button="true" data-show-count="false"></div>
</div>