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

You can customize three different features: search experience, search widget, and interactions.

Search Experience

Choose the position of the search bar which, in turn, changes how the page shows results to the user.

  • Search Bar This top-down option places the bar at the top of the window. Used by most e-commerce websites, search results are displayed from top to bottom in the search bar. As the user types a query, live search results are displayed as a drop-down list; full-page results are given on the page itself. The user can select an option from the live search drop-down list or browse through the full results page.
  • Assistant Commonly used on banking and insurance websites, this bottom-up option places the search bar at the bottom of the chat window. A live virtual assistant helps perform actions (e.g. paying bills, renewing cards) at the top or bottom of the chat window. Live search results are displayed as the user types the query. Conversational search results are displayed in the chat window. Users can select an option from the live search list or browse options given in the conversational search results. The user can also be presented with an option to view the full page results on a slide-out page.

Search Widget

Customize the appearance of the widget. This includes placeholder text inside the search bar, text color, Search bar border color, search Icon, and search button customization.

Interactions

Improve the user experience by customizing interactions.

  • Greeting Message: Change the launch message in the search bar. Enter up to 60 characters and customize the text color.
  • Show Recent Searches: When enabled, show users their previous queries. These queries pop up as cards in the search window as soon as the user selects the search bar.
  • Auto-complete: When enabled, this option saves users time by predicting the rest of the word as they type a query.
  • Query Suggestion: Reduce the time to enter a search query by providing suggestions. These suggestions help users to enter long queries or select a query as they type. Set the number of displayed suggestions from 0 through 5 for bottom-up experiences, and 0 through 10 for top-down Live Search Results. When used along with Live Search Results, the user can scroll to browse the results that appear in the background.
  • Live Search Results: While entering a query, show results from the very first keystroke. Allow the user to see search results without redirecting to a results page. You can set the number of results to be displayed from 0 through 5 for bottom-up experience, and from 0 through 10 for a top-down experience. When used along with Query Suggestion, the user can scroll to browse the results that appear in the background.

Configuring Search Experience

SearchAssist allows you to choose and configure the type of search experience you want to provide your users. The choices are a search bar at the top of the page or an Assistant at the bottom of the page.

Follow these steps:

  1. Click the Indices menu tab.
  2. In the left pane, click Search Interface.
  3. Select an option: Search Bar or Assistant.
  4. Click Next. On the Search Widget page, add customizations.

Customizing the Widget

To change the text color in the search box:

  1. Hover the text in the box.
  2. Click the pencil icon.
  3. Change the text color. (optional)

To change the border color of the search box:

  1. Hover the right side of the search box.
  2. Click the pencil icon.
  3. Change the fill and text color. (optional)

Customizing Search Button

To customize the search button:

  1. Hover the button on the right side of the search box.
  2. Click the pencil icon.
  3. Switch the toggle to the YES position to display a button. (optional)
  4. Click an option to place the button inside or outside the search box.
  5. Change the button label. The default setting is BUTTON.
  6. Change the color of the button text, fill, and border. (optional)
  7. Click Next.

Customizing Interactions

On this page, configure the message that the SearchAssist app shows the user in the search bar or Assistant.

Greeting Message

  1. Review the default text in the Customize Launch Greeting Message box. Edit as required.
  2. Click the color square to change the message text color and then click Apply. (optional)If you select the Assistant option (search bar at bottom of page), customize the fill color of the message bar. (optional)

Query options

  1. Switch the toggle to the Yes position to show users their recent searches.
  2. Switch the toggle to the Yes position to enable this auto-complete feature. This option auto-completes search text as the user types.
  3. Drag the Query Suggestions slider to set the number of displayed suggestions. The range is 1 to 5 for the Search Bar option and 1 to 3 for the Assistant option.
  4. Drag the Live Search Results slider to set the number of displayed live search results. The range is 1 to 10 for the Search Bar option and 1 to 5 for the Assistant option.
  5. Click Next.

Results Feedback

On this page, enable or disable a feedback feature.

  1. Switch the toggle to the Enabled to show a feedback question. Users click an icon to submit a voluntary answer.
  2. Click Done.

