Spaces:
Runtime error
Runtime error
File size: 15,026 Bytes
4a51346 |
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 |
import pytest
from typing import Generator, List, Callable, Iterator, Dict, Optional, Union, Sequence
from chromadb.config import System, Settings
from chromadb.types import (
SubmitEmbeddingRecord,
MetadataEmbeddingRecord,
Operation,
ScalarEncoding,
Segment,
SegmentScope,
SeqId,
)
from chromadb.ingest import Producer
from chromadb.segment import MetadataReader
import uuid
import time
from chromadb.segment.impl.metadata.sqlite import SqliteMetadataSegment
from pytest import FixtureRequest
from itertools import count
def sqlite() -> Generator[System, None, None]:
"""Fixture generator for sqlite DB"""
settings = Settings(sqlite_database=":memory:", allow_reset=True)
system = System(settings)
system.start()
yield system
system.stop()
def system_fixtures() -> List[Callable[[], Generator[System, None, None]]]:
return [sqlite]
@pytest.fixture(scope="module", params=system_fixtures())
def system(request: FixtureRequest) -> Generator[System, None, None]:
yield next(request.param())
@pytest.fixture(scope="function")
def sample_embeddings() -> Iterator[SubmitEmbeddingRecord]:
def create_record(i: int) -> SubmitEmbeddingRecord:
vector = [i + i * 0.1, i + 1 + i * 0.1]
metadata: Optional[Dict[str, Union[str, int, float]]]
if i == 0:
metadata = None
else:
metadata = {"str_key": f"value_{i}", "int_key": i, "float_key": i + i * 0.1}
if i % 3 == 0:
metadata["div_by_three"] = "true"
metadata["document"] = _build_document(i)
record = SubmitEmbeddingRecord(
id=f"embedding_{i}",
embedding=vector,
encoding=ScalarEncoding.FLOAT32,
metadata=metadata,
operation=Operation.ADD,
)
return record
return (create_record(i) for i in count())
_digit_map = {
"0": "zero",
"1": "one",
"2": "two",
"3": "three",
"4": "four",
"5": "five",
"6": "six",
"7": "seven",
"8": "eight",
"9": "nine",
}
def _build_document(i: int) -> str:
digits = list(str(i))
return " ".join(_digit_map[d] for d in digits)
segment_definition = Segment(
id=uuid.uuid4(),
type="test_type",
scope=SegmentScope.METADATA,
topic="persistent://test/test/test_topic_1",
collection=None,
metadata=None,
)
def sync(segment: MetadataReader, seq_id: SeqId) -> None:
# Try for up to 5 seconds, then throw a TimeoutError
start = time.time()
while time.time() - start < 5:
if segment.max_seqid() >= seq_id:
return
time.sleep(0.25)
raise TimeoutError(f"Timed out waiting for seq_id {seq_id}")
def test_insert_and_count(
system: System, sample_embeddings: Iterator[SubmitEmbeddingRecord]
) -> None:
system.reset()
producer = system.instance(Producer)
topic = str(segment_definition["topic"])
max_id = 0
for i in range(3):
max_id = producer.submit_embedding(topic, next(sample_embeddings))
segment = SqliteMetadataSegment(system, segment_definition)
segment.start()
sync(segment, max_id)
assert segment.count() == 3
for i in range(3):
max_id = producer.submit_embedding(topic, next(sample_embeddings))
sync(segment, max_id)
assert segment.count() == 6
def assert_equiv_records(
expected: Sequence[SubmitEmbeddingRecord], actual: Sequence[MetadataEmbeddingRecord]
) -> None:
assert len(expected) == len(actual)
sorted_expected = sorted(expected, key=lambda r: r["id"])
sorted_actual = sorted(actual, key=lambda r: r["id"])
for e, a in zip(sorted_expected, sorted_actual):
assert e["id"] == a["id"]
assert e["metadata"] == a["metadata"]
def test_get(
system: System, sample_embeddings: Iterator[SubmitEmbeddingRecord]
) -> None:
system.reset()
producer = system.instance(Producer)
topic = str(segment_definition["topic"])
embeddings = [next(sample_embeddings) for i in range(10)]
seq_ids = []
for e in embeddings:
seq_ids.append(producer.submit_embedding(topic, e))
segment = SqliteMetadataSegment(system, segment_definition)
segment.start()
sync(segment, seq_ids[-1])
# Get all records
results = segment.get_metadata()
assert seq_ids == [r["seq_id"] for r in results]
assert_equiv_records(embeddings, results)
# get by ID
result = segment.get_metadata(ids=[e["id"] for e in embeddings[0:5]])
assert_equiv_records(embeddings[0:5], result)
# Get with limit and offset
# Cannot rely on order(yet), but can rely on retrieving exactly the
# whole set eventually
ret: List[MetadataEmbeddingRecord] = []
ret.extend(segment.get_metadata(limit=3))
assert len(ret) == 3
ret.extend(segment.get_metadata(limit=3, offset=3))
assert len(ret) == 6
ret.extend(segment.get_metadata(limit=3, offset=6))
assert len(ret) == 9
ret.extend(segment.get_metadata(limit=3, offset=9))
assert len(ret) == 10
assert_equiv_records(embeddings, ret)
# Get with simple where
result = segment.get_metadata(where={"div_by_three": "true"})
assert len(result) == 3
# Get with gt/gte/lt/lte on int keys
result = segment.get_metadata(where={"int_key": {"$gt": 5}})
assert len(result) == 4
result = segment.get_metadata(where={"int_key": {"$gte": 5}})
assert len(result) == 5
result = segment.get_metadata(where={"int_key": {"$lt": 5}})
assert len(result) == 4
result = segment.get_metadata(where={"int_key": {"$lte": 5}})
assert len(result) == 5
# Get with gt/lt on float keys with float values
result = segment.get_metadata(where={"float_key": {"$gt": 5.01}})
assert len(result) == 5
result = segment.get_metadata(where={"float_key": {"$lt": 4.99}})
assert len(result) == 4
# Get with gt/lt on float keys with int values
result = segment.get_metadata(where={"float_key": {"$gt": 5}})
assert len(result) == 5
result = segment.get_metadata(where={"float_key": {"$lt": 5}})
assert len(result) == 4
# Get with gt/lt on int keys with float values
result = segment.get_metadata(where={"int_key": {"$gt": 5.01}})
assert len(result) == 4
result = segment.get_metadata(where={"int_key": {"$lt": 4.99}})
assert len(result) == 4
# Get with $ne
# Returns metadata that has an int_key, but not equal to 5
result = segment.get_metadata(where={"int_key": {"$ne": 5}})
assert len(result) == 8
# get with multiple heterogenous conditions
result = segment.get_metadata(where={"div_by_three": "true", "int_key": {"$gt": 5}})
assert len(result) == 2
# get with OR conditions
result = segment.get_metadata(where={"$or": [{"int_key": 1}, {"int_key": 2}]})
assert len(result) == 2
# get with AND conditions
result = segment.get_metadata(
where={"$and": [{"int_key": 3}, {"float_key": {"$gt": 5}}]}
)
assert len(result) == 0
result = segment.get_metadata(
where={"$and": [{"int_key": 3}, {"float_key": {"$lt": 5}}]}
)
assert len(result) == 1
def test_fulltext(
system: System, sample_embeddings: Iterator[SubmitEmbeddingRecord]
) -> None:
system.reset()
producer = system.instance(Producer)
topic = str(segment_definition["topic"])
segment = SqliteMetadataSegment(system, segment_definition)
segment.start()
max_id = 0
for i in range(100):
max_id = producer.submit_embedding(topic, next(sample_embeddings))
sync(segment, max_id)
result = segment.get_metadata(where={"document": "four two"})
result2 = segment.get_metadata(ids=["embedding_42"])
assert result == result2
# Test single result
result = segment.get_metadata(where_document={"$contains": "four two"})
assert len(result) == 1
# Test many results
result = segment.get_metadata(where_document={"$contains": "zero"})
assert len(result) == 9
# test $and
result = segment.get_metadata(
where_document={"$and": [{"$contains": "four"}, {"$contains": "two"}]}
)
assert len(result) == 2
assert set([r["id"] for r in result]) == {"embedding_42", "embedding_24"}
# test $or
result = segment.get_metadata(
where_document={"$or": [{"$contains": "zero"}, {"$contains": "one"}]}
)
ones = [i for i in range(1, 100) if "one" in _build_document(i)]
zeros = [i for i in range(1, 100) if "zero" in _build_document(i)]
expected = set([f"embedding_{i}" for i in set(ones + zeros)])
assert set([r["id"] for r in result]) == expected
# test combo with where clause (negative case)
result = segment.get_metadata(
where={"int_key": {"$eq": 42}}, where_document={"$contains": "zero"}
)
assert len(result) == 0
# test combo with where clause (positive case)
result = segment.get_metadata(
where={"int_key": {"$eq": 42}}, where_document={"$contains": "four"}
)
assert len(result) == 1
# test partial words
result = segment.get_metadata(where_document={"$contains": "zer"})
assert len(result) == 9
def test_delete(
system: System, sample_embeddings: Iterator[SubmitEmbeddingRecord]
) -> None:
system.reset()
producer = system.instance(Producer)
topic = str(segment_definition["topic"])
segment = SqliteMetadataSegment(system, segment_definition)
segment.start()
embeddings = [next(sample_embeddings) for i in range(10)]
max_id = 0
for e in embeddings:
max_id = producer.submit_embedding(topic, e)
sync(segment, max_id)
assert segment.count() == 10
results = segment.get_metadata(ids=["embedding_0"])
assert_equiv_records(embeddings[:1], results)
# Delete by ID
max_id = producer.submit_embedding(
topic,
SubmitEmbeddingRecord(
id="embedding_0",
embedding=None,
encoding=None,
metadata=None,
operation=Operation.DELETE,
),
)
sync(segment, max_id)
assert segment.count() == 9
assert segment.get_metadata(ids=["embedding_0"]) == []
# Delete is idempotent
max_id = producer.submit_embedding(
topic,
SubmitEmbeddingRecord(
id="embedding_0",
embedding=None,
encoding=None,
metadata=None,
operation=Operation.DELETE,
),
)
sync(segment, max_id)
assert segment.count() == 9
assert segment.get_metadata(ids=["embedding_0"]) == []
# re-add
max_id = producer.submit_embedding(topic, embeddings[0])
sync(segment, max_id)
assert segment.count() == 10
results = segment.get_metadata(ids=["embedding_0"])
def test_update(
system: System, sample_embeddings: Iterator[SubmitEmbeddingRecord]
) -> None:
system.reset()
producer = system.instance(Producer)
topic = str(segment_definition["topic"])
segment = SqliteMetadataSegment(system, segment_definition)
segment.start()
_test_update(sample_embeddings, producer, segment, topic, Operation.UPDATE)
# Update nonexisting ID
update_record = SubmitEmbeddingRecord(
id="no_such_id",
metadata={"foo": "bar"},
embedding=None,
encoding=None,
operation=Operation.UPDATE,
)
max_id = producer.submit_embedding(topic, update_record)
sync(segment, max_id)
results = segment.get_metadata(ids=["no_such_id"])
assert len(results) == 0
assert segment.count() == 3
def test_upsert(
system: System, sample_embeddings: Iterator[SubmitEmbeddingRecord]
) -> None:
system.reset()
producer = system.instance(Producer)
topic = str(segment_definition["topic"])
segment = SqliteMetadataSegment(system, segment_definition)
segment.start()
_test_update(sample_embeddings, producer, segment, topic, Operation.UPSERT)
# upsert previously nonexisting ID
update_record = SubmitEmbeddingRecord(
id="no_such_id",
metadata={"foo": "bar"},
embedding=None,
encoding=None,
operation=Operation.UPSERT,
)
max_id = producer.submit_embedding(topic, update_record)
sync(segment, max_id)
results = segment.get_metadata(ids=["no_such_id"])
assert results[0]["metadata"] == {"foo": "bar"}
def _test_update(
sample_embeddings: Iterator[SubmitEmbeddingRecord],
producer: Producer,
segment: MetadataReader,
topic: str,
op: Operation,
) -> None:
"""test code common between update and upsert paths"""
embeddings = [next(sample_embeddings) for i in range(3)]
max_id = 0
for e in embeddings:
max_id = producer.submit_embedding(topic, e)
sync(segment, max_id)
results = segment.get_metadata(ids=["embedding_0"])
assert_equiv_records(embeddings[:1], results)
# Update embedding with no metadata
update_record = SubmitEmbeddingRecord(
id="embedding_0",
metadata={"document": "foo bar"},
embedding=None,
encoding=None,
operation=op,
)
max_id = producer.submit_embedding(topic, update_record)
sync(segment, max_id)
results = segment.get_metadata(ids=["embedding_0"])
assert results[0]["metadata"] == {"document": "foo bar"}
results = segment.get_metadata(where_document={"$contains": "foo"})
assert results[0]["metadata"] == {"document": "foo bar"}
# Update and overrwrite key
update_record = SubmitEmbeddingRecord(
id="embedding_0",
metadata={"document": "biz buz"},
embedding=None,
encoding=None,
operation=op,
)
max_id = producer.submit_embedding(topic, update_record)
sync(segment, max_id)
results = segment.get_metadata(ids=["embedding_0"])
assert results[0]["metadata"] == {"document": "biz buz"}
results = segment.get_metadata(where_document={"$contains": "biz"})
assert results[0]["metadata"] == {"document": "biz buz"}
results = segment.get_metadata(where_document={"$contains": "foo"})
assert len(results) == 0
# Update and add key
update_record = SubmitEmbeddingRecord(
id="embedding_0",
metadata={"baz": 42},
embedding=None,
encoding=None,
operation=op,
)
max_id = producer.submit_embedding(topic, update_record)
sync(segment, max_id)
results = segment.get_metadata(ids=["embedding_0"])
assert results[0]["metadata"] == {"document": "biz buz", "baz": 42}
# Update and delete key
update_record = SubmitEmbeddingRecord(
id="embedding_0",
metadata={"document": None},
embedding=None,
encoding=None,
operation=op,
)
max_id = producer.submit_embedding(topic, update_record)
sync(segment, max_id)
results = segment.get_metadata(ids=["embedding_0"])
assert results[0]["metadata"] == {"baz": 42}
results = segment.get_metadata(where_document={"$contains": "biz"})
assert len(results) == 0
|