Class QueryVectorsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.s3vectors.model.S3VectorsRequest
software.amazon.awssdk.services.s3vectors.model.QueryVectorsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<QueryVectorsRequest.Builder,QueryVectorsRequest>
@Generated("software.amazon.awssdk:codegen") public final class QueryVectorsRequest extends S3VectorsRequest implements ToCopyableBuilder<QueryVectorsRequest.Builder,QueryVectorsRequest>

  • Method Details

    • vectorBucketName

      public final String vectorBucketName()

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

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

    • indexName

      public final String indexName()

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

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

    • indexArn

      public final String indexArn()

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

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

    • topK

      public final Integer topK()

      The number of results to return for each query.

      Returns:
      The number of results to return for each query.

    • queryVector

      public final VectorData queryVector()

      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.

      Returns:
      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.

    • filter

      public final Document filter()

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

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

    • returnMetadata

      public final Boolean returnMetadata()

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

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

    • returnDistance

      public final Boolean returnDistance()

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

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

    • toBuilder

      public QueryVectorsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<QueryVectorsRequest.Builder,QueryVectorsRequest>
      Specified by:
      toBuilder in class S3VectorsRequest
      Returns:
      a builder for type T

    • builder

      public static QueryVectorsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends QueryVectorsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.