qdrant

1
#@ load("openapi.lib.yml", "response", "reference", "type", "array")
2

3
paths:
4
  /collections/{collection_name}/points/{id}:
5
    get:
6
      tags:
7
        - points
8
      summary: Get point
9
      description: Retrieve full information of single point by id
10
      operationId: get_point
11
      parameters:
12
        - name: collection_name
13
          in: path
14
          description: Name of the collection to retrieve from
15
          required: true
16
          schema:
17
            type: string
18
        - name: id
19
          in: path
20
          description: Id of the point
21
          required: true
22
          schema:
23
            $ref: "#/components/schemas/ExtendedPointId"
24
        - name: consistency
25
          in: query
26
          description: Define read consistency guarantees for the operation
27
          required: false
28
          schema:
29
            $ref: "#/components/schemas/ReadConsistency"
30
      responses: #@ response(reference("Record"))
31

32
  /collections/{collection_name}/points:
33
    post:
34
      tags:
35
        - points
36
      summary: Get points
37
      description: Retrieve multiple points by specified IDs
38
      operationId: get_points
39
      requestBody:
40
        description: List of points to retrieve
41
        content:
42
          application/json:
43
            schema:
44
              $ref: "#/components/schemas/PointRequest"
45

46
      parameters:
47
        - name: collection_name
48
          in: path
49
          description: Name of the collection to retrieve from
50
          required: true
51
          schema:
52
            type: string
53
        - name: consistency
54
          in: query
55
          description: Define read consistency guarantees for the operation
56
          required: false
57
          schema:
58
            $ref: "#/components/schemas/ReadConsistency"
59
      responses: #@ response(array(reference("Record")))
60

61
    put:
62
      tags:
63
        - points
64
      summary: Upsert points
65
      description: Perform insert + updates on points. If point with given ID already exists - it will be overwritten.
66
      operationId: upsert_points
67
      requestBody:
68
        description: Operation to perform on points
69
        content:
70
          application/json:
71
            schema:
72
              $ref: "#/components/schemas/PointInsertOperations"
73

74
      parameters:
75
        - name: collection_name
76
          in: path
77
          description: Name of the collection to update from
78
          required: true
79
          schema:
80
            type: string
81
        - name: wait
82
          in: query
83
          description: "If true, wait for changes to actually happen"
84
          required: false
85
          schema:
86
            type: boolean
87
        - name: ordering
88
          in: query
89
          description: "define ordering guarantees for the operation"
90
          required: false
91
          schema:
92
            $ref: "#/components/schemas/WriteOrdering"
93
      responses: #@ response(reference("UpdateResult"))
94

95
  /collections/{collection_name}/points/delete:
96
    post:
97
      tags:
98
        - points
99
      summary: Delete points
100
      description: Delete points
101
      operationId: delete_points
102
      requestBody:
103
        description: Operation to perform on points
104
        content:
105
          application/json:
106
            schema:
107
              $ref: "#/components/schemas/PointsSelector"
108

109
      parameters:
110
        - name: collection_name
111
          in: path
112
          description: Name of the collection to delete from
113
          required: true
114
          schema:
115
            type: string
116
        - name: wait
117
          in: query
118
          description: "If true, wait for changes to actually happen"
119
          required: false
120
          schema:
121
            type: boolean
122
        - name: ordering
123
          in: query
124
          description: "define ordering guarantees for the operation"
125
          required: false
126
          schema:
127
            $ref: "#/components/schemas/WriteOrdering"
128
      responses: #@ response(reference("UpdateResult"))
129

130
  /collections/{collection_name}/points/vectors:
131
    put:
132
      tags:
133
        - points
134
      summary: Update vectors
135
      description: Update specified named vectors on points, keep unspecified vectors intact.
136
      operationId: update_vectors
137
      requestBody:
138
        description: Update named vectors on points
139
        content:
140
          application/json:
141
            schema:
142
              $ref: "#/components/schemas/UpdateVectors"
143

144
      parameters:
145
        - name: collection_name
146
          in: path
147
          description: Name of the collection to update from
148
          required: true
149
          schema:
150
            type: string
151
        - name: wait
152
          in: query
153
          description: "If true, wait for changes to actually happen"
154
          required: false
155
          schema:
156
            type: boolean
157
        - name: ordering
158
          in: query
159
          description: "define ordering guarantees for the operation"
160
          required: false
161
          schema:
162
            $ref: "#/components/schemas/WriteOrdering"
163
      responses: #@ response(reference("UpdateResult"))
164

165
  /collections/{collection_name}/points/vectors/delete:
166
    post:
167
      tags:
168
        - points
169
      summary: Delete vectors
170
      description: Delete named vectors from the given points.
171
      operationId: delete_vectors
172
      requestBody:
173
        description: Delete named vectors from points
174
        content:
175
          application/json:
176
            schema:
177
              $ref: "#/components/schemas/DeleteVectors"
178

179
      parameters:
180
        - name: collection_name
181
          in: path
182
          description: Name of the collection to delete from
183
          required: true
184
          schema:
185
            type: string
