Interface DynamoDbVectorIndex<T>

Type Parameters:

T - The type of the modelled object.

All Known Implementing Classes:

DefaultDynamoDbVectorIndex

@SdkPublicApi
@ThreadSafe
public interface DynamoDbVectorIndex<T>

Synchronous interface for running vector search commands against a specific DynamoDb vector index linked to a mapped table.

By default, all command methods throw an UnsupportedOperationException to prevent interface extensions from breaking implementing classes.

Method Summary

Modifier and Type	Method	Description
String	indexName()	Gets the physical vector index name that operations performed by this object will be executed against.
DynamoDbEnhancedClientExtension	mapperExtension()	Gets the DynamoDbEnhancedClientExtension associated with this mapped resource.
default SearchVectorsEnhancedResponse<T>	searchVectorsWithResponse(Consumer<SearchVectorsEnhancedRequest.Builder> requestConsumer)	Executes a vector similarity search against this vector index and returns the full enhanced response.
default SearchVectorsEnhancedResponse<T>	searchVectorsWithResponse(SearchVectorsEnhancedRequest request)	Executes a vector similarity search against this vector index and returns the full enhanced response.
String	tableName()	Gets the physical table name that operations performed by this object will be executed against.
TableSchema<T>	tableSchema()	Gets the TableSchema object that this mapped vector index was built with.

Method Details

searchVectorsWithResponse

default SearchVectorsEnhancedResponse<T> searchVectorsWithResponse(SearchVectorsEnhancedRequest request)

Executes a vector similarity search against this vector index and returns the full enhanced response.

Parameters:

request - A SearchVectorsEnhancedRequest defining the search parameters.

Returns:

A SearchVectorsEnhancedResponse containing results and vector capacity metadata.

searchVectorsWithResponse

default SearchVectorsEnhancedResponse<T> searchVectorsWithResponse(Consumer<SearchVectorsEnhancedRequest.Builder> requestConsumer)

Executes a vector similarity search against this vector index and returns the full enhanced response.

Parameters:

requestConsumer - A Consumer of SearchVectorsEnhancedRequest.Builder.

Returns:

A SearchVectorsEnhancedResponse containing results and vector capacity metadata.

mapperExtension

DynamoDbEnhancedClientExtension mapperExtension()

Gets the DynamoDbEnhancedClientExtension associated with this mapped resource.

Returns:

The DynamoDbEnhancedClientExtension associated with this mapped resource.

tableSchema

TableSchema<T> tableSchema()

Gets the TableSchema object that this mapped vector index was built with.

Returns:

The TableSchema object for this mapped vector index.

tableName

String tableName()

Gets the physical table name that operations performed by this object will be executed against.

Returns:

The physical table name.

indexName

String indexName()

Gets the physical vector index name that operations performed by this object will be executed against.

Returns:

The physical vector index name.