Skip to content

VectorIndexInfo

Structure Class

VectorIndexInfo dataclass

Bases: _SerdeShape

Contains the configuration of a vector index as it existed at the time a backup was created.

Attributes

dimensions class-attribute instance-attribute
dimensions: int | None = ...

The number of dimensions in each vector.

distance_function class-attribute instance-attribute
distance_function: str | None = ...

The distance function used to calculate similarity between vectors.

index_name class-attribute instance-attribute
index_name: str | None = ...

The name of the vector index.

projection class-attribute instance-attribute
projection: Projection | None = ...

Specifies attributes that are copied (projected) from the table into the vector index.

search_schema class-attribute instance-attribute
search_schema: list[SearchSchemaElement] | None = ...

The search schema that defines partition key and inline filter attributes for the vector index.

vector_attribute class-attribute instance-attribute
vector_attribute: VectorAttributeDefinition | None = ...

The vector attribute configuration for the index.