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.

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.

Inheritance Hierarchy

System.Object
  Amazon.DynamoDBv2.Model.VectorIndexDescription

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

Syntax

C#
public class VectorIndexDescription

The VectorIndexDescription type exposes the following members

Constructors

NameDescription
Public Method VectorIndexDescription()

Properties

NameTypeDescription
Public Property Backfilling System.Nullable<System.Boolean>

Gets and sets the property Backfilling.

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

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 between vectors.

Public Property IndexArn System.String

Gets and sets the property IndexArn.

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

Public Property IndexName System.String

Gets and sets the property IndexName.

The name of the vector index.

Public Property IndexSizeBytes System.Nullable<System.Int64>

Gets and sets the property 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.

Public Property IndexStatus Amazon.DynamoDBv2.IndexStatus

Gets and sets the property IndexStatus.

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.

Public Property ItemCount System.Nullable<System.Int64>

Gets and sets the property 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.

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 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.

Public Property 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