SmartFAQ
Version: 1.0.0
SmartFAQ APIs allow to add frequently asked questions and answers, and consume FAQs through conversation ai.
API methods: SmartFAQ
POST /botbuilder/smartfaq/qna
add single FAQ
Add a single question, alternative questions and response for questions in a project under the specific category.
Request body
Required: true
- Media types
- application/json
Schema Faq
Responses
- 201
Added FAQ successfully
POST /botbuilder/smartfaq/upload
upload FAQ files
Uploads PDF or Word document with a set of FAQs into a specific project.
Request body
- Media types
- multipart/form-data
Schema FileUpload
Responses
- 200
Project deleted successfully
POST /botbuilder/smartfaq/search
search FAQ content
Post a question related to the uploaded FAQs. Based on the question, chatbot will return responses related to the uploaded FAQ content.
Request body
Required: true
- Media types
- application/json
Schema SearchFAQ
Responses
- 200
Success
- Media types
- application/json
Examples - Success Response
{ "description": "Explain FAQ?", "intent": "3168cdd4-bbf5-11ed-83af-b6396ddc8e9e", "project": "SampleProject", "response": "FAQ is frequently asked questions about a particular subject.", "training": { "learn": "what is FAQ?", "relearn": "relearn" }, "type": "en", "isfaq": "faq", "categoryName": "common", "score": "1.6327736" }
Components
Schemas
Faq
- Properties
categoryName stringexample common createdate stringdescription stringexample what is FAQ? intent stringisfaq stringexample faq language stringexample en project stringexample SampleProject recordId stringresponse stringexample FAQ is frequently asked questions about a particular subject. training $ref Training type string
| type | object |
Training
- Properties
learn stringdescription Set as learn and add alternate questions using
example learn. what is FAQ? relearn string
| type | object |
FileUpload
- Properties
files arrayitems string(binary)categoryName stringexample common description stringfileArray stringlanguage stringexample en projectName stringexample Sampleproject tags stringvalidate boolean
| required |
|
| type | object |
SearchFAQ
- Properties
query stringexample Explain FAQ? project stringexample Sampleproject language stringexample en