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

Add FAQs

To add FAQs, follow the below steps:

  1. Log in to the SearchAssist application with valid credentials.
  2. On the Indices page, click FAQs on the left pane.
  3. On the FAQs page, you can add FAQs through the below-listed methods:
    1. Extract FAQs
    2. Import FAQs
    3. Add FAQs Manually

Extract FAQs

In SearchAssist, the Extract FAQs option allows business users to extract all the FAQs that are available in a PDF file or web URL. You can only extract PDF files.

To add FAQs through the Extract FAQs option, follow the below steps:

  1. On the Indices page, click FAQs on the left pane.
  2. On the FAQs page, click the Add drop-down list and select Extract FAQs.
  3. On the Extract FAQs dialog box, enter a name in the Source Title field and a description in the Description field.
  4. You can extract FAQs from a file or URL:
    1. From the Extract from File section, drag and drop a file or click Browse to locate the PDF file.
    2. From the Extract from URL section, enter a domain URL in the Enter URL field.
  5. For the Extract from File option, you can annotate and extract the uploaded file. Select the Annotate & Extract checkbox to enable it.
  6. Click Proceed.
  7. On the How to Annotate dialog box, click Get Started.
  8. On the Annotate Document page, you can find the document info, annotation summary, and annotation classification of the uploaded file on the right pane.
  9. Select Ignore Page checkbox and click Extract on the top-right.
  10. On the Extract FAQs dialog box, you can find the extraction status. If required, you can cancel the extraction or click OK after the extraction is complete.

Import FAQs

The Import FAQS option in SearchAssist allows business users to import FAQs from a CSV or JSON file. CSV or JSON must follow the format that SearchAssist supports. For example, let us consider an e-commerce website. The business user can import the product catalog details in the form of a CSV or JSON file.

To add FAQs through the Import FAQs option, follow the below steps:

  1. On the Indices page, click FAQs on the left pane.
  2. On the FAQs page, click the Add drop-down list and select Import FAQs.
  3. On the Import FAQs dialog box, enter a name in the Source Title field and a description in the Description field.
  4. You can extract FAQs from a file or URL:
    1. From the Extract from File section, drag and drop a file or click Browse to locate the file.
    2. From the Extract from URL section, enter a domain URL in the Enter URL field.

Click Proceed.

Add FAQs Manually

If you need to supplement the FAQs or don’t have a source for FAQs, you can add them manually. With this option, you can enter the Question-Response pair for each FAQ.

To add FAQs manually, follow the below steps:

  1. On the Indices page, click FAQs on the left pane.
  2. On the FAQs page, click the Add drop-down list and select Add FAQs Manually.
  3. On the Add FAQs dialog box, enter a question in the Question field.
  4. Under the Answers section, click + Add Bot Response.
  5. On the Editor layout, type the bot response. You can also click the Code tab to add the response as JavaScript.
  6. You can also add conditions to the bot response. To add, turn on the Conditions toggle. 
    • Under the Conditions section, select a context from the Select Context drop-down list.
      • Search Context – It is used to optimize search results based on the context provided by the user.
      • Page Context – It is the data that is specifically assigned to a page.
      • User Context – It is the data that is specifically assigned to a search user.
    • Select the criteria from the Set Criteria drop-down lists.
  1. Click Save.

Add FAQs

To add FAQs, follow the below steps:

  1. Log in to the SearchAssist application with valid credentials.
  2. On the Indices page, click FAQs on the left pane.
  3. On the FAQs page, you can add FAQs through the below-listed methods:
    1. Extract FAQs
    2. Import FAQs
    3. Add FAQs Manually

Extract FAQs

In SearchAssist, the Extract FAQs option allows business users to extract all the FAQs that are available in a PDF file or web URL. You can only extract PDF files.

To add FAQs through the Extract FAQs option, follow the below steps:

  1. On the Indices page, click FAQs on the left pane.
  2. On the FAQs page, click the Add drop-down list and select Extract FAQs.
  3. On the Extract FAQs dialog box, enter a name in the Source Title field and a description in the Description field.
  4. You can extract FAQs from a file or URL:
    1. From the Extract from File section, drag and drop a file or click Browse to locate the PDF file.
    2. From the Extract from URL section, enter a domain URL in the Enter URL field.
  5. For the Extract from File option, you can annotate and extract the uploaded file. Select the Annotate & Extract checkbox to enable it.
  6. Click Proceed.
  7. On the How to Annotate dialog box, click Get Started.
  8. On the Annotate Document page, you can find the document info, annotation summary, and annotation classification of the uploaded file on the right pane.
  9. Select Ignore Page checkbox and click Extract on the top-right.
  10. On the Extract FAQs dialog box, you can find the extraction status. If required, you can cancel the extraction or click OK after the extraction is complete.

Import FAQs

The Import FAQS option in SearchAssist allows business users to import FAQs from a CSV or JSON file. CSV or JSON must follow the format that SearchAssist supports. For example, let us consider an e-commerce website. The business user can import the product catalog details in the form of a CSV or JSON file.

To add FAQs through the Import FAQs option, follow the below steps:

  1. On the Indices page, click FAQs on the left pane.
  2. On the FAQs page, click the Add drop-down list and select Import FAQs.
  3. On the Import FAQs dialog box, enter a name in the Source Title field and a description in the Description field.
  4. You can extract FAQs from a file or URL:
    1. From the Extract from File section, drag and drop a file or click Browse to locate the file.
    2. From the Extract from URL section, enter a domain URL in the Enter URL field.

Click Proceed.

Add FAQs Manually

If you need to supplement the FAQs or don’t have a source for FAQs, you can add them manually. With this option, you can enter the Question-Response pair for each FAQ.

To add FAQs manually, follow the below steps:

  1. On the Indices page, click FAQs on the left pane.
  2. On the FAQs page, click the Add drop-down list and select Add FAQs Manually.
  3. On the Add FAQs dialog box, enter a question in the Question field.
  4. Under the Answers section, click + Add Bot Response.
  5. On the Editor layout, type the bot response. You can also click the Code tab to add the response as JavaScript.
  6. You can also add conditions to the bot response. To add, turn on the Conditions toggle. 
    • Under the Conditions section, select a context from the Select Context drop-down list.
      • Search Context – It is used to optimize search results based on the context provided by the user.
      • Page Context – It is the data that is specifically assigned to a page.
      • User Context – It is the data that is specifically assigned to a search user.
    • Select the criteria from the Set Criteria drop-down lists.
  1. Click Save.