dynamodb/aws.sdk.kotlin.services.dynamodb.model/VectorIndexDescription/Builder

Builder

Properties

Specifies whether the index is currently backfilling. During backfill, SearchVectors operations might return incomplete results.

dimensions

var dimensions: Long?

The number of dimensions in each vector.

distanceFunction

var distanceFunction: VectorDistanceFunction?

The distance function used to calculate similarity between vectors.

indexArn

var indexArn: String?

The Amazon Resource Name (ARN) that uniquely identifies the vector index.

indexName

var indexName: String?

The name of the vector index.

indexSizeBytes

var indexSizeBytes: Long?

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.

indexStatus

var indexStatus: IndexStatus?

The current state of the vector index:

itemCount

var itemCount: Long?

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.

projection

var projection: Projection?

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

searchSchema

var searchSchema: List<SearchSchemaElement>?

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

vectorAttribute

var vectorAttribute: VectorAttributeDefinition?

The vector attribute configuration for the index.

Functions

projection

fun projection(block: Projection.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.dynamodb.model.Projection inside the given block

vectorAttribute

fun vectorAttribute(block: VectorAttributeDefinition.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.dynamodb.model.VectorAttributeDefinition inside the given block