AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

A new vector index to be added to a table.

Inheritance Hierarchy

System.Object
  Amazon.DynamoDBv2.Model.CreateVectorIndexAction

Namespace: Amazon.DynamoDBv2.Model
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z

Syntax

C#
public class CreateVectorIndexAction

The CreateVectorIndexAction type exposes the following members

Constructors

NameDescription
Public Method CreateVectorIndexAction()

Properties

NameTypeDescription
Public Property Dimensions System.Nullable<System.Int64>

Gets and sets the property Dimensions.

The number of dimensions in each vector.

Public Property DistanceFunction Amazon.DynamoDBv2.VectorDistanceFunction

Gets and sets the property DistanceFunction.

The distance function used to calculate similarity. Valid values: COSINE, EUCLIDEAN, DOT_PRODUCT.

Public Property IndexName System.String

Gets and sets the property IndexName.

The name of the vector index. Must be unique within the table.

Public Property Projection Amazon.DynamoDBv2.Model.Projection

Gets and sets the property Projection.

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

Public Property SearchSchema System.Collections.Generic.List<Amazon.DynamoDBv2.Model.SearchSchemaElement>

Gets and sets the property SearchSchema.

The partition key and inline filter attribute definitions 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.

Public Property VectorAttribute Amazon.DynamoDBv2.Model.VectorAttributeDefinition

Gets and sets the property VectorAttribute.

The attribute that contains vector embeddings. If multiple vector indexes reference the same attribute, they must all use the same number of dimensions.

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