vectordb-bench 0.0.27__tar.gz → 0.0.29__tar.gz

{vectordb_bench-0.0.27 → vectordb_bench-0.0.29}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vectordb-bench
-Version: 0.0.27
+Version: 0.0.29
 Summary: VectorDBBench is not just an offering of benchmark results for mainstream vector databases and cloud services, it's your go-to tool for the ultimate performance and cost-effectiveness comparison. Designed with ease-of-use in mind, VectorDBBench is devised to help users, even non-professionals, reproduce results or test new systems, making the hunt for the optimal choice amongst a plethora of cloud services and open-source vector databases a breeze.
 Author-email: XuanYang-cn <xuan.yang@zilliz.com>
 Project-URL: repository, https://github.com/zilliztech/VectorDBBench
@@ -52,6 +52,7 @@ Requires-Dist: mariadb; extra == "all"
 Requires-Dist: PyMySQL; extra == "all"
 Requires-Dist: clickhouse-connect; extra == "all"
 Requires-Dist: pyvespa; extra == "all"
+Requires-Dist: lancedb; extra == "all"
 Provides-Extra: qdrant
 Requires-Dist: qdrant-client; extra == "qdrant"
 Provides-Extra: pinecone
@@ -87,15 +88,17 @@ Provides-Extra: clickhouse
 Requires-Dist: clickhouse-connect; extra == "clickhouse"
 Provides-Extra: vespa
 Requires-Dist: pyvespa; extra == "vespa"
+Provides-Extra: lancedb
+Requires-Dist: lancedb; extra == "lancedb"
 Dynamic: license-file
 
