Skip to content

VectorIndexDict

Dictionary Type

VectorIndexDict

Bases: TypedDict

Dictionary form of VectorIndex.

Attributes

dimensions instance-attribute
dimensions: Required[int]

The number of dimensions in each vector.

distance_function instance-attribute
distance_function: Required[str]

The distance function used to calculate similarity between vectors. Valid values: COSINE, EUCLIDEAN, DOT_PRODUCT.

index_name instance-attribute
index_name: Required[str]

The name of the vector index.

projection instance-attribute

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

search_schema instance-attribute

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

vector_attribute instance-attribute

The vector attribute configuration for the index.