View a markdown version of this page

VectorIndexInfo - Amazon DynamoDB
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

VectorIndexInfo

Contains the configuration of a vector index as it existed at the time a backup was created.

Contents

Note

In the following list, the required parameters are described first.

Dimensions

The number of dimensions in each vector.

Type: Long

Valid Range: Minimum value of 1.

Required: No

DistanceFunction

The distance function used to calculate similarity between vectors.

Type: String

Valid Values: COSINE | DOT_PRODUCT | EUCLIDEAN

Required: No

IndexName

The name of the vector index.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

Pattern: [a-zA-Z0-9_.-]+

Required: No

Projection

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

Type: Projection object

Required: No

SearchSchema

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

Type: Array of SearchSchemaElement objects

Array Members: Minimum number of 1 item.

Required: No

VectorAttribute

The vector attribute configuration for the index.

Type: VectorAttributeDefinition object

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: