Interface VectorIndexInfo.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<VectorIndexInfo.Builder,,VectorIndexInfo> SdkBuilder<VectorIndexInfo.Builder,,VectorIndexInfo> SdkPojo
- Enclosing class:
VectorIndexInfo
@Mutable
@NotThreadSafe
public static interface VectorIndexInfo.Builder
extends SdkPojo, CopyableBuilder<VectorIndexInfo.Builder,VectorIndexInfo>
-
Method Summary
Modifier and TypeMethodDescriptiondimensions(Long dimensions) The number of dimensions in each vector.distanceFunction(String distanceFunction) The distance function used to calculate similarity between vectors.distanceFunction(VectorDistanceFunction distanceFunction) The distance function used to calculate similarity between vectors.The name of the vector index.default VectorIndexInfo.Builderprojection(Consumer<Projection.Builder> projection) Specifies attributes that are copied (projected) from the table into the vector index.projection(Projection projection) Specifies attributes that are copied (projected) from the table into the vector index.searchSchema(Collection<SearchSchemaElement> searchSchema) The search schema that defines partition key and inline filter attributes for the vector index.searchSchema(Consumer<SearchSchemaElement.Builder>... searchSchema) The search schema that defines partition key and inline filter attributes for the vector index.searchSchema(SearchSchemaElement... searchSchema) The search schema that defines partition key and inline filter attributes for the vector index.default VectorIndexInfo.BuildervectorAttribute(Consumer<VectorAttributeDefinition.Builder> vectorAttribute) The vector attribute configuration for the index.vectorAttribute(VectorAttributeDefinition vectorAttribute) The vector attribute configuration for the index.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
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
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 VectorIndexInfo.Builder vectorAttribute(Consumer<VectorAttributeDefinition.Builder> vectorAttribute) The vector attribute configuration for the index.
This is a convenience method that creates an instance of theVectorAttributeDefinition.Builderavoiding the need to create one manually viaVectorAttributeDefinition.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tovectorAttribute(VectorAttributeDefinition).- Parameters:
vectorAttribute- a consumer that will call methods onVectorAttributeDefinition.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 theSearchSchemaElement.Builderavoiding the need to create one manually viaSearchSchemaElement.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tosearchSchema(List<SearchSchemaElement>).- Parameters:
searchSchema- a consumer that will call methods onSearchSchemaElement.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
Specifies attributes that are copied (projected) from the table into the vector index.
This is a convenience method that creates an instance of theProjection.Builderavoiding the need to create one manually viaProjection.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toprojection(Projection).- Parameters:
projection- a consumer that will call methods onProjection.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The distance function used to calculate similarity between vectors.
- Parameters:
distanceFunction- The distance function used to calculate similarity between vectors.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
distanceFunction
The distance function used to calculate similarity between vectors.
- Parameters:
distanceFunction- The distance function used to calculate similarity between vectors.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-