Skip to content

DynamoDB  >  Structures  >  CreateVectorIndexAction

CreateVectorIndexAction

Structure Class

CreateVectorIndexAction dataclass

A new vector index to be added to a table.

Attributes

dimensions instance-attribute 
dimensions: int

The number of dimensions in each vector.

distance_function instance-attribute 
distance_function: VectorDistanceFunction

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

index_name instance-attribute 
index_name: str

The name of the vector index. Must be unique within the table.

projection instance-attribute 
projection: Projection

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

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

The partition key and inline filter attribute definitions for the vector index.

vector_attribute instance-attribute 
vector_attribute: VectorAttributeDefinition

The attribute that contains vector embeddings. If multiple vector indexes reference the same attribute, they must all use the same number of dimensions.