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
SharePoint Connector
Confluence Cloud Connector
Confluence Server Connector
Zendesk Connector
ServiceNow Connector
Salesforce Connector
Azure Storage Connector
Google Drive Connector
Dropbox Connector
Oracle Knowledge Connector
DotCMS 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

SearchAssist Public API List

Following is the list of APIs available in SearchAssist. Refer to the respective API page for details on the functionality or usage instructions. 

API Description  Scope
Full Search Returns search results and answers corresponding to the input query. Full Search
Live Search  Dynamically returns search results corresponding to the input query. Note that this API does not return answers.   Live Search
Advanced Search  Returns search results and answers corresponding to the input query and the meta filters sent in the request body.   Advanced Search
Auto Suggestions  Returns predictions related to the input query.  Used to provide autocomplete functionality for text-based search. Auto Suggestions
Ingest  Ingests data into the SearchAssist application. Ingest Data
Train  Trains the SearchAssist application with all the ingested content or specific data using the default Index and Search configuration.   Train
Add Index Fields Creates one or more index fields in the SearchAssist application.  Fields
Update Index Fields Updates the values for one or more index fields in the SearchAssist application.  Fields
Get Index Fields Fetches the index fields from the SearchAssist application. Fields
Delete Index Fields Deletes index fields from the SearchAssist application.  Fields
Edit Index Field by Id Edits a specific index field in the SearchAssist application Fields
Get Index Field by Id Fetches a specific index field from the SearchAssist application.  Fields
Get Content Fetches content records from the SearchAssist application Content
Delete Content Deletes ingested content from the SearchAssist application Content
Get Content by Condition Fetches specific content records from the SearchAssist application Content
Import Index Configuration Imports one or more index configurations to the SearchAssist application.  App Settings
Export Index Configuration Exports all the index configurations present in the SearchAssist application. App Settings
History Fetches logs corresponding to a user’s interaction with the SearchAssist application. Analytics
UploadFile Uploads a file to a server. To ingest this file in the SearchAssist application, use the Ingest API.  Ingest Data
Incremental Web Crawling Crawls and indexes a web page to a given web source without making changes to the existing configuration or recrawling the existing pages.  Ingest Data
Fetch Debug Information  Retrieves debug information corresponding to the answers and search results returned in response of the previous fullsearch or advancedSearch request. Full Search
Feedback API Updates user feedback to an answer in the SearchAssist application.  Analytics
Get Chunks Retrieves all the chunks from the SearchAssist application Chunks
Get Chunks By ID Retrieves a specific chunk from the SearchAssist application Chunks
Update Chunk By ID Updates a specific chunk Chunks
Permission Entity APIs Manage Permission Entities and add or delete users from entities. user_association
Get Analytics Fetch Analytics Data generated by the application  Analytics
Export Analytics Export Analytics Data  Analytics

SearchAssist Public API List

Following is the list of APIs available in SearchAssist. Refer to the respective API page for details on the functionality or usage instructions. 

API Description  Scope
Full Search Returns search results and answers corresponding to the input query. Full Search
Live Search  Dynamically returns search results corresponding to the input query. Note that this API does not return answers.   Live Search
Advanced Search  Returns search results and answers corresponding to the input query and the meta filters sent in the request body.   Advanced Search
Auto Suggestions  Returns predictions related to the input query.  Used to provide autocomplete functionality for text-based search. Auto Suggestions
Ingest  Ingests data into the SearchAssist application. Ingest Data
Train  Trains the SearchAssist application with all the ingested content or specific data using the default Index and Search configuration.   Train
Add Index Fields Creates one or more index fields in the SearchAssist application.  Fields
Update Index Fields Updates the values for one or more index fields in the SearchAssist application.  Fields
Get Index Fields Fetches the index fields from the SearchAssist application. Fields
Delete Index Fields Deletes index fields from the SearchAssist application.  Fields
Edit Index Field by Id Edits a specific index field in the SearchAssist application Fields
Get Index Field by Id Fetches a specific index field from the SearchAssist application.  Fields
Get Content Fetches content records from the SearchAssist application Content
Delete Content Deletes ingested content from the SearchAssist application Content
Get Content by Condition Fetches specific content records from the SearchAssist application Content
Import Index Configuration Imports one or more index configurations to the SearchAssist application.  App Settings
Export Index Configuration Exports all the index configurations present in the SearchAssist application. App Settings
History Fetches logs corresponding to a user’s interaction with the SearchAssist application. Analytics
UploadFile Uploads a file to a server. To ingest this file in the SearchAssist application, use the Ingest API.  Ingest Data
Incremental Web Crawling Crawls and indexes a web page to a given web source without making changes to the existing configuration or recrawling the existing pages.  Ingest Data
Fetch Debug Information  Retrieves debug information corresponding to the answers and search results returned in response of the previous fullsearch or advancedSearch request. Full Search
Feedback API Updates user feedback to an answer in the SearchAssist application.  Analytics
Get Chunks Retrieves all the chunks from the SearchAssist application Chunks
Get Chunks By ID Retrieves a specific chunk from the SearchAssist application Chunks
Update Chunk By ID Updates a specific chunk Chunks
Permission Entity APIs Manage Permission Entities and add or delete users from entities. user_association
Get Analytics Fetch Analytics Data generated by the application  Analytics
Export Analytics Export Analytics Data  Analytics