ISearchVectors Interface | AWS SDK for .NET Version 4

Represents the interface for a vector search response.

In this article ▶

Amazon.DynamoDBv2.DocumentModel.ISearchVectors

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

public interface ISearchVectors

The ISearchVectors type exposes the following members

Name	Type	Description
IndexName	System.String	Vector index name used to execute the similarity search.
Matches	System.Collections.Generic.List<Amazon.DynamoDBv2.DocumentModel.DocumentSearchVectorsItem>	Match results.
Metrics	Amazon.DynamoDBv2.DocumentModel.SearchVectorsMetrics	Consumed capacity metrics captured for this search operation.
ProjectionExpression	Amazon.DynamoDBv2.DocumentModel.Expression	Optional projection expression that controls which attributes are returned in matches.
SearchConditionExpression	Amazon.DynamoDBv2.DocumentModel.Expression	Optional filter expression applied to items during vector search.
SearchVector	System.Collections.Generic.List<System.Single>	The query embedding values used for similarity matching. The vector length must match the dimensions configured for the target vector index.
TableName	System.String	DynamoDB table name targeted by this vector search operation.
TopK	System.Int32	The number of top results to return from the vector search. This value must be greater than 0.

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.7.2 or higher.

	Name	Description
	Get()	Searches the vector index and returns the top K matching documents along with their scores.
	GetAsync(CancellationToken)	Asynchronously retrieves the most similar vectors from the source table based on the provided vector and similarity metric.

.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