class pixeltable.IndexMetadata

Metadata for an index on a Pixeltable table.

attr columns

columns: list[str]

The table columns that are indexed.

index_type: Literal['embedding', 'btree']

The type of index. New types may be added in the future.

name: str

The name of the index.

parameters: EmbeddingIndexParams | None

Parameters specific to the index type. None for index types without parameters.

Last modified on August 31, 2026