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

SearchAssist allows you to customize the Result Templates and the way in which the results should be displayed to the search user so that they always see the results in a more meaningful way.

You can configure the Result template for the following result types (see here for details on search result types):

  • Live Search displays the results as the user is typing the query.
  • Conversational Search displays the results in the chatbot with a link to view the full page results. This option is available only for the bottom-up search experience.
  • Full Page Results display the complete results, on the main page in case of top-down search experience or as a slide-out page when the user selects the option in case of bottom-up search experience.

Features

List Template

List Template with Images

Grid Template

Carousel Template

Following are the main customizations you can do for search results presentation:

  1. Result Template can be set to be displayed as a:
    • List of cards (List Template 1),
    • Plain list (List Template 2),
    • Block of lists (List Template 3),
    • Grid, or
    • Carousel.
  2. For the selected template you can set the Search Result Layout to one of the following:
    • Tiled layout with just the Text,
    • Tiled layout with Image and text, you can specify the field for the image,
    • Tiled layout with Centered Content, or
    • Tiled layout with Header.
  3. For each layout, you can map fields to be displayed on the various areas applicable in the search result layout, like:
    • Header,
    • Description,
    • URL, and
    • Image.
  4. The results can be static information or leading to a task or detailed pages, for this you can configure the results to be clickable or not:
    • If results are set to be clickable, the results will act as a link to the value in the field that is mapped to the URL. This is the default option for Grid and Carousal templates and is non-editable.
    • Results can be set to be non-clickable for list templates. In such cases, the results will be presented in an expanded/collapsed state depending on the content in the response.
  5. Text alignment for grid and carousel templates can be specified as left or right.
  6. Results can be classified based on a field. By default, the classification field is set to SourceType i.e the results will be categorized and displayed into Pages, FAQs, Actions, Structured Data, and Files. Currently, the classification field is non-editable.
  7. Based on the category, the following layouts are set by default, which you can retain or modify:
    • FAQ – Tile with Text,
    • Pages – Tile with Image,
    • Files – Tile with Header,
    • Structured data – default template is not defined, you have to set a template,
    • Bot Actions – Tile with Header, non-editable (see here for customizing bot actions display).
  8. The order in which the results are presented can be set to:
    • Based on relevance of the top most search result in each category.
    • Custom – You can drag and drop the categories in any preferred order.

Configuration

To configure the Search Results Template, follow the below steps:

  1. On the Templates page, by default, the Live Search tab is selected. Choose the search result you want to configure – Live Search, Conversational, or Full Page Results.
    Note: You cannot customize the Conversational Search for a Top-Down search experience.
  2. You can configure from scratch or Copy Configuration of a previous setting from the drop-down list.
  3. Under the Results Classification section, you can choose some other field for result classification. Currently, it is set to dataContentType field and is non-editable.
  4. Under the Results Appearance section, select an option:
    1. Order based on relevance
    2. Custom order
  5. Next, you can customize the template. Hover over the sample template and click Customize.

  6. On the Customize Template dialog box, select a template type from the Template Type drop-down list. For example, Grid or Carousel.

  7. Under the Search Result Layout section, select an option like Tile with Text, Tile with Image, Tile with Centered Content, and Tile with Header.
  8. Turn on the Clickable radio button to search results clickable and map a field to the URL.
  9. Under the Search Result Mapping section, map the fields for Heading, Description, Image (where applicable).
  10. You can Preview the results templates.
  11. For Grid and Carousel templates, you can set the Text Alignment to Left Aligned or Center Aligned.
  12. Click Save.
  13. For Full Page Result, you can configure the Facet. Under the Facets section,
    • Enable or disable the facets, by turning on or off the toggle
    • Once enabled you can set the position of the facet – left, right, or top.

  14. Click Save.

On this Page

Result Templates

SearchAssist allows you to customize the Result Templates and the way in which the results should be displayed to the search user so that they always see the results in a more meaningful way.

You can configure the Result template for the following result types (see here for details on search result types):

  • Live Search displays the results as the user is typing the query.
  • Conversational Search displays the results in the chatbot with a link to view the full page results. This option is available only for the bottom-up search experience.
  • Full Page Results display the complete results, on the main page in case of top-down search experience or as a slide-out page when the user selects the option in case of bottom-up search experience.

Features

List Template

List Template with Images

Grid Template

Carousel Template

Following are the main customizations you can do for search results presentation:

  1. Result Template can be set to be displayed as a:
    • List of cards (List Template 1),
    • Plain list (List Template 2),
    • Block of lists (List Template 3),
    • Grid, or
    • Carousel.
  2. For the selected template you can set the Search Result Layout to one of the following:
    • Tiled layout with just the Text,
    • Tiled layout with Image and text, you can specify the field for the image,
    • Tiled layout with Centered Content, or
    • Tiled layout with Header.
  3. For each layout, you can map fields to be displayed on the various areas applicable in the search result layout, like:
    • Header,
    • Description,
    • URL, and
    • Image.
  4. The results can be static information or leading to a task or detailed pages, for this you can configure the results to be clickable or not:
    • If results are set to be clickable, the results will act as a link to the value in the field that is mapped to the URL. This is the default option for Grid and Carousal templates and is non-editable.
    • Results can be set to be non-clickable for list templates. In such cases, the results will be presented in an expanded/collapsed state depending on the content in the response.
  5. Text alignment for grid and carousel templates can be specified as left or right.
  6. Results can be classified based on a field. By default, the classification field is set to SourceType i.e the results will be categorized and displayed into Pages, FAQs, Actions, Structured Data, and Files. Currently, the classification field is non-editable.
  7. Based on the category, the following layouts are set by default, which you can retain or modify:
    • FAQ – Tile with Text,
    • Pages – Tile with Image,
    • Files – Tile with Header,
    • Structured data – default template is not defined, you have to set a template,
    • Bot Actions – Tile with Header, non-editable (see here for customizing bot actions display).
  8. The order in which the results are presented can be set to:
    • Based on relevance of the top most search result in each category.
    • Custom – You can drag and drop the categories in any preferred order.

Configuration

To configure the Search Results Template, follow the below steps:

  1. On the Templates page, by default, the Live Search tab is selected. Choose the search result you want to configure – Live Search, Conversational, or Full Page Results.
    Note: You cannot customize the Conversational Search for a Top-Down search experience.
  2. You can configure from scratch or Copy Configuration of a previous setting from the drop-down list.
  3. Under the Results Classification section, you can choose some other field for result classification. Currently, it is set to dataContentType field and is non-editable.
  4. Under the Results Appearance section, select an option:
    1. Order based on relevance
    2. Custom order
  5. Next, you can customize the template. Hover over the sample template and click Customize.

  6. On the Customize Template dialog box, select a template type from the Template Type drop-down list. For example, Grid or Carousel.

  7. Under the Search Result Layout section, select an option like Tile with Text, Tile with Image, Tile with Centered Content, and Tile with Header.
  8. Turn on the Clickable radio button to search results clickable and map a field to the URL.
  9. Under the Search Result Mapping section, map the fields for Heading, Description, Image (where applicable).
  10. You can Preview the results templates.
  11. For Grid and Carousel templates, you can set the Text Alignment to Left Aligned or Center Aligned.
  12. Click Save.
  13. For Full Page Result, you can configure the Facet. Under the Facets section,
    • Enable or disable the facets, by turning on or off the toggle
    • Once enabled you can set the position of the facet – left, right, or top.

  14. Click Save.