Intelligent Product Triage
Version: 1.0.0
Product Triage is developed in away that you must get the symptoms, leading questions and score using GetSymptoms API. Then, pass the symptoms and score to get relevancy, root cause and its title using the RecommendedSolution API. Include only required symptoms to get the nearest possible solution for the issue. Similarly, the similar issues API returns the similar issues that match the existing issues along with the issue details based on the product parameters and symptoms.
API methods: Get Symptoms
POST /product-intelligent-triage/settings/getSymptom/{project}/{issue}
Return relevant symptoms
Fetch relevant symptoms corresponding to the issue and product attributes.
Parameters
- project(path)
type string required true example sampleProject
- issue(path)
type string required true example black lines in printout
Request body
- Media types
- application/json
Schema - Properties
attribute_name stringexample product name like "oven is not heating" attribute_model stringexample product model like "x1"
type object
Responses
- 200
Success
- Media types
- application/json
Examples - Success
{"status": {"responseType":"success","statusCode":"200"}, "data":"[{ \"leadingquestion\":\"Are you having issues with the Oven light indicators?\", \"score\":8.856132507324219, \"symptoms\":\"on cooking issues oven no power in\"}, {\"leadingquestion\":\"Are you having issues with the Oven powering up?\", \"score\":8.463492393493652, \"symptoms\":\"cooking issues oven no power\"}, {\"leadingquestion\":\"Is the burner element not heating? \", \"score\":7.689003944396973, \"symptoms\":\"elements not heating burners\"}]", "errors":""}
- 400
Internal Server Error
API methods: Similar Issues
POST /product-intelligent-triage/insights/similarissues/{issue}/{project}
Return similar issues
Fetch all the similar issues related to the product attributes and symptoms that are obtain from the getSymptom API.
Parameters
- orgName(header)
type string example HCL
- issue(path)
type string example oven is not heating required true - project(path)
type string example sampleProject required true
Request body
- Media types
- application/json
Schema description In the below example, Model is product attribute followed by symptoms that are obtain from relevant symptoms.
type object array yes - on cooking issues oven no power in
- cooking issues oven no power
- elements not heating burners
array x1
Responses
- 200
Successful response
- Media types
- application/json
Examples - success
{"status": {"responseType": "success","statusCode": "200"},"data": "{\"responsedata\":[{\"description\":\"OVEN NOT HEATING\",\"id\":\"fgBnwH4BFc6TaO0mwbGq\",\"issueid\":\"INC_83\",\"model\":\"x1\",\"part_details\":\"THERMOSTAT\",\"part_number\":\"316032411\",\"product\":\"Premier Oven\",\"project\":\"demohcl\",\"rc_predicted\":\"yes\",\"resolution\":\"CHECKED UNIT OVER REPLACED PARTS TO ALLOW UNIT TO HEAT AND TEST OK\",\"rootcause\":[\"test ok checked unit over replaced\",\"ignitor was faulty tested the unit and found\",\"unit gas erratic replaced tested adjusted front\"],\"score\":\"90%\",\"servicedate\":\"20181130\",\"symptoms\":[\"not heating heat will\",\"oven light not working\",\"on cooking issues oven no power in\"],\"symptoms_predicted\":\"yes\",\"yom\":\"2018\"},{\"description\":\"OVEN NOT HEATING\",\"id\":\"fQBnwH4BFc6TaO0mwbGq\",\"issueid\":\"INC_84\",\"model\":\"x1\",\"part_details\":\"IGNITOR,OVEN BURNER\",\"part_number\":\"5304509706\",\"product\":\"Elite Oven\",\"project\":\"demohcl\",\"rc_predicted\":\"yes\",\"resolution\":\"CHECKED UNIT OVER REPLACED PARTS TO ALLOW UNIT TO HEAT AND TEST OK\",\"rootcause\":[\"test ok checked unit over replaced\",\"ignitor was faulty tested the unit and found\",\"unit gas erratic replaced tested adjusted front\"],\"score\":\"90%\",\"servicedate\":\"20181130\",\"symptoms\":[\"not heating heat will\",\"oven light not working\",\"on cooking issues oven no power in\"],\"symptoms_predicted\":\"yes\",\"yom\":\"2018\"},{\"description\":\"COOKING ISSUES, OPERATIONS, NO HEAT-OVEN NOT WORKING\",\"id\":\"mwBnwH4BFc6TaO0mwbGq\",\"issueid\":\"INC_73\",\"model\":\"x1\",\"part_details\":\"CLOCK/TIMER,ELECTRONIC,ES100\",\"part_number\":\"316455400\",\"product\":\"Regular Oven\",\"project\":\"demohcl\",\"rc_predicted\":\"yes\",\"resolution\":\"REPLACED DEECTIVE CLOCK THAT WILL RECEIVE POWER BUT NOT SEND POWER OUT. UNIT NOW CHECKS OKAY. JOB COMPLETED\",\"rootcause\":[\"error code clock and replaced\",\"to clock wire loose\",\"clock timer and replaced\"],\"score\":\"76%\",\"servicedate\":\"20190111\",\"symptoms\":[\"cooking issues operations no heat\",\"on cooking issues oven no power in\",\"heat cooking issues oven no power in\"],\"symptoms_predicted\":\"yes\",\"yom\":\"2018\"}],\"symptoms\":[]}", "errors": "" }
- 400
Internal Server Error
API methods: Recommended Solution
POST /product-intelligent-triage/settings/RecommendedSolutions/{project}
Populate recommended solutions
Fetch all the recommended solutions related to the product attributes and symptoms that are obtain from the getSymptom API.
Parameters
- orgName(header)
type string example {{org_name}}
- project(path)
type string required true
Request body
- Media types
- application/json
Schema type object example score 8.856132507324219 symptoms on cooking issues oven no power in score 8.463492393493652 symptoms cooking issues oven no power score 7.689003944396973 symptoms elements not heating burners
Responses
- 200
Successful response
- Media types
- application/json
Examples - success
{"status":{"responseType":"success","statusCode":"200"},"data":"[{\"relevancy\":\"35%\",\"rootcause\":\"oven ignitor replaced\",\"rootcause_title\":\"Replace oven ignitor\"},{\"relevancy\":\"35%\",\"rootcause\":\"gas valve burner and\",\"rootcause_title\":\"Replace gas valve \"},{\"relevancy\":\"34%\",\"rootcause\":\"technician replaced unit working properly\",\"rootcause_title\":\"replace burner unit\"},{\"relevancy\":\"34%\",\"rootcause\":\"safety valve and tested\",\"rootcause_title\":\"replace safety valve \"}, {\"relevancy\":\"34%\",\"rootcause\":\"error code clock and replaced\",\"rootcause_title\":\"replace clock \"}, {\"relevancy\":\"27%\",\"rootcause\":\"replaced clock overlay oven temp\",\"rootcause_title\":\"replace clock overlay\"}]", "errors":""}
- 400
Internal Server Error