FAQ Retrieval
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.
Authorization
The operations carried out by the FAQ Retrieval API can be accessed by all roles.
Search For Answers
| 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
|
| Parameter
|
Type
|
Description
|
| {kbId}
|
String
|
Knowledge base ID
|
|
| URL parameters
|
| Parameter
|
Type
|
Reqired
|
Default
|
Description
|
| spellcheck
|
Boolean
|
No
|
false
|
Spell checking strategy
|
| lang
|
String
|
No
|
"_default"
|
Language ID
|
| sessionId
|
String
|
No
|
—
|
Session ID
|
| size
|
Integer
|
No
|
Configuration
|
Count of documents for retrieving
|
|
| Request
|
SearchRequest
|
| Response
|
| Field
|
Type
|
Description
|
| count
|
int
|
Total count of documents in selection (pagination-independent)
|
| documents
|
ConfidentDocumentEntry
|
Resulting selection of document
|
| categories
|
CategoryFacetItem
|
Facet selection of categories, related to selected document set
|
|
| Notes
|
If successful, 200 OK is returned. However, if the dataset already exists, 400 BAD REQUEST is returned.
|
IntelliSense
| Description
|
IntelliSense
|
| URL
|
/kbs/{kbId}/suggestions
|
| Method
|
POST
|
| Request Content-Type
|
—
|
| Response Content-Type
|
application/json
|
| Role
|
Any
|
| URL IDs
|
| Parameter
|
Type
|
Description
|
| {kbId}
|
String
|
Knowledge base ID
|
|
URL parameters
|
| Parameter
|
Type
|
Required
|
Default
|
Description
|
| lang
|
String
|
No
|
"_default"
|
Language ID
|
| sessionId
|
String
|
No
|
—
|
Session ID
|
|
| Request
|
SearchRequest
|
| Output
|
| Parameter
|
Type
|
Description
|
| suggestions
|
String[]
|
Autocompletion suggestions
|
|
| Notes
|
If successful, 200 OK is returned. However, if the dataset already exists, 400 BAD REQUEST is returned.
|
More Like This
| 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
|
| Parameter
|
Type
|
Description
|
| {kbId}
|
String
|
Knowledge base ID
|
| {docId}
|
String
|
Document ID
|
|
| Parameters
|
| Parameter
|
Type
|
Required
|
Default
|
Description
|
| lang
|
String
|
No
|
"_default"
|
Language ID
|
| sessionId
|
String
|
No
|
—
|
Session ID
|
|
| Response
|
| Field
|
Type
|
Description
|
| count
|
int
|
Total count of documents in selection (pagination-independent)
|
| documents
|
ConfidentDocumentEntry
|
Resulting selection of document
|
| categories
|
CategoryFacetItem
|
Facet selection of categories, related to selected document set
|
|
| Notes
|
If successful, 200 OK is returned. However, if the dataset already exists, 400 BAD REQUEST is returned.
|
Guess Spelling Correction
| 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
|
| Parameter
|
Type
|
Description
|
| {kbId}
|
String
|
Knowledge base ID
|
|
| Parameters
|
| Parameter
|
Type
|
Req?
|
Description
|
| lang
|
String
|
No
|
Language ID, or _default
|
| number
|
int
|
No
|
Number of suggestions to be proposed. The default value is 1
|
| text
|
String
|
Yes
|
Text for spell checking
|
|
| Request
|
Empty
|
| Response
|
| Field
|
Type
|
Description
|
| suggestions
|
suggestion[]
|
Spell check suggestions
|
Each item of suggestions has the following structure
| Field
|
Type
|
Description
|
| word
|
String
|
Token from checked text
|
| suggestions
|
String[]
|
Suggestions for spell correction in descending order of relevancy
|
|
| Notes
|
If successful, 200 OK is returned. However, if the dataset already exists, 400 BAD REQUEST is returned.
|
