openapi.json

{"openapi": "3.1.0", "info": {"title": "XAI Microservices", "description": "\nxAI Microservices APIs helps you to understand the internal model structure and provide you explanation.\n## Image Class Prediction Service\n\nYou can just pass an image to the Predict API and get prediction back as JSON\n\n## LIME and SHAP Explainability Services\n\nJust pass your image to the LIME Microservice and this service provide you the results in JSON\n\n## Occlusion Sensitivity Explainability Service\n* *Send Image True Label** (_cardboard,glass,metal,paper,plastic,trash_).\n", "termsOfService": "https://dps.cs.ut.ee/index.html", "contact": {"name": "Mehrdad Asadi, Ph.D.", "url": "https://dps.cs.ut.ee/people.html", "email": "mehrdad.asadi@ut.ee"}, "license": {"name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html"}, "version": "0.0.1"}, "servers": [{"url": "http://192.168.42.139/"}], "paths": {"/test": {"get": {"summary": "Read Root", "operationId": "read_root_test_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}}, "/test2": {"get": {"summary": "View Image", "operationId": "view_image_test2_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}}, "/test3": {"get": {"summary": "View Image2", "operationId": "view_image2_test3_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}}, "/predict/image": {"post": {"summary": "Predict Api", "operationId": "predict_api_predict_image_post", "requestBody": {"content": {"multipart/form-data": {"schema": {"$ref": "#/components/schemas/Body_predict_api_predict_image_post"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/explain_lime/image": {"post": {"summary": "Explain Api", "operationId": "explain_api_explain_lime_image_post", "requestBody": {"content": {"multipart/form-data": {"schema": {"$ref": "#/components/schemas/Body_explain_api_explain_lime_image_post"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/explain_shap/image": {"post": {"summary": "Explain Api", "operationId": "explain_api_explain_shap_image_post", "requestBody": {"content": {"multipart/form-data": {"schema": {"$ref": "#/components/schemas/Body_explain_api_explain_shap_image_post"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/explain_occlusion/image": {"post": {"summary": "Explain Api", "operationId": "explain_api_explain_occlusion_image_post", "parameters": [{"name": "imagetype", "in": "query", "required": true, "schema": {"type": "string", "title": "Imagetype"}}], "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"$ref": "#/components/schemas/Body_explain_api_explain_occlusion_image_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}}, "components": {"schemas": {"Body_explain_api_explain_lime_image_post": {"properties": {"file": {"type": "string", "format": "binary", "title": "File"}}, "type": "object", "required": ["file"], "title": "Body_explain_api_explain_lime_image_post"}, "Body_explain_api_explain_occlusion_image_post": {"properties": {"file": {"type": "string", "format": "binary", "title": "File"}}, "type": "object", "required": ["file"], "title": "Body_explain_api_explain_occlusion_image_post"}, "Body_explain_api_explain_shap_image_post": {"properties": {"file": {"type": "string", "format": "binary", "title": "File"}}, "type": "object", "required": ["file"], "title": "Body_explain_api_explain_shap_image_post"}, "Body_predict_api_predict_image_post": {"properties": {"file": {"type": "string", "format": "binary", "title": "File"}}, "type": "object", "required": ["file"], "title": "Body_predict_api_predict_image_post"}, "HTTPValidationError": {"properties": {"detail": {"items": {"$ref": "#/components/schemas/ValidationError"}, "type": "array", "title": "Detail"}}, "type": "object", "title": "HTTPValidationError"}, "ValidationError": {"properties": {"loc": {"items": {"anyOf": [{"type": "string"}, {"type": "integer"}]}, "type": "array", "title": "Location"}, "msg": {"type": "string", "title": "Message"}, "type": {"type": "string", "title": "Error Type"}}, "type": "object", "required": ["loc", "msg", "type"], "title": "ValidationError"}}}}