Using Intelliservice API
IntelliService REST APIs allow you to access IntelliService features of conversational AI, cognitive search and product intelligent triage. As these APIs are built as REST Web service, requests made to a resource's URI will get an HTTP response with a payload formatted in JSON format.
To work with IntelliService APIs, you must have the knowledge in:
- Making HTTP requests using GET and POST methods
- Generating and reading data in JSON format
- Making requests with body parameters and response body parameters in JSON format
- Setting up HTTP basic authentication like bearer token. Bearer token for specific SKUs can be generated based on the request from the user.
List of Public APIs
| Feature | Public API | Description |
| General | Create Project: (/botbuilder/project) | Creates a new project in specified organization. |
| Delete Project: (/botbuilder/project/{projectName}/{language}) | Delete the specific project. | |
| Smart FAQ | Upload Excel or Word files: (/botbuilder/smartfaq/upload) | Uploaded bulk FAQs either in Excel or Word format. |
| Add questions, alternate questions and responses: (/botbuilder/smartfaq/qna) | Add a single question and response. | |
| Query SmartFAQ: (Currently unable to test in postman or swagger. As it requires chat server engine for testing) | Return FAQ responses for the queries. | |
| Cognitive Search | Upload PDF files: (/ctrainer/train/upload) | Upload structured or unstructured PDF files for cognitive search. |
| Upload Base URL: (/botbuilder/urlmining) | Upload base url with constraints to train webpage data. | |
| Query Cognitive Search: (/botbuilder/cognitive/cognitivesearch) | Return cognitive response for the queries. | |
| Product Intelligent Triage | Get recommended solutions: (/product-intelligent-triage/settings/RecommendedSolutions/{project}}) | Return recommended solutions along with scores and leading questions. |
| Get similar issues: (/product-intelligent-triage/insights/similarissues/{issue}/{project}) | Return similar issues for the issue | |
| Get Similar Symptoms: (/product-intelligent-triage/settings/getSymptom/{project}/{issue}) | Return similar symptoms for the issue. |