VectorIndexDescription ¶

class VectorIndexDescription(TypedDict, closed=True):
    index_name: NotRequired["capo_dynamodb.types.index_name.IndexName"]
    """<p>The name of the vector 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>"""
    vector_attribute: NotRequired[
        "capo_dynamodb.types.vector_attribute_definition.VectorAttributeDefinition"
    ]
    """<p>The vector attribute configuration for the 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>"""
    index_status: NotRequired["capo_dynamodb.types.index_status.IndexStatus"]
    """<p>The current state of the vector index:</p> <ul> <li> <p> <code>CREATING</code> - The index is being created.</p> </li> <li> <p> <code>ACTIVE</code> - The index is ready for use.</p> </li> <li> <p> <code>DELETING</code> - The index is being deleted.</p> </li> </ul>"""
    backfilling: NotRequired["capo_dynamodb.types.backfilling.Backfilling"]
    """<p>Specifies whether the index is currently backfilling. During backfill, <code>SearchVectors</code> operations might return incomplete results.</p>"""
    index_size_bytes: NotRequired["capo_dynamodb.types.long_object.LongObject"]
    """<p>The total size of the vector index, in bytes. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p>"""
    item_count: NotRequired["capo_dynamodb.types.long_object.LongObject"]
    """<p>The number of items indexed in the vector index. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.</p>"""
    index_arn: NotRequired["capo_dynamodb.types.string.String"]
    """<p>The Amazon Resource Name (ARN) that uniquely identifies the vector index.</p>"""