Search Interface

You can customize three different features: search experience, search widget, and interactions.

Search Experience

Choose the position of the search bar which, in turn, changes how the page shows results to the user.

  • Search Bar This top-down option places the bar at the top of the window. Used by most e-commerce websites, search results are displayed from top to bottom in the search bar. As the user types a query, live search results are displayed as a drop-down list; full-page results are given on the page itself. The user can select an option from the live search drop-down list or browse through the full results page.
  • Assistant Commonly used on banking and insurance websites, this bottom-up option places the search bar at the bottom of the chat window. A live virtual assistant helps perform actions (e.g. paying bills, renewing cards) at the top or bottom of the chat window. Live search results are displayed as the user types the query. Conversational search results are displayed in the chat window. Users can select an option from the live search list or browse options given in the conversational search results. The user can also be presented with an option to view the full page results on a slide-out page.

Search Widget

Customize the appearance of the widget. This includes placeholder text inside the search bar, text color, Search bar border color, search Icon, and search button customization.

Interactions

Improve the user experience by customizing interactions.

  • Greeting Message: Change the launch message in the search bar. Enter up to 60 characters and customize the text color.
  • Show Recent Searches: When enabled, show users their previous queries. These queries pop up as cards in the search window as soon as the user selects the search bar.
  • Auto-complete: When enabled, this option saves users time by predicting the rest of the word as they type a query.
  • Query Suggestion: Reduce the time to enter a search query by providing suggestions. These suggestions help users to enter long queries or select a query as they type. Set the number of displayed suggestions from 0 through 5 for bottom-up experiences, and 0 through 10 for top-down Live Search Results. When used along with Live Search Results, the user can scroll to browse the results that appear in the background.
  • Live Search Results: While entering a query, show results from the very first keystroke. Allow the user to see search results without redirecting to a results page. You can set the number of results to be displayed from 0 through 5 for bottom-up experience, and from 0 through 10 for a top-down experience. When used along with Query Suggestion, the user can scroll to browse the results that appear in the background.

Configuring Search Experience

SearchAssist allows you to choose and configure the type of search experience you want to provide your users. The choices are a search bar at the top of the page or an Assistant at the bottom of the page.

Follow these steps:

  1. Click the Indices menu tab.
  2. In the left pane, click Search Interface.
  3. Select an option: Search Bar or Assistant.
  4. Click Next. On the Search Widget page, add customizations.

Customizing the Widget

To change the text color in the search box:

  1. Hover the text in the box.
  2. Click the pencil icon.
  3. Change the text color. (optional)

To change the border color of the search box:

  1. Hover the right side of the search box.
  2. Click the pencil icon.
  3. Change the fill and text color. (optional)

Customizing Search Button

To customize the search button:

  1. Hover the button on the right side of the search box.
  2. Click the pencil icon.
  3. Switch the toggle to the YES position to display a button. (optional)
  4. Click an option to place the button inside or outside the search box.
  5. Change the button label. The default setting is BUTTON.
  6. Change the color of the button text, fill, and border. (optional)
  7. Click Next.

Customizing Interactions

On this page, configure the message that the SearchAssist app shows the user in the search bar or Assistant.

Greeting Message

  1. Review the default text in the Customize Launch Greeting Message box. Edit as required.
  2. Click the color square to change the message text color and then click Apply. (optional)If you select the Assistant option (search bar at bottom of page), customize the fill color of the message bar. (optional)

Query options

  1. Switch the toggle to the Yes position to show users their recent searches.
  2. Switch the toggle to the Yes position to enable this auto-complete feature. This option auto-completes search text as the user types.
  3. Drag the Query Suggestions slider to set the number of displayed suggestions. The range is 1 to 5 for the Search Bar option and 1 to 3 for the Assistant option.
  4. Drag the Live Search Results slider to set the number of displayed live search results. The range is 1 to 10 for the Search Bar option and 1 to 5 for the Assistant option.
  5. Click Next.

Results Feedback

On this page, enable or disable a feedback feature.

  1. Switch the toggle to the Enabled to show a feedback question. Users click an icon to submit a voluntary answer.
  2. Click Done.