spatial-backend/openapi.yaml at main · mobile-cloud-computing/spatial-backend · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
openapi: 3.0.2
info:
  title: XAI Microservices
  description: |2
    xAI Microservices APIs helps you to understand the internal model structure and provide you explanation.
    ## Image Class Prediction Service

    You can just pass an image to the Predict API and get prediction back as JSON

    ## LIME and SHAP Explainability Services

    Just pass your image to the LIME Microservice and this service provide you the results in JSON

    ## Occlusion Sensitivity Explainability Service
    * *Send Image True Label** (_cardboard,glass,metal,paper,plastic,trash_).
  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.93
paths:
  /test:
    get:
      summary: Read Root
      operationId: read_root_test_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'
components:
  schemas:
    Body_explain_api_explain_lime_image_post:
      title: Body_explain_api_explain_lime_image_post
      required:
        - file
      type: object
      properties:
        file:
          title: File
          type: string
          format: binary
    Body_explain_api_explain_shap_image_post:
      title: Body_explain_api_explain_shap_image_post
      required:
        - file
      type: object
      properties:
        file:
          title: File
          type: string
          format: binary
    Body_predict_api_predict_image_post:
      title: Body_predict_api_predict_image_post
      required:
        - file
      type: object
      properties:
        file:
          title: File
          type: string
          format: binary
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      properties:
        detail:
          title: Detail
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    ValidationError:
      title: ValidationError
      required:
        - loc
        - msg
        - type
      type: object
      properties:
        loc:
          title: Location
          type: array
          items:
            anyOf:
              - type: string
              - type: integer
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string