Represents a request to perform a vector search in a DynamoDB table using the Document Model.
In this article ▶
Inheritance Hierarchy
Amazon.DynamoDBv2.DocumentModel.DocumentOperationRequest
Amazon.DynamoDBv2.DocumentModel.SearchVectorsOperationRequest
Namespace: Amazon.DynamoDBv2.DocumentModel
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z
Syntax
public class SearchVectorsOperationRequest : DocumentOperationRequest
The SearchVectorsOperationRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
SearchVectorsOperationRequest() |
Initializes a new Amazon.DynamoDBv2.DocumentModel.SearchVectorsOperationRequest with default settings. |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
IndexName | System.String |
Gets or sets the index name to query against. |
|
|
ProjectionExpression | Amazon.DynamoDBv2.DocumentModel.Expression |
Gets or sets the projection expression specifying which attributes should be retrieved. |
|
|
ReturnConsumedCapacity | Amazon.DynamoDBv2.ReturnConsumedCapacity |
Controls whether DynamoDB returns vector capacity consumption details for each SearchVectors request. Defaults to NONE. Set to TOTAL or INDEXES to capture consumed capacity metrics in SearchVectors.Metrics. |
|
|
SearchConditionExpression | Amazon.DynamoDBv2.DocumentModel.Expression |
Gets or sets the filter expression specifying which items should be returned. |
|
|
SearchVector | System.Collections.Generic.List<System.Single> |
Gets or sets the required query vector as a list of numeric ( |
|
|
TopK | System.Int32 |
Gets or sets the number of top results to return from the vector search. |
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