Table / Attribute / vector_indexes

vector_indexes¶

DynamoDB.Table.vector_indexes¶

(list) –

The vector indexes, if any, on the table. Each element is composed of:
- IndexName - The name of the vector index.
- IndexStatus - The current status of the vector index: CREATING, ACTIVE, or DELETING.
- Backfilling - Specifies whether the index is currently backfilling. During backfill, SearchVectors operations might return incomplete results.
- VectorAttribute - The attribute that contains vector embeddings.
- Dimensions - The number of dimensions in each vector.
- DistanceFunction - The distance function used to calculate similarity ( COSINE, EUCLIDEAN, or DOT_PRODUCT).
- SearchSchema - The partition key and inline filter attributes for the vector index.
- Projection - Specifies attributes that are copied (projected) from the table into the vector index.
- IndexArn - The Amazon Resource Name (ARN) that uniquely identifies the index.
- IndexSizeBytes - 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.
- ItemCount - 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.
- (dict) –
  
  Contains the current state and configuration of a vector index, including its status, size, item count, and the settings specified when the index was created.
  - IndexName (string) –
    
    The name of the vector index.
  - SearchSchema (list) –
    
    The search schema that defines partition key and inline filter attributes for the vector index.
    - (dict) –
      
      An element in the search schema of a vector index.
      - AttributeName (string) –
        
        The name of the attribute.
      - SearchSchemaElementType (string) –
        
        The role of the attribute in the search schema. Valid values:
        
        HASH - A partition key that partitions the vector index for independent scaling. When specified, you must provide this attribute’s value in the SearchConditionExpression.
        
        INLINE_FILTER - An attribute projected into the vector index for filtering at the storage layer during search. Inline filters are optional in the SearchConditionExpression.
  - Projection (dict) –
    
    Specifies attributes that are copied (projected) from the table into the vector index.
    - ProjectionType (string) –
      
      The set of attributes that are projected into the index:
      - KEYS_ONLY - Only the index and primary keys are projected into the index.
      - INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
      - ALL - All of the table attributes are projected into the index.
      When using the DynamoDB console, ALL is selected by default.
    - NonKeyAttributes (list) –
      
      Represents the non-key attribute names which will be projected into the index.
      
      For global and local secondary indexes, the total count of NonKeyAttributes summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
      - (string) –
  - VectorAttribute (dict) –
    
    The vector attribute configuration for the index.
    - AttributeName (string) –
      
      The name of the vector attribute.
  - Dimensions (integer) –
    
    The number of dimensions in each vector.
  - DistanceFunction (string) –
    
    The distance function used to calculate similarity between vectors.
  - IndexStatus (string) –
    
    The current state of the vector index:
    - CREATING - The index is being created.
    - ACTIVE - The index is ready for use.
    - DELETING - The index is being deleted.
  - Backfilling (boolean) –
    
    Specifies whether the index is currently backfilling. During backfill, SearchVectors operations might return incomplete results.
  - IndexSizeBytes (integer) –
    
    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.
  - ItemCount (integer) –
    
    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.
  - IndexArn (string) –
    
    The Amazon Resource Name (ARN) that uniquely identifies the vector index.