Skip to content

VectorIndexInfo

Source code in docs_src/capo_dynamodb/types/vector_index_info.py
class VectorIndexInfo(TypedDict, closed=True):
    index_name: NotRequired["capo_dynamodb.types.index_name.IndexName"]
    """<p>The name of the vector index.</p>"""
    vector_attribute: NotRequired[
        "capo_dynamodb.types.vector_attribute_definition.VectorAttributeDefinition"
    ]
    """<p>The vector attribute configuration for the index.</p>"""
    search_schema: NotRequired["capo_dynamodb.types.search_schema.SearchSchema"]
    """<p>The search schema that defines partition key and inline filter attributes for the vector index.</p>"""
    projection: NotRequired["capo_dynamodb.types.projection.Projection"]
    """<p>Specifies attributes that are copied (projected) from the table into the vector index.</p>"""
    dimensions: NotRequired[
        "capo_dynamodb.types.positive_long_object.PositiveLongObject"
    ]
    """<p>The number of dimensions in each vector.</p>"""
    distance_function: NotRequired[
        "capo_dynamodb.types.vector_distance_function.VectorDistanceFunction"
    ]
    """<p>The distance function used to calculate similarity between vectors.</p>"""

dimensions instance-attribute

dimensions: NotRequired[PositiveLongObject]

The number of dimensions in each vector.

distance_function instance-attribute

distance_function: NotRequired[VectorDistanceFunction]

The distance function used to calculate similarity between vectors.

index_name instance-attribute

index_name: NotRequired[IndexName]

The name of the vector index.

projection instance-attribute

projection: NotRequired[Projection]

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

search_schema instance-attribute

search_schema: NotRequired[SearchSchema]

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

vector_attribute instance-attribute

vector_attribute: NotRequired[VectorAttributeDefinition]

The vector attribute configuration for the index.