Package software.amazon.awssdk.services.dynamodb.model

Interface VectorIndex.Builder

All Superinterfaces:

Buildable, CopyableBuilder<VectorIndex.Builder,VectorIndex>, SdkBuilder<VectorIndex.Builder,VectorIndex>, SdkPojo

Enclosing class:

VectorIndex

@Mutable
@NotThreadSafe
public static interface VectorIndex.Builder
extends SdkPojo, CopyableBuilder<VectorIndex.Builder,VectorIndex>

Method Summary

Modifier and Type	Method	Description
VectorIndex.Builder	dimensions(Long dimensions)	The number of dimensions in each vector.
VectorIndex.Builder	distanceFunction(String distanceFunction)	The distance function used to calculate similarity between vectors.
VectorIndex.Builder	distanceFunction(VectorDistanceFunction distanceFunction)	The distance function used to calculate similarity between vectors.
VectorIndex.Builder	indexName(String indexName)	The name of the vector index.
default VectorIndex.Builder	projection(Consumer<Projection.Builder> projection)	Specifies attributes that are copied (projected) from the table into the vector index.
VectorIndex.Builder	projection(Projection projection)	Specifies attributes that are copied (projected) from the table into the vector index.
VectorIndex.Builder	searchSchema(Collection<SearchSchemaElement> searchSchema)	The search schema that defines partition key and inline filter attributes for the vector index.
VectorIndex.Builder	searchSchema(Consumer<SearchSchemaElement.Builder>... searchSchema)	The search schema that defines partition key and inline filter attributes for the vector index.
VectorIndex.Builder	searchSchema(SearchSchemaElement... searchSchema)	The search schema that defines partition key and inline filter attributes for the vector index.
default VectorIndex.Builder	vectorAttribute(Consumer<VectorAttributeDefinition.Builder> vectorAttribute)	The vector attribute configuration for the index.
VectorIndex.Builder	vectorAttribute(VectorAttributeDefinition vectorAttribute)	The vector attribute configuration for the index.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

indexName

VectorIndex.Builder indexName(String indexName)

The name of the vector index.

Parameters:

indexName - The name of the vector index.

Returns:

Returns a reference to this object so that method calls can be chained together.

vectorAttribute

VectorIndex.Builder vectorAttribute(VectorAttributeDefinition vectorAttribute)

The vector attribute configuration for the index.

Parameters:

vectorAttribute - The vector attribute configuration for the index.

Returns:

Returns a reference to this object so that method calls can be chained together.

vectorAttribute

default VectorIndex.Builder vectorAttribute(Consumer<VectorAttributeDefinition.Builder> vectorAttribute)

The vector attribute configuration for the index.

This is a convenience method that creates an instance of the VectorAttributeDefinition.Builder avoiding the need to create one manually via VectorAttributeDefinition.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vectorAttribute(VectorAttributeDefinition).

Parameters:

vectorAttribute - a consumer that will call methods on VectorAttributeDefinition.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• vectorAttribute(VectorAttributeDefinition)

searchSchema

VectorIndex.Builder searchSchema(Collection<SearchSchemaElement> searchSchema)

The search schema that defines partition key and inline filter attributes for the vector index.

Parameters:

searchSchema - The search schema that defines partition key and inline filter attributes for the vector index.

Returns:

Returns a reference to this object so that method calls can be chained together.

searchSchema

VectorIndex.Builder searchSchema(SearchSchemaElement... searchSchema)

The search schema that defines partition key and inline filter attributes for the vector index.

Parameters:

searchSchema - The search schema that defines partition key and inline filter attributes for the vector index.

Returns:

Returns a reference to this object so that method calls can be chained together.

searchSchema

VectorIndex.Builder searchSchema(Consumer<SearchSchemaElement.Builder>... searchSchema)

The search schema that defines partition key and inline filter attributes for the vector index.

This is a convenience method that creates an instance of the SearchSchemaElement.Builder avoiding the need to create one manually via SearchSchemaElement.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to searchSchema(List<SearchSchemaElement>).

Parameters:

searchSchema - a consumer that will call methods on SearchSchemaElement.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• searchSchema(java.util.Collection<SearchSchemaElement>)

projection

VectorIndex.Builder projection(Projection projection)

Specifies attributes that are copied (projected) from the table into the vector index.

Parameters:

projection - Specifies attributes that are copied (projected) from the table into the vector index.

Returns:

Returns a reference to this object so that method calls can be chained together.

projection

default VectorIndex.Builder projection(Consumer<Projection.Builder> projection)

Specifies attributes that are copied (projected) from the table into the vector index.

This is a convenience method that creates an instance of the Projection.Builder avoiding the need to create one manually via Projection.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to projection(Projection).

Parameters:

projection - a consumer that will call methods on Projection.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• projection(Projection)

dimensions

VectorIndex.Builder dimensions(Long dimensions)

The number of dimensions in each vector.

Parameters:

dimensions - The number of dimensions in each vector.

Returns:

Returns a reference to this object so that method calls can be chained together.

distanceFunction

VectorIndex.Builder distanceFunction(String distanceFunction)

The distance function used to calculate similarity between vectors. Valid values: COSINE, EUCLIDEAN, DOT_PRODUCT.

Parameters:

distanceFunction - The distance function used to calculate similarity between vectors. Valid values: COSINE, EUCLIDEAN, DOT_PRODUCT.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• VectorDistanceFunction
• VectorDistanceFunction

distanceFunction

VectorIndex.Builder distanceFunction(VectorDistanceFunction distanceFunction)

The distance function used to calculate similarity between vectors. Valid values: COSINE, EUCLIDEAN, DOT_PRODUCT.

Parameters:

distanceFunction - The distance function used to calculate similarity between vectors. Valid values: COSINE, EUCLIDEAN, DOT_PRODUCT.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• VectorDistanceFunction
• VectorDistanceFunction