Parameter | Type | Description |
---|---|---|
index_name | str | Name of the index (must be unique) |
index_key | bytes | 32-byte encryption key for securing index data |
api_key | str | API key for CyborgDB authentication |
embedding | Union[str, Embeddings, SentenceTransformer] | Embedding model name or instance |
index_location | DBConfig | Configuration for index data storage location |
config_location | DBConfig | Configuration for index config storage location |
items_location | Optional[DBConfig] | (Optional) Location for item data storage (default: memory) |
index_type | str | Type of index: “ivfflat”, “ivf”, or “ivfpq” (default: “ivfflat”) |
index_config_params | Optional[Dict[str, Any]] | (Optional) Additional index configuration parameters |
dimension | Optional[int] | (Optional) Embedding dimension (auto-inferred if not provided) |
metric | str | Distance metric: “cosine”, “euclidean”, or “squared_euclidean” (default: “cosine”) |
CyborgVectorStore
: Initialized vector store instance
ValueError
RuntimeError