-
Notifications
You must be signed in to change notification settings - Fork 243
Expand file tree
/
Copy pathqdrant.py
More file actions
649 lines (583 loc) · 25.4 KB
/
Copy pathqdrant.py
File metadata and controls
649 lines (583 loc) · 25.4 KB
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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
import uuid
from dataclasses import dataclass, field
from typing import (
TYPE_CHECKING,
Any,
Dict,
Generator,
Generic,
List,
Optional,
Sequence,
Tuple,
Type,
TypeVar,
Union,
cast,
)
import numpy as np
from grpc import RpcError # type: ignore[import]
import docarray.typing.id
from docarray import BaseDoc, DocList
from docarray.array.any_array import AnyDocArray
from docarray.index.abstract import (
BaseDocIndex,
_ColumnInfo,
_FindResultBatched,
_raise_not_composable,
)
from docarray.typing import NdArray
from docarray.typing.tensor.abstract_tensor import AbstractTensor
from docarray.utils._internal._typing import safe_issubclass
from docarray.utils._internal.misc import import_library, torch_imported
from docarray.utils.find import _FindResult
if TYPE_CHECKING:
import qdrant_client
from qdrant_client.conversions import common_types as types
from qdrant_client.http import models as rest
from qdrant_client.http.exceptions import UnexpectedResponse
else:
qdrant_client = import_library('qdrant_client')
from qdrant_client.conversions import common_types as types
from qdrant_client.http import models as rest
from qdrant_client.http.exceptions import UnexpectedResponse
TSchema = TypeVar('TSchema', bound=BaseDoc)
QDRANT_PY_VECTOR_TYPES: List[Any] = [np.ndarray, AbstractTensor]
if torch_imported:
import torch
QDRANT_PY_VECTOR_TYPES.append(torch.Tensor)
QDRANT_SPACE_MAPPING = {
'cosine': rest.Distance.COSINE,
'l2': rest.Distance.EUCLID,
'ip': rest.Distance.DOT,
}
RawQuery = Dict[str, Any]
class QdrantDocumentIndex(BaseDocIndex, Generic[TSchema]):
UUID_NAMESPACE = uuid.UUID('3896d314-1e95-4a3a-b45a-945f9f0b541d')
def __init__(self, db_config=None, **kwargs):
"""Initialize QdrantDocumentIndex"""
if db_config is not None and getattr(
db_config, 'index_name'
): # this is needed for subindices
db_config.collection_name = db_config.index_name
super().__init__(db_config=db_config, **kwargs)
self._db_config: QdrantDocumentIndex.DBConfig = cast(
QdrantDocumentIndex.DBConfig, self._db_config
)
self._client = qdrant_client.QdrantClient(
location=self._db_config.location,
url=self._db_config.url,
port=self._db_config.port,
grpc_port=self._db_config.grpc_port,
prefer_grpc=self._db_config.prefer_grpc,
https=self._db_config.https,
api_key=self._db_config.api_key,
prefix=self._db_config.prefix,
timeout=self._db_config.timeout,
host=self._db_config.host,
path=self._db_config.path,
)
self._initialize_collection()
self._logger.info(f'{self.__class__.__name__} has been initialized')
@property
def collection_name(self):
default_collection_name = (
self._schema.__name__.lower() if self._schema is not None else None
)
if default_collection_name is None:
raise ValueError(
'A QdrantDocumentIndex must be typed with a Document type.'
'To do so, use the syntax: QdrantDocumentIndex[DocumentType]'
)
return self._db_config.collection_name or default_collection_name
@property
def index_name(self):
return self.collection_name
@dataclass
class Query:
"""Dataclass describing a query."""
vector_field: Optional[str]
vector_query: Optional[NdArray]
filter: Optional[rest.Filter]
limit: int
class QueryBuilder(BaseDocIndex.QueryBuilder):
def __init__(
self,
vector_search_field: Optional[str] = None,
vector_filters: Optional[List[NdArray]] = None,
payload_filters: Optional[List[rest.Filter]] = None,
text_search_filters: Optional[List[Tuple[str, str]]] = None,
):
self._vector_search_field: Optional[str] = vector_search_field
self._vector_filters: List[NdArray] = vector_filters or []
self._payload_filters: List[rest.Filter] = payload_filters or []
self._text_search_filters: List[Tuple[str, str]] = text_search_filters or []
def build(self, limit: int) -> 'QdrantDocumentIndex.Query':
"""
Build a query object for QdrantDocumentIndex.
:return: QdrantDocumentIndex.Query object
"""
vector_query = None
if len(self._vector_filters) > 0:
# If there are multiple vector queries applied, we can average them and
# perform semantic search on a single vector instead
vector_query = np.average(self._vector_filters, axis=0)
merged_filter = None
if len(self._payload_filters) > 0:
merged_filter = rest.Filter(must=self._payload_filters)
if len(self._text_search_filters) > 0:
# Text search is just a special case of payload filtering, so the
# payload filter is simply extended
merged_filter = merged_filter or rest.Filter(must=[])
for search_field, query in self._text_search_filters:
merged_filter.must.append( # type: ignore[union-attr]
rest.FieldCondition(
key=search_field,
match=rest.MatchText(text=query),
)
)
return QdrantDocumentIndex.Query(
vector_field=self._vector_search_field,
vector_query=vector_query,
filter=merged_filter,
limit=limit,
)
def find( # type: ignore[override]
self, query: NdArray, search_field: str = ''
) -> 'QdrantDocumentIndex.QueryBuilder':
"""
Find k-nearest neighbors of the query.
:param query: query vector for search. Has single axis.
:param search_field: field to perform search on
:return: QueryBuilder object
"""
if self._vector_search_field and self._vector_search_field != search_field:
raise ValueError(
f'Trying to call .find for search_field = {search_field}, but '
f'previously {self._vector_search_field} was used. Only a single '
f'field might be used in chained calls.'
)
return QdrantDocumentIndex.QueryBuilder(
vector_search_field=search_field,
vector_filters=self._vector_filters + [query],
payload_filters=self._payload_filters,
text_search_filters=self._text_search_filters,
)
def filter( # type: ignore[override]
self, filter_query: rest.Filter
) -> 'QdrantDocumentIndex.QueryBuilder':
"""Find documents in the index based on a filter query
:param filter_query: a filter
:return: QueryBuilder object
"""
return QdrantDocumentIndex.QueryBuilder(
vector_search_field=self._vector_search_field,
vector_filters=self._vector_filters,
payload_filters=self._payload_filters + [filter_query],
text_search_filters=self._text_search_filters,
)
def text_search( # type: ignore[override]
self, query: str, search_field: str = ''
) -> 'QdrantDocumentIndex.QueryBuilder':
"""Find documents in the index based on a text search query
:param query: The text to search for
:param search_field: name of the field to search on
:return: QueryBuilder object
"""
return QdrantDocumentIndex.QueryBuilder(
vector_search_field=self._vector_search_field,
vector_filters=self._vector_filters,
payload_filters=self._payload_filters,
text_search_filters=self._text_search_filters + [(search_field, query)],
)
find_batched = _raise_not_composable('find_batched')
filter_batched = _raise_not_composable('filter_batched')
text_search_batched = _raise_not_composable('text_search_batched')
@dataclass
class DBConfig(BaseDocIndex.DBConfig):
"""Dataclass that contains all "static" configurations of QdrantDocumentIndex."""
location: Optional[str] = None
url: Optional[str] = None
port: Optional[int] = 6333
grpc_port: int = 6334
prefer_grpc: bool = True
https: Optional[bool] = None
api_key: Optional[str] = None
prefix: Optional[str] = None
timeout: Optional[float] = None
host: Optional[str] = None
path: Optional[str] = None
collection_name: Optional[str] = None
shard_number: Optional[int] = None
replication_factor: Optional[int] = None
write_consistency_factor: Optional[int] = None
on_disk_payload: Optional[bool] = None
hnsw_config: Optional[types.HnswConfigDiff] = None
optimizers_config: Optional[types.OptimizersConfigDiff] = None
wal_config: Optional[types.WalConfigDiff] = None
quantization_config: Optional[types.QuantizationConfig] = None
default_column_config: Dict[Type, Dict[str, Any]] = field(
default_factory=lambda: {
'id': {}, # type: ignore[dict-item]
'vector': {'dim': 128}, # type: ignore[dict-item]
'payload': {}, # type: ignore[dict-item]
}
)
def __post_init__(self):
if self.collection_name is None and self.index_name is not None:
self.collection_name = self.index_name
if self.index_name is None and self.collection_name is not None:
self.index_name = self.collection_name
@dataclass
class RuntimeConfig(BaseDocIndex.RuntimeConfig):
"""Dataclass that contains all "dynamic" configurations of QdrantDocumentIndex."""
pass
def python_type_to_db_type(self, python_type: Type) -> Any:
"""Map python type to database type.
Takes any python type and returns the corresponding database column type.
:param python_type: a python type.
:return: the corresponding database column type.
"""
if any(issubclass(python_type, vt) for vt in QDRANT_PY_VECTOR_TYPES):
return 'vector'
if safe_issubclass(python_type, docarray.typing.id.ID):
return 'id'
return 'payload'
def _initialize_collection(self):
try:
self._client.get_collection(self.collection_name)
except (UnexpectedResponse, RpcError, ValueError):
vectors_config = {}
for column_name, column_info in self._column_infos.items():
if column_info.db_type == 'vector':
vectors_config[column_name] = self._to_qdrant_vector_params(
column_info
)
self._client.create_collection(
collection_name=self.collection_name,
vectors_config=vectors_config,
shard_number=self._db_config.shard_number,
replication_factor=self._db_config.replication_factor,
write_consistency_factor=self._db_config.write_consistency_factor,
on_disk_payload=self._db_config.on_disk_payload,
hnsw_config=self._db_config.hnsw_config,
optimizers_config=self._db_config.optimizers_config,
wal_config=self._db_config.wal_config,
quantization_config=self._db_config.quantization_config,
)
self._client.create_payload_index(
collection_name=self.collection_name,
field_name='__generated_vectors',
field_schema=rest.PayloadSchemaType.KEYWORD,
)
def _index(self, column_to_data: Dict[str, Generator[Any, None, None]]):
self._index_subindex(column_to_data)
rows = self._transpose_col_value_dict(column_to_data)
# TODO: add batching the documents to avoid timeouts
points = [self._build_point_from_row(row) for row in rows]
self._client.upsert(
collection_name=self.collection_name,
points=points,
)
def num_docs(self) -> int:
"""
Get the number of documents.
"""
return self._client.count(collection_name=self.collection_name).count
def _doc_exists(self, doc_id: str) -> bool:
response, _ = self._client.scroll(
collection_name=self.index_name,
scroll_filter=rest.Filter(
must=[
rest.HasIdCondition(has_id=[self._to_qdrant_id(doc_id)]),
],
),
)
return len(response) > 0
def _del_items(self, doc_ids: Sequence[str]):
items = self._get_items(doc_ids)
if len(items) < len(doc_ids):
found_keys = set(item['id'] for item in items) # type: ignore[index]
missing_keys = set(doc_ids) - found_keys
raise KeyError('Document keys could not found: %s' % ','.join(missing_keys))
self._client.delete(
collection_name=self.collection_name,
points_selector=rest.PointIdsList(
points=[self._to_qdrant_id(doc_id) for doc_id in doc_ids],
),
)
def _get_items(
self, doc_ids: Sequence[str]
) -> Union[Sequence[TSchema], Sequence[Dict[str, Any]]]:
response, _ = self._client.scroll(
collection_name=self.collection_name,
scroll_filter=rest.Filter(
must=[
rest.HasIdCondition(
has_id=[self._to_qdrant_id(doc_id) for doc_id in doc_ids],
),
],
),
limit=len(doc_ids),
with_payload=True,
with_vectors=True,
)
return sorted(
[self._convert_to_doc(point) for point in response],
key=lambda x: doc_ids.index(x['id']),
)
def execute_query(self, query: Union[Query, RawQuery], *args, **kwargs) -> DocList:
"""
Execute a query on the QdrantDocumentIndex.
Can take two kinds of inputs:
1. A native query of the underlying database. This is meant as a passthrough so that you
can enjoy any functionality that is not available through the Document index API.
2. The output of this Document index's `QueryBuilder.build()` method.
:param query: the query to execute
:param args: positional arguments to pass to the query
:param kwargs: keyword arguments to pass to the query
:return: the result of the query
"""
if not isinstance(query, QdrantDocumentIndex.Query):
points = self._execute_raw_query(query.copy())
elif query.vector_field:
# We perform semantic search with some vectors with Qdrant's search method
# should be called
points = self._client.search( # type: ignore[assignment]
collection_name=self.collection_name,
query_vector=(query.vector_field, query.vector_query), # type: ignore[arg-type]
query_filter=rest.Filter(
must=[query.filter],
# The following filter takes care of using only those points which
# do not have the vector generated. Those are excluded from the
# search results.
must_not=[
rest.FieldCondition(
key='__generated_vectors',
match=rest.MatchValue(value=query.vector_field),
)
],
),
limit=query.limit,
with_payload=True,
with_vectors=True,
)
else:
# Just filtering, so Qdrant's scroll has to be used instead
points, _ = self._client.scroll( # type: ignore[assignment]
collection_name=self.collection_name,
scroll_filter=query.filter,
limit=query.limit,
with_payload=True,
with_vectors=True,
)
docs = [self._convert_to_doc(point) for point in points]
return self._dict_list_to_docarray(docs)
def _execute_raw_query(
self, query: RawQuery
) -> Sequence[Union[rest.ScoredPoint, rest.Record]]:
payload_filter = query.pop('filter', None)
if payload_filter:
payload_filter = rest.Filter.parse_obj(payload_filter) # type: ignore[assignment]
if 'vector' in query:
# We perform semantic search with some vectors with Qdrant's search method
# should be called
search_params = query.pop('params', None)
if search_params:
search_params = rest.SearchParams.parse_obj(search_params) # type: ignore[assignment]
points = self._client.search( # type: ignore[assignment]
collection_name=self.collection_name,
query_vector=query.pop('vector'),
query_filter=payload_filter,
search_params=search_params,
**query,
)
else:
# Just filtering, so Qdrant's scroll has to be used instead
points, _ = self._client.scroll( # type: ignore[assignment]
collection_name=self.collection_name,
scroll_filter=payload_filter,
**query,
)
return points
def _find(
self, query: np.ndarray, limit: int, search_field: str = ''
) -> _FindResult:
query_batched = np.expand_dims(query, axis=0)
docs, scores = self._find_batched(
queries=query_batched, limit=limit, search_field=search_field
)
return _FindResult(documents=docs[0], scores=scores[0]) # type: ignore[arg-type]
def _find_batched(
self, queries: np.ndarray, limit: int, search_field: str = ''
) -> _FindResultBatched:
responses = self._client.search_batch(
collection_name=self.collection_name,
requests=[
rest.SearchRequest(
vector=rest.NamedVector(
name=search_field,
vector=query.tolist(), # type: ignore
),
# The following filter takes care of using only those points which
# do not have the vector generated. Those are excluded from the
# search results.
filter=rest.Filter(
must_not=[
rest.FieldCondition(
key='__generated_vectors',
match=rest.MatchValue(value=search_field),
)
]
),
limit=limit,
with_vector=True,
with_payload=True,
)
for query in queries
],
)
return _FindResultBatched(
documents=[
[self._convert_to_doc(point) for point in response]
for response in responses
],
scores=[
NdArray._docarray_from_native(
np.array([point.score for point in response])
)
for response in responses
],
)
def _filter(
self, filter_query: rest.Filter, limit: int
) -> Union[DocList, List[Dict]]:
query_batched = [filter_query]
docs = self._filter_batched(filter_queries=query_batched, limit=limit)
return docs[0]
def _filter_batched(
self, filter_queries: Sequence[rest.Filter], limit: int
) -> Union[List[DocList], List[List[Dict]]]:
responses = []
for filter_query in filter_queries:
# There is no batch scroll available in Qdrant client yet, so we need to
# perform the queries one by one. It will be changed in the future versions.
response, _ = self._client.scroll(
collection_name=self.collection_name,
scroll_filter=filter_query,
limit=limit,
with_payload=True,
with_vectors=True,
)
responses.append(response)
return [
[self._convert_to_doc(point) for point in response]
for response in responses
]
def _text_search(
self, query: str, limit: int, search_field: str = ''
) -> _FindResult:
query_batched = [query]
docs, scores = self._text_search_batched(
queries=query_batched, limit=limit, search_field=search_field
)
return _FindResult(documents=docs[0], scores=scores[0]) # type: ignore[arg-type]
def _text_search_batched(
self, queries: Sequence[str], limit: int, search_field: str = ''
) -> _FindResultBatched:
filter_queries = [
rest.Filter(
must=[
rest.FieldCondition(
key=search_field,
match=rest.MatchText(text=query),
)
]
)
for query in queries
]
documents_batched = self._filter_batched(
filter_queries=filter_queries, limit=limit
)
# Qdrant does not return any scores if we just filter the objects, without using
# semantic search over vectors. Thus, each document is scored with a value of 1
return _FindResultBatched(
documents=documents_batched,
scores=[
NdArray._docarray_from_native(np.ones(len(docs)))
for docs in documents_batched
],
)
def _filter_by_parent_id(self, id: str) -> Optional[List[str]]:
response, _ = self._client.scroll(
collection_name=self.collection_name, # type: ignore
scroll_filter=rest.Filter(
must=[
rest.FieldCondition(
key='parent_id', match=rest.MatchValue(value=id)
)
]
),
with_payload=rest.PayloadSelectorInclude(include=['id']),
)
ids = [point.payload['id'] for point in response] # type: ignore
return ids
def _build_point_from_row(self, row: Dict[str, Any]) -> rest.PointStruct:
point_id = self._to_qdrant_id(row.get('id'))
vectors: Dict[str, List[float]] = {}
payload: Dict[str, Any] = {'__generated_vectors': []}
for column_name, column_info in self._column_infos.items():
if safe_issubclass(column_info.docarray_type, AnyDocArray):
continue
if column_info.db_type in ['id', 'payload']:
payload[column_name] = row.get(column_name)
continue
vector = row.get(column_name)
if column_info.db_type == 'vector' and vector is not None:
vectors[column_name] = vector.tolist()
elif column_info.db_type == 'vector' and vector is None:
# In that case vector was not provided. Qdrant does not support optional
# vectors - each point needs to have all the vectors already assigned.
# Thus, we put a fake embedding with the correct dimensionality and mark
# such point a point with a boolean flag in the payload.
vector_size = column_info.n_dim or column_info.config.get('dim')
vectors[column_name] = np.ones(vector_size).tolist() # type: ignore[arg-type]
payload['__generated_vectors'].append(column_name)
else:
raise ValueError(
f'Could not handle the conversion for column {column_name}. '
f'Column info: {column_info}'
)
return rest.PointStruct(
id=point_id,
vector=vectors,
payload=payload,
)
def _to_qdrant_id(self, external_id: Optional[str]) -> str:
if external_id is None:
return uuid.uuid4().hex
return uuid.uuid5(QdrantDocumentIndex.UUID_NAMESPACE, external_id).hex
def _to_qdrant_vector_params(self, column_info: _ColumnInfo) -> rest.VectorParams:
return rest.VectorParams(
size=column_info.n_dim or column_info.config.get('dim'),
distance=QDRANT_SPACE_MAPPING[column_info.config.get('space', 'cosine')],
)
def _convert_to_doc(
self, point: Union[rest.ScoredPoint, rest.Record]
) -> Dict[str, Any]:
document = cast(Dict[str, Any], point.payload)
generated_vectors = (
document.pop('__generated_vectors')
if '__generated_vectors' in document
else []
)
vectors = point.vector if point.vector else dict()
if not isinstance(vectors, dict):
vectors = {'__default__': vectors}
for vector_name, vector in vectors.items():
if vector_name in generated_vectors:
# That means the vector was generated during the upload, and should not
# be returned along the other vectors.
pass
document[vector_name] = vector
return document