ferelight/openapi.yaml at main · FEREorg/ferelight · 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
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
openapi: 3.0.1
info:
  title: FERElight
  description: API for the lightweight feature extraction and retrieval engine (FERElight).
  version: 1.1.0
components:
  schemas:
    multimediaobject:
      type: object
      properties:
        objectid:
          type: string
          description: The unique identifier of the object.
        mediatype:
          type: integer
          description: The mediatype enum value of the object.
        name:
          type: string
          description: The name of the object.
        path:
          type: string
          description: The path of the object.
    multimediasegment:
      type: object
      properties:
        segmentid:
          type: string
          description: The unique identifier of the segment.
        objectid:
          type: string
          description: The unique identifier of the object.
        segmentnumber:
          type: integer
          description: The segment number.
        segmentstart:
          type: integer
          description: The start frame of the segment.
        segmentend:
          type: integer
          description: The end frame of the segment.
        segmentstartabs:
          type: number
          description: The double value of the start time in seconds of the segment.
        segmentendabs:
          type: number
          description: The double value of the end time in seconds of the segment.
    scoredsegment:
      type: object
      properties:
        segmentid:
          type: string
          description: The unique identifier of the segment.
        score:
          type: number
          description: The similarity score of the segment.
paths:
  /objectinfo/{database}/{objectid}:
    get:
      summary: Get the information of an object.
      parameters:
        - name: database
          in: path
          required: true
          description: The name of the database to query for the object.
          schema:
            type: string
        - name: objectid
          in: path
          required: true
          description: The unique identifier of the object.
          schema:
            type: string
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/multimediaobject"
  /segmentinfo/{database}/{segmentid}:
    get:
      summary: Get the information of a segment.
      parameters:
        - name: database
          in: path
          required: true
          description: The name of the database to query for the segment.
          schema:
            type: string
        - name: segmentid
          in: path
          required: true
          description: The unique identifier of the segment.
          schema:
            type: string
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/multimediasegment"
  /objectsegments/{database}/{objectid}:
    get:
      summary: Get the segments of an object.
      parameters:
        - name: database
          in: path
          required: true
          description: The name of the database to query for the object.
          schema:
            type: string
        - name: objectid
          in: path
          required: true
          description: The unique identifier of the object.
          schema:
            type: string
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/multimediasegment"
  /objectinfos:
    post:
      summary: Get the information of multiple objects.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                database:
                  type: string
                  description: The name of the database to query for the objects.
                objectids:
                  type: array
                  items:
                    type: string
                  description: The unique identifiers of the objects.
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/multimediaobject"
  /segmentinfos:
    post:
      summary: Get the information of multiple segments.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                database:
                  type: string
                  description: The name of the database to query for the segments.
                segmentids:
                  type: array
                  items:
                    type: string
                  description: The unique identifiers of the segments.
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/multimediasegment"
  # Query endpoint with similarity text and OCR text as input and list of segment ID and similarity score pairs as output
  /query:
    post:
      summary: Query the FERElight engine.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                database:
                  type: string
                  description: The name of the database to query.
                similaritytext:
                  type: string
                  description: The similarity text.
                ocrtext:
                  type: string
                  description: The OCR text.
                limit:
                  type: integer
                  description: The maximum number of results to return.
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/scoredsegment"
  /querybyexample:
    post:
      summary: Get the nearest neighbors of a segment.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                database:
                  type: string
                  description: The name of the database to query.
                segmentid:
                  type: string
                  description: The segment ID to find neighbors for.
                limit:
                  type: integer
                  description: The maximum number of results to return.
                  default: 10
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/scoredsegment'
  /segmentbytime:
    post:
      summary: Get the segment ID for a given timestamp and object.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                database:
                  type: string
                  description: The name of the database to query.
                objectid:
                  type: string
                  description: The object ID to find the segment in.
                timestamp:
                  type: number
                  description: The timestamp to match against.
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  segmentid:
                    type: string
                    description: Matching segment ID.