Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pixeltable.com/llms.txt

Use this file to discover all available pages before exploring further.

​
class  pixeltable.IndexMetadata

Metadata for an index on a Pixeltable table.

​
attr  columns

columns: list[str]
The table columns that are indexed.

​
attr  index_type

index_type: Literal['embedding', 'btree']
The type of index. New types may be added in the future.

​
attr  name

name: str
The name of the index.

​
attr  parameters

parameters: EmbeddingIndexParams | None
Parameters specific to the index type. None for index types without parameters.
Last modified on May 6, 2026