Builder

class Builder

Properties

Link copied to clipboard

The Amazon resource Name (ARN) of the vector index.

Link copied to clipboard

The name of the vector index.

Link copied to clipboard

The maximum number of vectors to return on a page.

Link copied to clipboard

Pagination token from a previous request. The value of this field is empty for an initial request.

Link copied to clipboard

If true, the vector data of each vector will be included in the response. The default value is false.

Link copied to clipboard

If true, the metadata associated with each vector will be included in the response. The default value is false.

Link copied to clipboard

For a parallel ListVectors request, segmentCount represents the total number of vector segments into which the ListVectors operation will be divided. The value of segmentCount corresponds to the number of application workers that will perform the parallel ListVectors operation. For example, if you want to use four application threads to list vectors in a vector index, specify a segmentCount value of 4.

Link copied to clipboard

For a parallel ListVectors request, segmentIndex is the index of the segment from which to list vectors in the current request. It identifies an individual segment to be listed by an application worker.

Link copied to clipboard

The name of the vector bucket.