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

Search Interface

The Search Interface is a graphical user interface used by the search users to pose their queries. SearchAssist allows you to customize this user interface.

Highlights

You can customize the interface in three different aspects:

  1. Experience – You can choose the position of the search bar, this would also dictate the result types presented to the user.
    • Top-down experience will position the Search Bar at the top of the chat window. This approach is used in e-commerce websites where search results are displayed from top to bottom in the search bar.
      As the user types a query, the live search results are displayed as a drop-down list and the full page results are given on the page itself. The user can either select an option from the live search drop-down list or browse through the full results page.
    • Bottom-up experience will position the Search Bar at the bottom of the chat window. This approach is generally used in banking and insurance websites where you want a bot’s help to perform actions like pay bills, etc. at the top or bottom of the chat window.
      In this case, the live search results are displayed as the user types the query and the conversational search results are displayed in the chat window. Users can select an option from the live search list or browse the options given in the conversational search results. Apart from this, the user will be presented with an option to view the full page results, to see the entire search results on a slide-out page.
  2. Search Widget includes customization of the search bar. These include:
    • Placeholder Text inside the search bar, text color
    • Search bar border color, search Icon
    • Search Button customization
  3. Interactions – The user experience with the search interface can be improved by configuring various interactions.
    • Greeting message is displayed on the launch of the search bar, a total of 60 characters allowed and you can set the color of the text.
    • Show Searches option can be enabled for the user to see their previous queries. These queries appear as cards in the search window as soon as the user selects the search bar. Options are to display either frequent searches or recent search displays.
    • Auto-complete option can be enabled to save the user time and effort by predicting the rest of the word as they are typing a query.
    • Query Suggestion reduces user’s time to search a query by providing suggestions. These suggestions would help users to enter long queries or select a query as they type. You can set the number of suggestions to be displayed from 0-3 for bottom-up experience, from 0-5 for a top-down experience. When used along with Live Search Results, the live search results appear at the background of the query suggestions and the user can scroll to browse the results.
    • Live Search Results enhance the user’s search experience by showing the results while entering the query and allow the user to see search results without redirecting to the results page. You can set the number of results to be displayed from 0-5 for bottom-up experience, from 0-10 for a top-down experience. When used along with Query Suggestion, the live search results appear at the background of the query suggestions and the user can scroll to browse the results.

Configuration

To access the Search Interface and customize it, follow the below steps:

  1. Click the Indices tab on the top.
  2. On the left pane, under the Search Experience section, click Search Interface.
  3. On the Search Interface page, by default, the Experience section is displayed.
  4. Select an option:
    • Top-Down – Search bar at the top
    • Bottom-Up – Search bar at the bottom
  5. Click Next.
  6. On the Search Widget section:
    1. In the Search Box Customization section, you can make changes to the search box.
      • Click in the search text box to update the placeholder text and the text color.
      • Click in the search box to update the border color and the fill color
      • Click on the search icon to Upload Icon of your choice to replace the default icon. You can upload an image measuring 26×26 pixels.

      • Click on the Button to Add button. You can change
        • Show or hide button
        • Placement of the button – outside or inside the search bar
        • Text displayed on the button (total of 5 characters)
        • Text color, button fill color, and button border color.
  7. Click Next.
  8. On the Interactions section:
    1. Enter a message to be displayed as the greeting message, in the Customize Greeting Message box.
    2. Enable to Show Searches and select an option:
      • Frequent – Frequent searches done by users,
      • Recent – Recent searches done by the user.
    3. Turn on or off the Auto-complete toggle. This option auto-completes the search text as the user is typing.
    4. Under Query Suggestions, set the slider between to decide the number of query suggestions be displayed.
    5. Under Live Search Results, set the slider to decide the number of live search results be displayed.

  9. Click Done.

Search Interface

The Search Interface is a graphical user interface used by the search users to pose their queries. SearchAssist allows you to customize this user interface.

Highlights

You can customize the interface in three different aspects:

  1. Experience – You can choose the position of the search bar, this would also dictate the result types presented to the user.
    • Top-down experience will position the Search Bar at the top of the chat window. This approach is used in e-commerce websites where search results are displayed from top to bottom in the search bar.
      As the user types a query, the live search results are displayed as a drop-down list and the full page results are given on the page itself. The user can either select an option from the live search drop-down list or browse through the full results page.
    • Bottom-up experience will position the Search Bar at the bottom of the chat window. This approach is generally used in banking and insurance websites where you want a bot’s help to perform actions like pay bills, etc. at the top or bottom of the chat window.
      In this case, the live search results are displayed as the user types the query and the conversational search results are displayed in the chat window. Users can select an option from the live search list or browse the options given in the conversational search results. Apart from this, the user will be presented with an option to view the full page results, to see the entire search results on a slide-out page.
  2. Search Widget includes customization of the search bar. These include:
    • Placeholder Text inside the search bar, text color
    • Search bar border color, search Icon
    • Search Button customization
  3. Interactions – The user experience with the search interface can be improved by configuring various interactions.
    • Greeting message is displayed on the launch of the search bar, a total of 60 characters allowed and you can set the color of the text.
    • Show Searches option can be enabled for the user to see their previous queries. These queries appear as cards in the search window as soon as the user selects the search bar. Options are to display either frequent searches or recent search displays.
    • Auto-complete option can be enabled to save the user time and effort by predicting the rest of the word as they are typing a query.
    • Query Suggestion reduces user’s time to search a query by providing suggestions. These suggestions would help users to enter long queries or select a query as they type. You can set the number of suggestions to be displayed from 0-3 for bottom-up experience, from 0-5 for a top-down experience. When used along with Live Search Results, the live search results appear at the background of the query suggestions and the user can scroll to browse the results.
    • Live Search Results enhance the user’s search experience by showing the results while entering the query and allow the user to see search results without redirecting to the results page. You can set the number of results to be displayed from 0-5 for bottom-up experience, from 0-10 for a top-down experience. When used along with Query Suggestion, the live search results appear at the background of the query suggestions and the user can scroll to browse the results.

Configuration

To access the Search Interface and customize it, follow the below steps:

  1. Click the Indices tab on the top.
  2. On the left pane, under the Search Experience section, click Search Interface.
  3. On the Search Interface page, by default, the Experience section is displayed.
  4. Select an option:
    • Top-Down – Search bar at the top
    • Bottom-Up – Search bar at the bottom
  5. Click Next.
  6. On the Search Widget section:
    1. In the Search Box Customization section, you can make changes to the search box.
      • Click in the search text box to update the placeholder text and the text color.
      • Click in the search box to update the border color and the fill color
      • Click on the search icon to Upload Icon of your choice to replace the default icon. You can upload an image measuring 26×26 pixels.

      • Click on the Button to Add button. You can change
        • Show or hide button
        • Placement of the button – outside or inside the search bar
        • Text displayed on the button (total of 5 characters)
        • Text color, button fill color, and button border color.
  7. Click Next.
  8. On the Interactions section:
    1. Enter a message to be displayed as the greeting message, in the Customize Greeting Message box.
    2. Enable to Show Searches and select an option:
      • Frequent – Frequent searches done by users,
      • Recent – Recent searches done by the user.
    3. Turn on or off the Auto-complete toggle. This option auto-completes the search text as the user is typing.
    4. Under Query Suggestions, set the slider between to decide the number of query suggestions be displayed.
    5. Under Live Search Results, set the slider to decide the number of live search results be displayed.

  9. Click Done.