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

Integrate SearchAssist with third-party applications

To enhance the search features of an application, you can integrate the application with your SearchAssist application and leverage its extensive features. 

Integration with the SearchAssist application is a two-step process. 

  • Creating client credentials in the SearchAssist application and enabling a communication channel.
  • Configuring the client credentials in the third-party application to start interaction between the two. 

For more information on how to create a SearchAssist application and customize it to return desired results, refer to this guide.

To enable interaction with the SearchAssist application, you need to create a set of credentials, define the API scope for the credentials, and then, associate a communication channel with the credentials. Follow the steps listed below to complete this configuration in the SearchAssist application. 

Go to the Credentials page under the Manage tab. Click on Let’s Start to create your first set of credentials.

Under the Configuration tab, provide a name for the credentials.

Under the API Scopes tab, select the API scopes based on the SearchAssist features required in the third-party application and click Save.  For example, if you only want to enable the search feature of the application, you can select Full Search, Live Search, and Advanced Search APIs.

Next, to enable a communication channel, go to the Channels page under the Manage tab and Click Web/Mobile Client.

This page shows the App Details and Web Client details. These are the details to be configured in the third-party app or web client for interaction with the SearchAssist application.

To get the client credentials to be used in an app, click on App Details. Select the credentials created above from the drop-down menu. The other fields are automatically generated.

Save the fields generated here like the client ID, client secret ID, etc., and use them for communication with this SearchAssist application.

Integrate SearchAssist with third-party applications

To enhance the search features of an application, you can integrate the application with your SearchAssist application and leverage its extensive features. 

Integration with the SearchAssist application is a two-step process. 

  • Creating client credentials in the SearchAssist application and enabling a communication channel.
  • Configuring the client credentials in the third-party application to start interaction between the two. 

For more information on how to create a SearchAssist application and customize it to return desired results, refer to this guide.

To enable interaction with the SearchAssist application, you need to create a set of credentials, define the API scope for the credentials, and then, associate a communication channel with the credentials. Follow the steps listed below to complete this configuration in the SearchAssist application. 

Go to the Credentials page under the Manage tab. Click on Let’s Start to create your first set of credentials.

Under the Configuration tab, provide a name for the credentials.

Under the API Scopes tab, select the API scopes based on the SearchAssist features required in the third-party application and click Save.  For example, if you only want to enable the search feature of the application, you can select Full Search, Live Search, and Advanced Search APIs.

Next, to enable a communication channel, go to the Channels page under the Manage tab and Click Web/Mobile Client.

This page shows the App Details and Web Client details. These are the details to be configured in the third-party app or web client for interaction with the SearchAssist application.

To get the client credentials to be used in an app, click on App Details. Select the credentials created above from the drop-down menu. The other fields are automatically generated.

Save the fields generated here like the client ID, client secret ID, etc., and use them for communication with this SearchAssist application.