Skip to main content

​
Schema

Collection schema for indexing and encryption configuration. Properties
​
defaults
ValueTypes
​
keys
Dict[str, ValueTypes]
​
cmek
Optional[Cmek]

​
Index configs

​
FtsIndexConfig

Configuration for Full-Text Search index. No parameters required.

​
HnswIndexConfig

Configuration for HNSW vector index. Properties
​
ef_construction
Optional[int]
​
max_neighbors
Optional[int]
​
ef_search
Optional[int]
​
num_threads
Optional[int]
​
batch_size
Optional[int]
​
sync_threshold
Optional[int]
​
resize_factor
Optional[float]

​
SpannIndexConfig

Configuration for SPANN vector index. Properties
​
search_nprobe
Optional[int]
​
write_nprobe
Optional[int]
​
ef_construction
Optional[int]
​
ef_search
Optional[int]
​
max_neighbors
Optional[int]
​
reassign_neighbor_count
Optional[int]
​
split_threshold
Optional[int]
​
merge_threshold
Optional[int]

​
VectorIndexConfig

Configuration for vector index with space, embedding function, and algorithm config. Properties
​
space
Optional[Literal[cosine, l2, ip]]
​
embedding_function
Optional[Any]
​
source_key
Optional[str]
​
hnsw
Optional[HnswIndexConfig]
​
spann
Optional[SpannIndexConfig]

​
SparseVectorIndexConfig

Configuration for sparse vector index. Properties
​
embedding_function
Optional[Any]
​
source_key
Optional[str]
​
bm25
Optional[bool]

​
StringInvertedIndexConfig

Configuration for string inverted index.

​
IntInvertedIndexConfig

Configuration for integer inverted index.

​
FloatInvertedIndexConfig

Configuration for float inverted index.

​
BoolInvertedIndexConfig

Configuration for boolean inverted index.