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 |