s3vectors/aws.sdk.kotlin.services.s3vectors.model/QueryVectorsRequest/Builder

Builder

Properties

Metadata filter to apply during the query. For more information about metadata keys, see Metadata filtering in the Amazon S3 User Guide.

indexArn

var indexArn: String?

The ARN of the vector index that you want to query.

indexName

var indexName: String?

The name of the vector index that you want to query.

queryVector

var queryVector: VectorData?

The query vector. Ensure that the query vector has the same dimension as the dimension of the vector index that's being queried. For example, if your vector index contains vectors with 384 dimensions, your query vector must also have 384 dimensions.

returnDistance

var returnDistance: Boolean?

Indicates whether to include the computed distance in the response. The default value is false.

returnMetadata

var returnMetadata: Boolean?

Indicates whether to include metadata in the response. The default value is false.

topK

var topK: Int?

The number of results to return for each query.

vectorBucketName

var vectorBucketName: String?

The name of the vector bucket that contains the vector index.