186
        - name: wait
187
          in: query
188
          description: "If true, wait for changes to actually happen"
189
          required: false
190
          schema:
191
            type: boolean
192
        - name: ordering
193
          in: query
194
          description: "define ordering guarantees for the operation"
195
          required: false
196
          schema:
197
            $ref: "#/components/schemas/WriteOrdering"
198
      responses: #@ response(reference("UpdateResult"))
199

200
  /collections/{collection_name}/points/payload:
201
    post:
202
      tags:
203
        - points
204
      summary: Set payload
205
      description: Set payload values for points
206
      operationId: set_payload
207
      requestBody:
208
        description: Set payload on points
209
        content:
210
          application/json:
211
            schema:
212
              $ref: "#/components/schemas/SetPayload"
213

214
      parameters:
215
        - name: collection_name
216
          in: path
217
          description: Name of the collection to set from
218
          required: true
219
          schema:
220
            type: string
221
        - name: wait
222
          in: query
223
          description: "If true, wait for changes to actually happen"
224
          required: false
225
          schema:
226
            type: boolean
227
        - name: ordering
228
          in: query
229
          description: "define ordering guarantees for the operation"
230
          required: false
231
          schema:
232
            $ref: "#/components/schemas/WriteOrdering"
233
      responses: #@ response(reference("UpdateResult"))
234
    put:
235
      tags:
236
        - points
237
      summary: Overwrite payload
238
      description: Replace full payload of points with new one
239
      operationId: overwrite_payload
240
      requestBody:
241
        description: Payload and points selector
242
        content:
243
          application/json:
244
            schema:
245
              $ref: "#/components/schemas/SetPayload"
246

247
      parameters:
248
        - name: collection_name
249
          in: path
250
          description: Name of the collection to set from
251
          required: true
252
          schema:
253
            type: string
254
        - name: wait
255
          in: query
256
          description: "If true, wait for changes to actually happen"
257
          required: false
258
          schema:
259
            type: boolean
260
        - name: ordering
261
          in: query
262
          description: "define ordering guarantees for the operation"
263
          required: false
264
          schema:
265
            $ref: "#/components/schemas/WriteOrdering"
266
      responses: #@ response(reference("UpdateResult"))
267

268
  /collections/{collection_name}/points/payload/delete:
269
    post:
270
      tags:
271
        - points
272
      summary: Delete payload
273
      description: Delete specified key payload for points
274
      operationId: delete_payload
275
      requestBody:
276
        description: delete payload on points
277
        content:
278
          application/json:
279
            schema:
280
              $ref: "#/components/schemas/DeletePayload"
281

282
      parameters:
283
        - name: collection_name
284
          in: path
285
          description: Name of the collection to delete from
286
          required: true
287
          schema:
288
            type: string
289
        - name: wait
290
          in: query
291
          description: "If true, wait for changes to actually happen"
292
          required: false
293
          schema:
294
            type: boolean
295
        - name: ordering
296
          in: query
297
          description: "define ordering guarantees for the operation"
298
          required: false
299
          schema:
300
            $ref: "#/components/schemas/WriteOrdering"
301
      responses: #@ response(reference("UpdateResult"))
302

303
  /collections/{collection_name}/points/payload/clear:
304
    post:
305
      tags:
306
        - points
307
      summary: Clear payload
308
      description: Remove all payload for specified points
309
      operationId: clear_payload
310
      requestBody:
311
        description: clear payload on points
312
        content:
313
          application/json:
314
            schema:
315
              $ref: "#/components/schemas/PointsSelector"
316

317
      parameters:
318
        - name: collection_name
319
          in: path
320
          description: Name of the collection to clear payload from
321
          required: true
322
          schema:
323
            type: string
324
        - name: wait
325
          in: query
326
          description: "If true, wait for changes to actually happen"
327
          required: false
328
          schema:
329
            type: boolean
330
        - name: ordering
331
          in: query
332
          description: "define ordering guarantees for the operation"
333
          required: false
334
          schema:
335
            $ref: "#/components/schemas/WriteOrdering"
336
      responses: #@ response(reference("UpdateResult"))
337
  /collections/{collection_name}/points/batch:
338
    post:
339
      tags:
340
        - points
341
      summary: Batch update points
342
      description: Apply a series of update operations for points, vectors and payloads
343
      operationId: batch_update
344
      requestBody:
345
        description: update operations
346
        content:
347
          application/json:
348
            schema:
349
              $ref: "#/components/schemas/UpdateOperations"
350
      parameters:
351
        - name: collection_name
352
          in: path
353
          description: Name of the collection to apply operations on
354
          required: true
355
          schema:
356
            type: string
357
        - name: wait
358
          in: query
359
          description: "If true, wait for changes to actually happen"
360
          required: false
361
          schema:
362
            type: boolean
363
        - name: ordering
364
          in: query
365
          description: "define ordering guarantees for the operation"
366
          required: false
367
          schema:
368
            $ref: "#/components/schemas/WriteOrdering"
369
      responses: #@ response(array(reference("UpdateResult")))
370