Class DefaultDynamoDbVectorIndex<T>

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.internal.client.DefaultDynamoDbVectorIndex<T>

All Implemented Interfaces:

DynamoDbVectorIndex<T>

@SdkInternalApi
public final class DefaultDynamoDbVectorIndex<T>
extends Object
implements DynamoDbVectorIndex<T>

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()
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.
SearchVectorsEnhancedResponse<T>	searchVectorsWithResponse(Consumer<SearchVectorsEnhancedRequest.Builder> requestConsumer)	Executes a vector similarity search against this vector index and returns the full enhanced response.
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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

searchVectorsWithResponse

public SearchVectorsEnhancedResponse<T> searchVectorsWithResponse(SearchVectorsEnhancedRequest request)

Description copied from interface: DynamoDbVectorIndex

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

Specified by:

searchVectorsWithResponse in interface DynamoDbVectorIndex<T>

Parameters:

request - A SearchVectorsEnhancedRequest defining the search parameters.

Returns:

A SearchVectorsEnhancedResponse containing results and vector capacity metadata.

searchVectorsWithResponse

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

Description copied from interface: DynamoDbVectorIndex

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

Specified by:

searchVectorsWithResponse in interface DynamoDbVectorIndex<T>

Parameters:

requestConsumer - A Consumer of SearchVectorsEnhancedRequest.Builder.

Returns:

A SearchVectorsEnhancedResponse containing results and vector capacity metadata.

mapperExtension

public DynamoDbEnhancedClientExtension mapperExtension()

Description copied from interface: DynamoDbVectorIndex

Gets the DynamoDbEnhancedClientExtension associated with this mapped resource.

Specified by:

mapperExtension in interface DynamoDbVectorIndex<T>

Returns:

The DynamoDbEnhancedClientExtension associated with this mapped resource.

tableSchema

public TableSchema<T> tableSchema()

Description copied from interface: DynamoDbVectorIndex

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

Specified by:

tableSchema in interface DynamoDbVectorIndex<T>

Returns:

The TableSchema object for this mapped vector index.

tableName

public String tableName()

Description copied from interface: DynamoDbVectorIndex

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

Specified by:

tableName in interface DynamoDbVectorIndex<T>

Returns:

The physical table name.

indexName

public String indexName()

Description copied from interface: DynamoDbVectorIndex

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

Specified by:

indexName in interface DynamoDbVectorIndex<T>

Returns:

The physical vector index name.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object