Container for the parameters to the SearchVectors operation. Performs a vector similarity search on a vector index associated with an Amazon DynamoDB table, and returns the most similar items sorted by similarity score based on the distance function configured for the index.
Score interpretation depends on the distance function:
COSINE- Returns the items with the k smallest scores. Scores range from 0 (identical) to 2 (opposite). Lower scores indicate higher similarity.EUCLIDEAN- Returns the items with the k smallest scores. Scores represent the Euclidean distance between vectors. Lower scores indicate higher similarity.DOT_PRODUCT- Returns the items with the k highest scores. Higher scores indicate higher similarity.
In this article ▶
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.DynamoDBv2.AmazonDynamoDBRequest
Amazon.DynamoDBv2.Model.SearchVectorsRequest
Namespace: Amazon.DynamoDBv2.Model
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z
Syntax
public class SearchVectorsRequest : AmazonDynamoDBRequest IAmazonWebServiceRequest
The SearchVectorsRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
SearchVectorsRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
ExpressionAttributeNames | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property ExpressionAttributeNames.
One or more substitution tokens for attribute names in an expression. Use the |
|
|
ExpressionAttributeValues | System.Collections.Generic.Dictionary<System.String, Amazon.DynamoDBv2.Model.AttributeValue> |
Gets and sets the property ExpressionAttributeValues.
One or more values that can be substituted in an expression. Use the |
|
|
IndexName | System.String |
Gets and sets the property IndexName.
The name of the vector index to search. The index must be in the |
|
|
ProjectionExpression | System.String |
Gets and sets the property ProjectionExpression. A string that identifies one or more attributes to retrieve from the index. Separate attribute names with commas. If not specified, the operation returns all attributes projected into the vector index. Only attributes projected into the vector index can be retrieved. |
|
|
ReturnConsumedCapacity | Amazon.DynamoDBv2.ReturnConsumedCapacity |
Gets and sets the property ReturnConsumedCapacity. |
|
|
SearchConditionExpression | System.String |
Gets and sets the property SearchConditionExpression.
A condition expression used to filter the vector search results. The expression can
reference attributes defined in the vector index search schema, including
Only the equality operator ( |
|
|
SearchVector | System.Collections.Generic.List<Amazon.DynamoDBv2.Model.AttributeValue> |
Gets and sets the property SearchVector. The search vector to compare against the indexed vectors. Each element is a 32-bit IEEE-754 floating point number, provided in DynamoDB list format. The number of dimensions must match the number of dimensions configured 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. |
|
|
TableName | System.String |
Gets and sets the property TableName. The name or Amazon Resource Name (ARN) of the table containing the vector index. |
|
|
TopK | System.Nullable<System.Int32> |
Gets and sets the property TopK. The number of most similar results to return. |
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