This page was last edited on August 28, 2015, at 21:42.
Comments or questions about this documentation? Contact us for support!
You can use the FAQ Retrieval API to ask your knowledge base a question and find the answers, and also any documents that are related to this question.
The operations carried out by the FAQ Retrieval API can be accessed by all roles.
Description | Executes a search for the answer to the given query | |||||||||||||||||||||||||
URL | /kbs/{kbId}/search | |||||||||||||||||||||||||
Method | POST | |||||||||||||||||||||||||
Request Content-Type | application/json | |||||||||||||||||||||||||
Response Content-Type | application/json | |||||||||||||||||||||||||
Role | Any | |||||||||||||||||||||||||
URL IDs |
| |||||||||||||||||||||||||
URL parameters |
| |||||||||||||||||||||||||
Request | SearchRequest | |||||||||||||||||||||||||
Response |
|
Description | IntelliSense | |||||||||||||||
URL | /kbs/{kbId}/suggestions | |||||||||||||||
Method | POST | |||||||||||||||
Request Content-Type | — | |||||||||||||||
Response Content-Type | application/json | |||||||||||||||
Role | Any | |||||||||||||||
URL IDs |
| |||||||||||||||
URL parameters |
| |||||||||||||||
Request | SearchRequest | |||||||||||||||
Output |
|
Description | Returns content that is similar to the content in the specified document | |||||||||||||||
URL | /kbs/{kbId}/documents/{docId}/morelikethis | |||||||||||||||
Method | GET | |||||||||||||||
Request Content-Type | — | |||||||||||||||
Response Content-Type | application/json | |||||||||||||||
Role | Any | |||||||||||||||
URL IDs |
| |||||||||||||||
Parameters |
| |||||||||||||||
Response |
|
Description | Guesses the correct spelling for the entered query | ||||||||||||||||
URL | /kbs/{kbId}/spelling | ||||||||||||||||
Method | GET | ||||||||||||||||
Request Content-Type | — | ||||||||||||||||
Response Content-Type | application/json | ||||||||||||||||
Role | Any | ||||||||||||||||
URL IDs |
| ||||||||||||||||
Parameters |
| ||||||||||||||||
Request | Empty | ||||||||||||||||
Response |
Each item of suggestions has the following structure
|