-
Notifications
You must be signed in to change notification settings - Fork 0
/
knowgo-score-api.yaml
325 lines (325 loc) · 8.87 KB
/
knowgo-score-api.yaml
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
openapi: '3.0.0'
info:
title: KnowGo Score API
version: '0.0.3'
description: >-
KnowGo Score provides a dedicated Scoring microservice capable of working on
a variety of datasources at a variety of resolutions across a range of
pluggable scorers, each with their own weighting. KnowGo Score makes use of
Ensemble Learning methods in order to calculate a Score across a range of
scorers, a subset of which may be applied in the calculation of any
particular Score, dependent upon data availability. Weighted averaging is
further employed in order to allow criteria-specific assessment to be
weighted independently, and to ensure that Scores remain reasonably
approximate across periodic changes in data availability and disclosure.
contact:
name: Adaptant Labs
email: [email protected]
url: 'https://www.adaptant.io/research'
tags:
- name: score
description: Scoring operations
- name: scorers
description: Scorer operations
paths:
'/score/drivers/{driverId}':
parameters:
- in: query
description: Date to end Scoring at
name: untilDate
schema:
type: string
- in: query
description: Date to begin Scoring from
name: fromDate
schema:
type: string
- in: path
description: ID of Driver to Score
name: driverId
required: true
schema:
type: integer
get:
responses:
'200':
description: Driver Successfully Scored
content:
application/json:
schema:
$ref: '#/components/schemas/Score'
'416':
description: Invalid date range specified
'400':
description: Invalid scoring request
'404':
description: Driver not found
summary: Obtain an overall Score for a specific Driver
operationId: getScoreByDriverId
tags:
- score
/score/journeys:
post:
responses:
'200':
description: Journeys Successfully Scored
content:
application/json:
schema:
$ref: '#/components/schemas/Score'
'400':
description: Invalid scoring request
summary: Obtain a Score for provided Journey data
operationId: scoreJourneys
requestBody:
description: Journey data to score
content:
application/json:
schema:
$ref: '#/components/schemas/Journey'
tags:
- score
'/score/journeys/{journeyId}':
parameters:
- in: path
description: ID of Journey to Score
name: journeyId
required: true
schema:
type: string
get:
responses:
'200':
description: Journey Successfully Scored
content:
application/json:
schema:
$ref: '#/components/schemas/Score'
'400':
description: Invalid scoring request
'404':
description: Journey not found
summary: Obtain a Score for a specific Journey
operationId: scoreJourneyById
tags:
- score
/scorers:
post:
summary: Activate one or more Scorer(s)
operationId: activateScorer
tags:
- scorers
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ScorerActivationList'
responses:
'201':
description: Scorer(s) successfully activated
'403':
description: Permission denied
'404':
description: Scorer(s) not found
get:
responses:
'200':
description: Success
content:
application/json:
schema:
properties:
scorers:
type: array
items:
$ref: '#/components/schemas/ScorerList'
summary: Get a list of all Scorers registered with the platform
operationId: listScorers
tags:
- scorers
'/scorers/{scorer}':
parameters:
- in: path
description: Name of Scorer to operate on
name: scorer
required: true
schema:
type: string
get:
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ScorerDetail'
summary: Obtain information about a specific Scorer
operationId: getScorerDetail
tags:
- scorers
put:
responses:
'200':
description: Success
summary: Update the weighting of a given Scorer
operationId: updateScorerWeighting
requestBody:
description: Scorer weighting
content:
application/json:
schema:
$ref: '#/components/schemas/WeightingModel'
tags:
- scorers
delete:
responses:
'200':
description: Scorer successfully deactivated
'403':
description: Permission denied
'404':
description: Scorer not found
summary: Deactivate a specified Scorer
operationId: deactivateScorer
tags:
- scorers
components:
schemas:
Score:
properties:
id:
type: string
description: ID of Journey scored
score:
type: number
description: Score
example: 80.23
minimum: 0
maximum: 100
level:
type: string
description: Score Level
example: High
enum:
- Unscorable
- Negligible
- Minor
- Moderate
- High
num_journeys:
type: integer
description: Number of Journeys included in calculation
confidence:
type: number
description: Overall confidence score
example: 75
minimum: 0
maximum: 100
fromDate:
type: string
format: date
description: Start date of data to score
example: '2019-01-01'
untilDate:
type: string
format: date
description: End date of data to score
example: '2019-12-31'
results:
type: array
items:
$ref: '#/components/schemas/ScoreClassification'
type: object
ScoreClassification:
properties:
scorer:
type: string
description: Name of Scorer run
example: JourneyDurationDetector
score:
type: number
description: Score provided by the Scorer
example: 50
minimum: 0
maximum: 100
weight:
type: integer
description: Weighting applied for the Scorer
example: 50
minimum: 0
maximum: 100
confidence:
type: number
description: Confidence score returned by the Scorer
example: 75
minimum: 0
maximum: 100
type: object
Journey:
properties:
DriverID:
type: integer
description: Driver ID
AutoID:
type: integer
description: Auto ID
JourneyID:
type: string
description: JourneyID
JourneyBegin:
type: string
format: date-time
description: Journey start time
JourneyEnd:
type: string
format: date-time
description: Journey end time
type: object
WeightingModel:
properties:
weighting:
type: integer
description: Weighting applied for the Scorer in the combined Score
example: '50'
type: object
ScorerDetail:
properties:
name:
type: string
description: Short name of the Scorer
example: JourneyDurationDetector
description:
type: string
description: A brief description of the Scorer
example: A linear regression model implementing Regulation (EC) No 561/2006
weighting:
type: integer
description: Weighting applied for the Scorer in the combined Score
example: '50'
type: object
ScorerActivationList:
type: object
required:
- scorers
properties:
scorers:
uniqueItems: true
type: array
items:
type: string
example: JourneyDurationDetector
ScorerList:
properties:
active:
type: array
items:
type: string
description: Short name of the Scorer
example: JourneyDurationDetector
available:
type: array
items:
type: string
description: Short name of the Scorer
example: NightDrivingDetector
type: object