Interface QueryVectorsResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<QueryVectorsResponse.Builder,QueryVectorsResponse>, S3VectorsResponse.Builder, SdkBuilder<QueryVectorsResponse.Builder,QueryVectorsResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
QueryVectorsResponse
@Mutable @NotThreadSafe public static interface QueryVectorsResponse.Builder extends S3VectorsResponse.Builder, SdkPojo, CopyableBuilder<QueryVectorsResponse.Builder,QueryVectorsResponse>

  • Method Details

    • vectors

      QueryVectorsResponse.Builder vectors(Collection<QueryOutputVector> vectors)

      The vectors in the approximate nearest neighbor search.

      Parameters:
      vectors - The vectors in the approximate nearest neighbor search.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vectors

      QueryVectorsResponse.Builder vectors(QueryOutputVector... vectors)

      The vectors in the approximate nearest neighbor search.

      Parameters:
      vectors - The vectors in the approximate nearest neighbor search.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vectors

      QueryVectorsResponse.Builder vectors(Consumer<QueryOutputVector.Builder>... vectors)

      The vectors in the approximate nearest neighbor search.

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

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

      Parameters:
      vectors - a consumer that will call methods on QueryOutputVector.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • distanceMetric

      QueryVectorsResponse.Builder distanceMetric(String distanceMetric)

      The distance metric that was used for the similarity search calculation. This is the same distance metric that was configured for the vector index when it was created.

      Parameters:
      distanceMetric - The distance metric that was used for the similarity search calculation. This is the same distance metric that was configured for the vector index when it was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • distanceMetric

      QueryVectorsResponse.Builder distanceMetric(DistanceMetric distanceMetric)

      The distance metric that was used for the similarity search calculation. This is the same distance metric that was configured for the vector index when it was created.

      Parameters:
      distanceMetric - The distance metric that was used for the similarity search calculation. This is the same distance metric that was configured for the vector index when it was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nextToken

      QueryVectorsResponse.Builder nextToken(String nextToken)

      Pagination token to be used in the subsequent page request. The field is empty if no further pagination is required.

      Parameters:
      nextToken - Pagination token to be used in the subsequent page request. The field is empty if no further pagination is required.
      Returns:
      Returns a reference to this object so that method calls can be chained together.