GETTING STARTED
SearchAssist Overview
SearchAssist Introduction
Onboarding SearchAssist
Build your first App
Glossary
Release Notes
What's new in SearchAssist
Previous Versions

CONCEPTS
Managing Sources
Introduction
Files
Web Pages
FAQs
Structured Data 
Connectors
Introduction to Connectors
Azure Storage Connector
Confluence Cloud Connector
Confluence Server Connector
Custom Connector
DotCMS Connector
Dropbox Connector
Google Drive Connector
Oracle Knowledge Connector
Salesforce Connector
ServiceNow Connector
SharePoint Connector
Zendesk Connector
RACL
Virtual Assistants
Managing Indices
Introduction
Index Fields
Traits
Workbench
Introduction to Workbench
Field Mapping
Entity Extraction
Traits Extraction
Keyword Extraction
Exclude Document
Semantic Meaning
Snippet Extraction
Custom LLM Prompts
Index Settings
Index Languages
Managing Chunks
Chunk Browser
Managing Relevance
Introduction
Weights
Highlighting
Presentable
Synonyms
Stop Words
Search Relevance
Spell Correction
Prefix Search
Custom Configurations
Personalizing Results
Introduction
Answer Snippets
Introduction
Extractive Model
Generative Model
Enabling Both Models
Simulation and Testing
Debugging
Best Practices and Points to Remember
Troubleshooting Answers
Answer Snippets Support Across Content Sources
Result Ranking
Facets
Business Rules
Introduction
Contextual Rules
NLP Rules
Engagement
Small Talk
Bot Actions
Designing Search Experience
Introduction
Search Interface
Result Templates
Testing
Preview and Test
Debug Tool
Running Experiments
Introduction
Experiments
Analyzing Search Performance
Overview
Dashboard
User Engagement
Search Insights
Result Insights
Answer Insights

ADMINISTRATION
General Settings
Credentials
Channels
Team
Collaboration
Integrations
OpenAI Integration
Azure OpenAI Integration
Custom Integration
Billing and Usage
Plan Details
Usage Logs
Order and Invoices
Smart Hibernation

SearchAssist APIs
API Introduction
API List

SearchAssist SDK

HOW TOs
Use Custom Fields to Filter Search Results and Answers
Add Custom Metadata to Ingested Content
Write Painless Scripts
Configure Business Rules for Generative Answers

Result Templates

Designing Results Templates

SearchAssist allows you to customize display layouts with result templates.

  • Live Search  Displays results as the user types a query.
  • Conversational Search  Displays results in the chatbot with a link to view the full page results. Available only for the Assistant (bottom-up) search experience. (Click Indices > Search Interface > Experience.)
  • Full Page Result  Displays complete results on the main page for the search bar (top-down) option or as a slide-out page for the Assistant (bottom-up search experience) option.

SearchAssist offers the following off-the-shelf templates ready:

List Template


List Template with Images

 

Grid Template

Carousel Template

Configuring Result Views

You can configure one default display template and use it for all search results (e.g. web, FAQs, etc.). Or, you can configure Result Groups, an option that lets you configure a separate template for each type of search results (e.g. web, FAQ, file).

Follow these steps:

  1. Click the Indices menu tab.
  2. In the left pane, click Result Templates.
  3. On the Result Templates page, click Live Search, Conversational Search, or Full Page Result.Note: You cannot customize the Conversational Search for a search bar (top-down) search experience.

Configuring the Default Display

Configure one display template and use it for all search results.

  1. Make sure the Result Groups toggle is in the OFF position.
  2. Click the Default Template field.
  3. Select an option on the drop-down menu.
  4. Copy a set of configuration settings. (optional, see below)
  5. Click the Preview icon to see the display format. (optional)
  6. Click the Customize Template icon to configure the results page.

Copying Configuration Settings

Use this time-saving option to copy configuration settings from a previous template into the new template.

  1. Click the Copy Configuration button.
  2. Locate a highlighted button (indicates settings that can be copied).
  3. Click the button.
  4. SearchAssist applies the settings.
  5. Click the Customize Template icon to review and modify settings, as required.

Adding Filter Facets

If you select the Full Page Result display option, you can add facets to the results display layout.

  1. Switch the toggle to the Enabled position. The default setting is disabled.
  2. Choose left or right alignment.
  3. Click Save.


Note
: The Filter Facets option is not available for Live Search or Conversational Search.

Configuring Default Settings

Now customize the results template. The list of available options on the Customize page varies according to the default type you selected in the previous step (i.e. List, Carousel, or Grid). Generally, there are three steps:

  1. Scroll down to the left side of the screen and select a template.
  2. At the top of the page, choose a display option.
  3. Under the Search Result Mapping heading, click a field and select a data source for each heading.
  4. Review the Clickable Results setting. (see below)
  5. Click Save.
  6. Click Test to review the results display.

Note: The number of mapping steps varies with each template.

Clickable Results

At the bottom of the page, check the Search Result and click the Settings toggle. The default setting is No. If Clickable is enabled, the results act as a link to the value in the field that is mapped to the URL. Results can be non-clickable for list templates. In these cases, SearchAssist presents results in an expanded or collapsed state depending on the content in the response.

To enable a clickable section:

  1. Switch the toggle to the Yes position.
  2. Choose a behavior: Open a web page or Postback.
  3. Click the URL field and select an option.
  4. Click Save.

Configuring Result Groups

Instead of one default template for all types of results, you can configure a separate template for two or more different result groups.

  1. Go to the Result Templates page.
  2. Switch the Result Groups toggle to the ON position.
  3. Ignore the default Field Name. (recommended)

Choosing a template