-# VectorDBBench: A Benchmark Tool for VectorDB
+# VectorDBBench(VDBBench): A Benchmark Tool for VectorDB
 
 [![version](https://img.shields.io/pypi/v/vectordb-bench.svg?color=blue)](https://pypi.org/project/vectordb-bench/)
 [![Downloads](https://pepy.tech/badge/vectordb-bench)](https://pepy.tech/project/vectordb-bench)
 
 ## What is VectorDBBench
-VectorDBBench is not just an offering of benchmark results for mainstream vector databases and cloud services, it's your go-to tool for the ultimate performance and cost-effectiveness comparison. Designed with ease-of-use in mind, VectorDBBench is devised to help users, even non-professionals, reproduce results or test new systems, making the hunt for the optimal choice amongst a plethora of cloud services and open-source vector databases a breeze.
+VectorDBBench(VDBBench) is not just an offering of benchmark results for mainstream vector databases and cloud services, it's your go-to tool for the ultimate performance and cost-effectiveness comparison. Designed with ease-of-use in mind, VectorDBBench is devised to help users, even non-professionals, reproduce results or test new systems, making the hunt for the optimal choice amongst a plethora of cloud services and open-source vector databases a breeze.
 
 Understanding the importance of user experience, we provide an intuitive visual interface. This not only empowers users to initiate benchmarks at ease, but also to view comparative result reports, thereby reproducing benchmark results effortlessly.
 To add more relevance and practicality, we provide cost-effectiveness reports particularly for cloud services. This allows for a more realistic and applicable benchmarking process.
@@ -205,6 +208,10 @@ Options:
   --num-concurrency TEXT          Comma-separated list of concurrency values
                                   to test during concurrent search  [default:
                                   1,10,20]
+  --concurrency-timeout INTEGER   Timeout (in seconds) to wait for a
+                                  concurrency slot before failing. Set to a
+                                  negative value to wait indefinitely.
+                                  [default: 3600]
   --user-name TEXT                Db username  [required]
   --password TEXT                 Db password  [required]
   --host TEXT                     Db host  [required]
@@ -291,7 +298,8 @@ Options:
   # Memory Management
   --cb-threshold TEXT             k-NN Memory circuit breaker threshold
 
-  --help                          Show this message and exit.```
+  --help                          Show this message and exit.
+  ```
 
 #### Using a configuration file.
 
@@ -358,13 +366,13 @@ pip install -e '.[pinecone]'
 ```
 ### Run test server
 ```
-$ python -m vectordb_bench
+python -m vectordb_bench
 ```
 
 OR:
 
 ```shell
-$ init_bench
+init_bench
 ```
 
 OR:
@@ -381,13 +389,13 @@ After reopen the repository in container, run `python -m vectordb_bench` in the
 
 ### Check coding styles
 ```shell
-$ make lint
+make lint
 ```
 
 To fix the coding styles automatically
 
 ```shell
-$ make format
+make format
 ```
 
 ## How does it work?

{vectordb_bench-0.0.27 → vectordb_bench-0.0.29}/README.md

@@ -1,10 +1,10 @@
-# VectorDBBench: A Benchmark Tool for VectorDB
+# VectorDBBench(VDBBench): A Benchmark Tool for VectorDB
 
 [![version](https://img.shields.io/pypi/v/vectordb-bench.svg?color=blue)](https://pypi.org/project/vectordb-bench/)
 [![Downloads](https://pepy.tech/badge/vectordb-bench)](https://pepy.tech/project/vectordb-bench)
 
 ## What is VectorDBBench
-VectorDBBench is not just an offering of benchmark results for mainstream vector databases and cloud services, it's your go-to tool for the ultimate performance and cost-effectiveness comparison. Designed with ease-of-use in mind, VectorDBBench is devised to help users, even non-professionals, reproduce results or test new systems, making the hunt for the optimal choice amongst a plethora of cloud services and open-source vector databases a breeze.
+VectorDBBench(VDBBench) is not just an offering of benchmark results for mainstream vector databases and cloud services, it's your go-to tool for the ultimate performance and cost-effectiveness comparison. Designed with ease-of-use in mind, VectorDBBench is devised to help users, even non-professionals, reproduce results or test new systems, making the hunt for the optimal choice amongst a plethora of cloud services and open-source vector databases a breeze.
 
 Understanding the importance of user experience, we provide an intuitive visual interface. This not only empowers users to initiate benchmarks at ease, but also to view comparative result reports, thereby reproducing benchmark results effortlessly.
 To add more relevance and practicality, we provide cost-effectiveness reports particularly for cloud services. This allows for a more realistic and applicable benchmarking process.
@@ -114,6 +114,10 @@ Options:
   --num-concurrency TEXT          Comma-separated list of concurrency values
                                   to test during concurrent search  [default:
                                   1,10,20]
+  --concurrency-timeout INTEGER   Timeout (in seconds) to wait for a
+                                  concurrency slot before failing. Set to a
+                                  negative value to wait indefinitely.
+                                  [default: 3600]
   --user-name TEXT                Db username  [required]
   --password TEXT                 Db password  [required]
   --host TEXT                     Db host  [required]
@@ -200,7 +204,8 @@ Options:
   # Memory Management
   --cb-threshold TEXT             k-NN Memory circuit breaker threshold
 
-  --help                          Show this message and exit.```
+  --help                          Show this message and exit.
+  ```
 
 #### Using a configuration file.
 
@@ -267,13 +272,13 @@ pip install -e '.[pinecone]'
 ```
 ### Run test server
 ```
-$ python -m vectordb_bench
+python -m vectordb_bench
 ```
 
 OR:
 
 ```shell
-$ init_bench
+init_bench
 ```
 
 OR:
@@ -290,13 +295,13 @@ After reopen the repository in container, run `python -m vectordb_bench` in the
 
 ### Check coding styles
 ```shell
-$ make lint
+make lint
 ```
 
 To fix the coding styles automatically
 
 ```shell
-$ make format
+make format
 ```
 
 ## How does it work?

{vectordb_bench-0.0.27 → vectordb_bench-0.0.29}/pyproject.toml

@@ -72,6 +72,7 @@ all = [
     "PyMySQL",
     "clickhouse-connect",
     "pyvespa",
+    "lancedb",
 ]
 
 qdrant          = [ "qdrant-client" ]
@@ -94,6 +95,7 @@ mariadb         = [ "mariadb" ]
 tidb            = [ "PyMySQL" ]
 clickhouse      = [ "clickhouse-connect" ]
 vespa           = [ "pyvespa" ]
+lancedb         = [ "lancedb" ]
 
 [project.urls]
 "repository" = "https://github.com/zilliztech/VectorDBBench"

{vectordb_bench-0.0.27 → vectordb_bench-0.0.29}/vectordb_bench/__init__.py

@@ -6,7 +6,7 @@ import environs
 from . import log_util
 
 env = environs.Env()
-env.read_env(".env", False)
+env.read_env(path=".env", recurse=False)
 
 
 class config:
@@ -52,6 +52,8 @@ class config:
 
     CONCURRENCY_DURATION = 30
 
+    CONCURRENCY_TIMEOUT = 3600
+
     RESULTS_LOCAL_DIR = env.path(
         "RESULTS_LOCAL_DIR",
         pathlib.Path(__file__).parent.joinpath("results"),

{vectordb_bench-0.0.27 → vectordb_bench-0.0.29}/vectordb_bench/backend/clients/__init__.py

@@ -45,9 +45,10 @@ class DB(Enum):
     TiDB = "TiDB"
     Clickhouse = "Clickhouse"
     Vespa = "Vespa"
+    LanceDB = "LanceDB"
 
     @property
-    def init_cls(self) -> type[VectorDB]:  # noqa: PLR0911, PLR0912, C901
+    def init_cls(self) -> type[VectorDB]:  # noqa: PLR0911, PLR0912, C901, PLR0915
         """Import while in use"""
         if self == DB.Milvus:
             from .milvus.milvus import Milvus
@@ -164,11 +165,16 @@ class DB(Enum):
 
             return Vespa
 
+        if self == DB.LanceDB:
+            from .lancedb.lancedb import LanceDB
+
+            return LanceDB
+
         msg = f"Unknown DB: {self.name}"
         raise ValueError(msg)
 
     @property
-    def config_cls(self) -> type[DBConfig]:  # noqa: PLR0911, PLR0912, C901
+    def config_cls(self) -> type[DBConfig]:  # noqa: PLR0911, PLR0912, C901, PLR0915
         """Import while in use"""
         if self == DB.Milvus:
             from .milvus.config import MilvusConfig
@@ -285,6 +291,11 @@ class DB(Enum):
 
             return VespaConfig
 
+        if self == DB.LanceDB:
+            from .lancedb.config import LanceDBConfig
+
+            return LanceDBConfig
+
         msg = f"Unknown DB: {self.name}"
         raise ValueError(msg)
 
@@ -382,6 +393,11 @@ class DB(Enum):
 
             return VespaHNSWConfig
 
+        if self == DB.LanceDB:
+            from .lancedb.config import _lancedb_case_config
+
+            return _lancedb_case_config.get(index_type)
+
         # DB.Pinecone, DB.Chroma, DB.Redis
         return EmptyDBCaseConfig
 

{vectordb_bench-0.0.27 → vectordb_bench-0.0.29}/vectordb_bench/backend/clients/api.py

@@ -34,6 +34,7 @@ class IndexType(str, Enum):
     GPU_IVF_PQ = "GPU_IVF_PQ"
     GPU_CAGRA = "GPU_CAGRA"
     SCANN = "scann"
+    NONE = "NONE"
 
 
 class SQType(str, Enum):

{vectordb_bench-0.0.27 → vectordb_bench-0.0.29}/vectordb_bench/backend/clients/clickhouse/cli.py

@@ -51,6 +51,7 @@ def Clickhouse(**parameters: Unpack[ClickhouseHNSWTypedDict]):
         db=DB.Clickhouse,
         db_config=ClickhouseConfig(
             db_label=parameters["db_label"],
+            user=parameters["user"],
             password=SecretStr(parameters["password"]) if parameters["password"] else None,
             host=parameters["host"],
             port=parameters["port"],

{vectordb_bench-0.0.27 → vectordb_bench-0.0.29}/vectordb_bench/backend/clients/clickhouse/clickhouse.py

@@ -106,7 +106,7 @@ class Clickhouse(VectorDB):
                     query = f"""
                         ALTER TABLE {self.db_config["database"]}.{self.table_name}
                         ADD INDEX {self._index_name} {self._vector_field}
-                        TYPE vector_similarity('hnsw', '{self.index_param["metric_type"]}',
+                        TYPE vector_similarity('hnsw', '{self.index_param["metric_type"]}',{self.dim},
                         '{self.index_param["quantization"]}',
                         {self.index_param["params"]["M"]}, {self.index_param["params"]["efConstruction"]})
                         GRANULARITY {self.index_param["granularity"]}
@@ -115,7 +115,7 @@ class Clickhouse(VectorDB):
                     query = f"""
                         ALTER TABLE {self.db_config["database"]}.{self.table_name}
                         ADD INDEX {self._index_name} {self._vector_field}
-                        TYPE vector_similarity('hnsw', '{self.index_param["metric_type"]}')
+                        TYPE vector_similarity('hnsw', '{self.index_param["metric_type"]}', {self.dim})
                         GRANULARITY {self.index_param["granularity"]}
                         """
                 self.conn.command(cmd=query)
@@ -186,7 +186,7 @@ class Clickhouse(VectorDB):
             "vector_field": self._vector_field,
             "schema": self.db_config["database"],
             "table": self.table_name,
-            "gt": filters.get("id"),
+            "gt": 0 if filters is None else filters.get("id", 0),
             "k": k,
             "metric_type": self.search_param["metric_type"],
             "query": query,

{vectordb_bench-0.0.27 → vectordb_bench-0.0.29}/vectordb_bench/backend/clients/clickhouse/config.py

@@ -16,7 +16,7 @@ class ClickhouseConfigDict(TypedDict):
 
 
 class ClickhouseConfig(DBConfig):
-    user_name: str = "clickhouse"
+    user: str = "clickhouse"
     password: SecretStr
     host: str = "localhost"
     port: int = 8123
@@ -29,7 +29,7 @@ class ClickhouseConfig(DBConfig):
             "host": self.host,
             "port": self.port,
             "database": self.db_name,
-            "user": self.user_name,
+            "user": self.user,
             "password": pwd_str,
             "secure": self.secure,
         }

vectordb_bench-0.0.29/vectordb_bench/backend/clients/lancedb/cli.py

@@ -0,0 +1,92 @@
+from typing import Annotated, Unpack
+
+import click
+from pydantic import SecretStr
+
+from ....cli.cli import (
+    CommonTypedDict,
+    cli,
+    click_parameter_decorators_from_typed_dict,
+    run,
+)
+from .. import DB
+from ..api import IndexType
+
+
+class LanceDBTypedDict(CommonTypedDict):
+    uri: Annotated[
+        str,
+        click.option("--uri", type=str, help="URI connection string", required=True),
+    ]
+    token: Annotated[
+        str | None,
+        click.option("--token", type=str, help="Authentication token", required=False),
+    ]
+
+
+@cli.command()
+@click_parameter_decorators_from_typed_dict(LanceDBTypedDict)
+def LanceDB(**parameters: Unpack[LanceDBTypedDict]):
+    from .config import LanceDBConfig, _lancedb_case_config
+
+    run(
+        db=DB.LanceDB,
+        db_config=LanceDBConfig(
+            db_label=parameters["db_label"],
+            uri=parameters["uri"],
+            token=SecretStr(parameters["token"]) if parameters.get("token") else None,
+        ),
+        db_case_config=_lancedb_case_config.get("NONE")(),
+        **parameters,
+    )
+
+
+@cli.command()
+@click_parameter_decorators_from_typed_dict(LanceDBTypedDict)
+def LanceDBAutoIndex(**parameters: Unpack[LanceDBTypedDict]):
+    from .config import LanceDBConfig, _lancedb_case_config
+
+    run(
+        db=DB.LanceDB,
+        db_config=LanceDBConfig(
+            db_label=parameters["db_label"],
+            uri=parameters["uri"],
+            token=SecretStr(parameters["token"]) if parameters.get("token") else None,
+        ),
+        db_case_config=_lancedb_case_config.get(IndexType.AUTOINDEX)(),
+        **parameters,
+    )
+
+
+@cli.command()
+@click_parameter_decorators_from_typed_dict(LanceDBTypedDict)
+def LanceDBIVFPQ(**parameters: Unpack[LanceDBTypedDict]):
+    from .config import LanceDBConfig, _lancedb_case_config
+
+    run(
+        db=DB.LanceDB,
+        db_config=LanceDBConfig(
+            db_label=parameters["db_label"],
+            uri=parameters["uri"],
+            token=SecretStr(parameters["token"]) if parameters.get("token") else None,
+        ),
+        db_case_config=_lancedb_case_config.get(IndexType.IVFPQ)(),
+        **parameters,
+    )
+
+
+@cli.command()
+@click_parameter_decorators_from_typed_dict(LanceDBTypedDict)
+def LanceDBHNSW(**parameters: Unpack[LanceDBTypedDict]):
+    from .config import LanceDBConfig, _lancedb_case_config
+
+    run(
+        db=DB.LanceDB,
+        db_config=LanceDBConfig(
+            db_label=parameters["db_label"],
+            uri=parameters["uri"],
+            token=SecretStr(parameters["token"]) if parameters.get("token") else None,
+        ),
+        db_case_config=_lancedb_case_config.get(IndexType.HNSW)(),
+        **parameters,
+    )

vectordb_bench-0.0.29/vectordb_bench/backend/clients/lancedb/config.py

@@ -0,0 +1,103 @@
+from pydantic import BaseModel, SecretStr
+
+from ..api import DBCaseConfig, DBConfig, IndexType, MetricType
+
+
+class LanceDBConfig(DBConfig):
+    """LanceDB connection configuration."""
+
+    db_label: str
+    uri: str
+    token: SecretStr | None = None
+
+    def to_dict(self) -> dict:
+        return {
+            "uri": self.uri,
+            "token": self.token.get_secret_value() if self.token else None,
+        }
+
+
+class LanceDBIndexConfig(BaseModel, DBCaseConfig):
+    index: IndexType = IndexType.IVFPQ
+    metric_type: MetricType = MetricType.L2
+    num_partitions: int = 0
+    num_sub_vectors: int = 0
+    nbits: int = 8  # Must be 4 or 8
+    sample_rate: int = 256
+    max_iterations: int = 50
+
+    def index_param(self) -> dict:
+        if self.index not in [
+            IndexType.IVFPQ,
+            IndexType.HNSW,
+            IndexType.AUTOINDEX,
+            IndexType.NONE,
+        ]:
+            msg = f"Index type {self.index} is not supported for LanceDB!"
+            raise ValueError(msg)
+
+        # See https://lancedb.github.io/lancedb/python/python/#lancedb.table.Table.create_index
+        params = {
+            "metric": self.parse_metric(),
+            "num_bits": self.nbits,
+            "sample_rate": self.sample_rate,
+            "max_iterations": self.max_iterations,
+        }
+
+        if self.num_partitions > 0:
+            params["num_partitions"] = self.num_partitions
+        if self.num_sub_vectors > 0:
+            params["num_sub_vectors"] = self.num_sub_vectors
+
+        return params
+
+    def search_param(self) -> dict:
+        pass
+
+    def parse_metric(self) -> str:
+        if self.metric_type in [MetricType.L2, MetricType.COSINE]:
+            return self.metric_type.value.lower()
+        if self.metric_type in [MetricType.IP, MetricType.DP]:
+            return "dot"
+        msg = f"Metric type {self.metric_type} is not supported for LanceDB!"
+        raise ValueError(msg)
+
+
+class LanceDBNoIndexConfig(LanceDBIndexConfig):
+    index: IndexType = IndexType.NONE
+
+    def index_param(self) -> dict:
+        return {}
+
+
+class LanceDBAutoIndexConfig(LanceDBIndexConfig):
+    index: IndexType = IndexType.AUTOINDEX
+
+    def index_param(self) -> dict:
+        return {}
+
+
+class LanceDBHNSWIndexConfig(LanceDBIndexConfig):
+    index: IndexType = IndexType.HNSW
+    m: int = 0
+    ef_construction: int = 0
+
+    def index_param(self) -> dict:
+        params = LanceDBIndexConfig.index_param(self)
+
+        # See https://lancedb.github.io/lancedb/python/python/#lancedb.index.HnswSq
+        params["index_type"] = "IVF_HNSW_SQ"
+        if self.m > 0:
+            params["m"] = self.m
+        if self.ef_construction > 0:
+            params["ef_construction"] = self.ef_construction
+
+        return params
+
+
+_lancedb_case_config = {
+    IndexType.IVFPQ: LanceDBIndexConfig,
+    IndexType.AUTOINDEX: LanceDBAutoIndexConfig,
+    IndexType.HNSW: LanceDBHNSWIndexConfig,
+    IndexType.NONE: LanceDBNoIndexConfig,
+}

vectordb_bench-0.0.29/vectordb_bench/backend/clients/lancedb/lancedb.py

@@ -0,0 +1,97 @@
+import logging
+from contextlib import contextmanager
+
+import lancedb
+import pyarrow as pa
+from lancedb.pydantic import LanceModel
+
+from ..api import IndexType, VectorDB
+from .config import LanceDBConfig, LanceDBIndexConfig
+
+log = logging.getLogger(__name__)
+
+
+class VectorModel(LanceModel):
+    id: int
+    vector: list[float]
+
+
+class LanceDB(VectorDB):
+    def __init__(
+        self,
+        dim: int,
+        db_config: LanceDBConfig,
+        db_case_config: LanceDBIndexConfig,
+        collection_name: str = "vector_bench_test",
+        drop_old: bool = False,
+        **kwargs,
+    ):
+        self.name = "LanceDB"
+        self.db_config = db_config
+        self.case_config = db_case_config
+        self.table_name = collection_name
+        self.dim = dim
+        self.uri = db_config["uri"]
+
+        db = lancedb.connect(self.uri)
+
+        if drop_old:
+            try:
+                db.drop_table(self.table_name)
+            except Exception as e:
+                log.warning(f"Failed to drop table {self.table_name}: {e}")
+
+        try:
+            db.open_table(self.table_name)
+        except Exception:
+            schema = pa.schema(
+                [pa.field("id", pa.int64()), pa.field("vector", pa.list_(pa.float64(), list_size=self.dim))]
+            )
+            db.create_table(self.table_name, schema=schema, mode="overwrite")
+
+    @contextmanager
+    def init(self):
+        self.db = lancedb.connect(self.uri)
+        self.table = self.db.open_table(self.table_name)
+        yield
+        self.db = None
+        self.table = None
+
+    def insert_embeddings(
+        self,
+        embeddings: list[list[float]],
+        metadata: list[int],
+    ) -> tuple[int, Exception | None]:
+        try:
+            data = [{"id": meta, "vector": emb} for meta, emb in zip(metadata, embeddings, strict=False)]
+            self.table.add(data)
+            return len(metadata), None
+        except Exception as e:
+            log.warning(f"Failed to insert data into LanceDB table ({self.table_name}), error: {e}")
+            return 0, e
+
+    def search_embedding(
+        self,
+        query: list[float],
+        k: int = 100,
+        filters: dict | None = None,
+    ) -> list[int]:
+        if filters:
+            results = (
+                self.table.search(query)
+                .select(["id"])
+                .where(f"id >= {filters['id']}", prefilter=True)
+                .limit(k)
+                .to_list()
+            )
+        else:
+            results = self.table.search(query).select(["id"]).limit(k).to_list()
+        return [int(result["id"]) for result in results]
+
+    def optimize(self, data_size: int | None = None):
+        if self.table and hasattr(self, "case_config") and self.case_config.index != IndexType.NONE:
+            log.info(f"Creating index for LanceDB table ({self.table_name})")
+            self.table.create_index(**self.case_config.index_param())
+            # Better recall with IVF_PQ (though still bad) but breaks HNSW: https://github.com/lancedb/lancedb/issues/2369
+            if self.case_config.index in (IndexType.IVFPQ, IndexType.AUTOINDEX):
+                self.table.optimize()

vectordb_bench-0.0.29/vectordb_bench/backend/clients/qdrant_cloud/cli.py

@@ -0,0 +1,43 @@
+from typing import Annotated, Unpack
+
+import click
+from pydantic import SecretStr
+
+from ....cli.cli import (
+    CommonTypedDict,
+    cli,
+    click_parameter_decorators_from_typed_dict,
+    run,
+)
+from .. import DB
+
+
+class QdrantTypedDict(CommonTypedDict):
+    url: Annotated[
+        str,
+        click.option("--url", type=str, help="URL connection string", required=True),
+    ]
+    api_key: Annotated[
+        str | None,
+        click.option("--api-key", type=str, help="API key for authentication", required=False),
+    ]
+
+
+@cli.command()
+@click_parameter_decorators_from_typed_dict(QdrantTypedDict)
+def QdrantCloud(**parameters: Unpack[QdrantTypedDict]):
+    from .config import QdrantConfig, QdrantIndexConfig
+
+    config_params = {
+        "db_label": parameters["db_label"],
+        "url": SecretStr(parameters["url"]),
+    }
+
+    config_params["api_key"] = SecretStr(parameters["api_key"]) if parameters["api_key"] else None
+
+    run(
+        db=DB.QdrantCloud,
+        db_config=QdrantConfig(**config_params),
+        db_case_config=QdrantIndexConfig(),
+        **parameters,
+    )

{vectordb_bench-0.0.27 → vectordb_bench-0.0.29}/vectordb_bench/backend/clients/qdrant_cloud/config.py

@@ -6,14 +6,14 @@ from ..api import DBCaseConfig, DBConfig, MetricType
 # Allowing `api_key` to be left empty, to ensure compatibility with the open-source Qdrant.
 class QdrantConfig(DBConfig):
     url: SecretStr
-    api_key: SecretStr
+    api_key: SecretStr | None = None
 
     def to_dict(self) -> dict:
-        api_key = self.api_key.get_secret_value()
-        if len(api_key) > 0:
+        api_key_value = self.api_key.get_secret_value() if self.api_key else None
+        if api_key_value:
             return {
                 "url": self.url.get_secret_value(),
-                "api_key": self.api_key.get_secret_value(),
+                "api_key": api_key_value,
                 "prefer_grpc": True,
             }
         return {