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

Interface CreateVectorIndexAction.Builder

All Superinterfaces:

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

Enclosing class:

CreateVectorIndexAction

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

Method Summary

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

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

CreateVectorIndexAction.Builder indexName(String indexName)

The name of the vector index. Must be unique within the table.

Parameters:

indexName - The name of the vector index. Must be unique within the table.

Returns:

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

vectorAttribute

CreateVectorIndexAction.Builder vectorAttribute(VectorAttributeDefinition vectorAttribute)

The attribute that contains vector embeddings. If multiple vector indexes reference the same attribute, they must all use the same number of dimensions.

Parameters:

vectorAttribute - The attribute that contains vector embeddings. If multiple vector indexes reference the same attribute, they must all use the same number of dimensions.

Returns:

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

vectorAttribute

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

The attribute that contains vector embeddings. If multiple vector indexes reference the same attribute, they must all use the same number of dimensions.

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

CreateVectorIndexAction.Builder searchSchema(Collection<SearchSchemaElement> searchSchema)

The partition key and inline filter attribute definitions for the vector index.

Parameters:

searchSchema - The partition key and inline filter attribute definitions for the vector index.

Returns:

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

searchSchema

CreateVectorIndexAction.Builder searchSchema(SearchSchemaElement... searchSchema)

The partition key and inline filter attribute definitions for the vector index.

Parameters:

searchSchema - The partition key and inline filter attribute definitions for the vector index.

Returns:

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

searchSchema

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

The partition key and inline filter attribute definitions 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

CreateVectorIndexAction.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 CreateVectorIndexAction.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

CreateVectorIndexAction.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

CreateVectorIndexAction.Builder distanceFunction(String distanceFunction)

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

Parameters:

distanceFunction - The distance function used to calculate similarity. 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

CreateVectorIndexAction.Builder distanceFunction(VectorDistanceFunction distanceFunction)

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

Parameters:

distanceFunction - The distance function used to calculate similarity. 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