SearchAssist auto-fills the Values. Currently, there are four types of values: Web, FAQ, File, and Data. The classification field is non-editable.

  1. Click a Layout field and select a template (List, Carousel, or Grid) for each value.
  2. Click the Preview icon to see the display format. (optional)
  3. Click the Customize Template icon to configure a template.

Configuring Template Settings

The list of customization options varies according to the template type. Generally, there are three steps:

  1. Scroll to the left side of the screen and select a template.
  2. At the top of the page, choose a display option.
  3. Under the Search Result Mapping heading, click a field and select a data source for each heading.
  4. Review the Clickable Results setting. (see below)
  5. Click Save.
  6. Click Test to review the results display.

Note: The number of mapping steps varies with each template.

Clickable Results

At the bottom of the page, check the Search Result and click the Settings toggle. The default setting is No. If Clickable is enabled, the results act as a link to the value in the field that is mapped to the URL. Results can be non-clickable for list templates. In these cases, SearchAssist presents results in an expanded or collapsed state depending on the content in the response.

To enable a clickable section:

  1. Switch the toggle to the Yes position.
  2. Choose a behavior: Open a web page or Postback.
  3. Click the URL field and select an option.
  4. Click Save.

Result Templates

Designing Results Templates

SearchAssist allows you to customize display layouts with result templates.

  • Live Search  Displays results as the user types a query.
  • Conversational Search  Displays results in the chatbot with a link to view the full page results. Available only for the Assistant (bottom-up) search experience. (Click Indices > Search Interface > Experience.)
  • Full Page Result  Displays complete results on the main page for the search bar (top-down) option or as a slide-out page for the Assistant (bottom-up search experience) option.

SearchAssist offers the following off-the-shelf templates ready:

List Template


List Template with Images

 

Grid Template

Carousel Template

Configuring Result Views

You can configure one default display template and use it for all search results (e.g. web, FAQs, etc.). Or, you can configure Result Groups, an option that lets you configure a separate template for each type of search results (e.g. web, FAQ, file).

Follow these steps:

  1. Click the Indices menu tab.
  2. In the left pane, click Result Templates.
  3. On the Result Templates page, click Live Search, Conversational Search, or Full Page Result.Note: You cannot customize the Conversational Search for a search bar (top-down) search experience.

Configuring the Default Display

Configure one display template and use it for all search results.

  1. Make sure the Result Groups toggle is in the OFF position.
  2. Click the Default Template field.
  3. Select an option on the drop-down menu.
  4. Copy a set of configuration settings. (optional, see below)
  5. Click the Preview icon to see the display format. (optional)
  6. Click the Customize Template icon to configure the results page.

Copying Configuration Settings

Use this time-saving option to copy configuration settings from a previous template into the new template.

  1. Click the Copy Configuration button.
  2. Locate a highlighted button (indicates settings that can be copied).
  3. Click the button.
  4. SearchAssist applies the settings.
  5. Click the Customize Template icon to review and modify settings, as required.

Adding Filter Facets

If you select the Full Page Result display option, you can add facets to the results display layout.

  1. Switch the toggle to the Enabled position. The default setting is disabled.
  2. Choose left or right alignment.
  3. Click Save.


Note
: The Filter Facets option is not available for Live Search or Conversational Search.

Configuring Default Settings

Now customize the results template. The list of available options on the Customize page varies according to the default type you selected in the previous step (i.e. List, Carousel, or Grid). Generally, there are three steps:

  1. Scroll down to the left side of the screen and select a template.
  2. At the top of the page, choose a display option.
  3. Under the Search Result Mapping heading, click a field and select a data source for each heading.
  4. Review the Clickable Results setting. (see below)
  5. Click Save.
  6. Click Test to review the results display.

Note: The number of mapping steps varies with each template.

Clickable Results

At the bottom of the page, check the Search Result and click the Settings toggle. The default setting is No. If Clickable is enabled, the results act as a link to the value in the field that is mapped to the URL. Results can be non-clickable for list templates. In these cases, SearchAssist presents results in an expanded or collapsed state depending on the content in the response.

To enable a clickable section:

  1. Switch the toggle to the Yes position.
  2. Choose a behavior: Open a web page or Postback.
  3. Click the URL field and select an option.
  4. Click Save.

Configuring Result Groups

Instead of one default template for all types of results, you can configure a separate template for two or more different result groups.

  1. Go to the Result Templates page.
  2. Switch the Result Groups toggle to the ON position.
  3. Ignore the default Field Name. (recommended)

Choosing a template

SearchAssist auto-fills the Values. Currently, there are four types of values: Web, FAQ, File, and Data. The classification field is non-editable.

  1. Click a Layout field and select a template (List, Carousel, or Grid) for each value.
  2. Click the Preview icon to see the display format. (optional)
  3. Click the Customize Template icon to configure a template.

Configuring Template Settings

The list of customization options varies according to the template type. Generally, there are three steps:

  1. Scroll to the left side of the screen and select a template.
  2. At the top of the page, choose a display option.
  3. Under the Search Result Mapping heading, click a field and select a data source for each heading.
  4. Review the Clickable Results setting. (see below)
  5. Click Save.
  6. Click Test to review the results display.

Note: The number of mapping steps varies with each template.

Clickable Results

At the bottom of the page, check the Search Result and click the Settings toggle. The default setting is No. If Clickable is enabled, the results act as a link to the value in the field that is mapped to the URL. Results can be non-clickable for list templates. In these cases, SearchAssist presents results in an expanded or collapsed state depending on the content in the response.

To enable a clickable section:

  1. Switch the toggle to the Yes position.
  2. Choose a behavior: Open a web page or Postback.
  3. Click the URL field and select an option.
  4. Click Save.