Contains the configuration settings for a vector index, including the index name, vector attribute, dimensions, distance function, search schema, and projection.
In this article ▶
Inheritance Hierarchy
Namespace: Amazon.DynamoDBv2.Model
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z
Syntax
public class VectorIndex
The VectorIndex type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
VectorIndex() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Dimensions | System.Nullable<System.Int64> |
Gets and sets the property Dimensions. The number of dimensions in each vector. |
|
|
DistanceFunction | Amazon.DynamoDBv2.VectorDistanceFunction |
Gets and sets the property DistanceFunction.
The distance function used to calculate similarity between vectors. Valid values:
|
|
|
IndexName | System.String |
Gets and sets the property IndexName. The name of the vector index. |
|
|
Projection | Amazon.DynamoDBv2.Model.Projection |
Gets and sets the property Projection. Specifies attributes that are copied (projected) from the table into the vector index. |
|
|
SearchSchema | System.Collections.Generic.List<Amazon.DynamoDBv2.Model.SearchSchemaElement> |
Gets and sets the property SearchSchema. The search schema that defines partition key and inline filter attributes for the vector index. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. |
|
|
VectorAttribute | Amazon.DynamoDBv2.Model.VectorAttributeDefinition |
Gets and sets the property VectorAttribute. The vector attribute configuration for the index. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer