Interface SearchVectorsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<SearchVectorsRequest.Builder,SearchVectorsRequest>, DynamoDbRequest.Builder, SdkBuilder<SearchVectorsRequest.Builder,SearchVectorsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
SearchVectorsRequest
@Mutable @NotThreadSafe public static interface SearchVectorsRequest.Builder extends DynamoDbRequest.Builder, SdkPojo, CopyableBuilder<SearchVectorsRequest.Builder,SearchVectorsRequest>

  • Method Details

    • tableName

      SearchVectorsRequest.Builder tableName(String tableName)

      The name or Amazon Resource Name (ARN) of the table containing the vector index.

      Parameters:
      tableName - The name or Amazon Resource Name (ARN) of the table containing the vector index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • indexName

      SearchVectorsRequest.Builder indexName(String indexName)

      The name of the vector index to search. The index must be in the ACTIVE state.

      Parameters:
      indexName - The name of the vector index to search. The index must be in the ACTIVE state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • returnConsumedCapacity

      SearchVectorsRequest.Builder returnConsumedCapacity(String returnConsumedCapacity)
      Sets the value of the ReturnConsumedCapacity property for this object.
      Parameters:
      returnConsumedCapacity - The new value for the ReturnConsumedCapacity property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • returnConsumedCapacity

      SearchVectorsRequest.Builder returnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
      Sets the value of the ReturnConsumedCapacity property for this object.
      Parameters:
      returnConsumedCapacity - The new value for the ReturnConsumedCapacity property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • expressionAttributeNames

      SearchVectorsRequest.Builder expressionAttributeNames(Map<String,String> expressionAttributeNames)

      One or more substitution tokens for attribute names in an expression. Use the # character in an expression to dereference an attribute name.

      Parameters:
      expressionAttributeNames - One or more substitution tokens for attribute names in an expression. Use the # character in an expression to dereference an attribute name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • expressionAttributeValues

      SearchVectorsRequest.Builder expressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)

      One or more values that can be substituted in an expression. Use the : character in an expression to dereference an attribute value.

      Parameters:
      expressionAttributeValues - One or more values that can be substituted in an expression. Use the : character in an expression to dereference an attribute value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • projectionExpression

      SearchVectorsRequest.Builder projectionExpression(String projectionExpression)

      A string that identifies one or more attributes to retrieve from the index. Separate attribute names with commas. If not specified, the operation returns all attributes projected into the vector index.

      Only attributes projected into the vector index can be retrieved.

      Parameters:
      projectionExpression - A string that identifies one or more attributes to retrieve from the index. Separate attribute names with commas. If not specified, the operation returns all attributes projected into the vector index.

      Only attributes projected into the vector index can be retrieved.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • searchVector

      SearchVectorsRequest.Builder searchVector(Collection<AttributeValue> searchVector)

      The search vector to compare against the indexed vectors. Each element is a 32-bit IEEE-754 floating point number, provided in DynamoDB list format.

      The number of dimensions must match the number of dimensions configured for the vector index.

      Parameters:
      searchVector - The search vector to compare against the indexed vectors. Each element is a 32-bit IEEE-754 floating point number, provided in DynamoDB list format.

      The number of dimensions must match the number of dimensions configured for the vector index.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • searchVector

      SearchVectorsRequest.Builder searchVector(AttributeValue... searchVector)

      The search vector to compare against the indexed vectors. Each element is a 32-bit IEEE-754 floating point number, provided in DynamoDB list format.

      The number of dimensions must match the number of dimensions configured for the vector index.

      Parameters:
      searchVector - The search vector to compare against the indexed vectors. Each element is a 32-bit IEEE-754 floating point number, provided in DynamoDB list format.

      The number of dimensions must match the number of dimensions configured for the vector index.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • searchVector

      SearchVectorsRequest.Builder searchVector(Consumer<AttributeValue.Builder>... searchVector)

      The search vector to compare against the indexed vectors. Each element is a 32-bit IEEE-754 floating point number, provided in DynamoDB list format.

      The number of dimensions must match the number of dimensions configured for the vector index.

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

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

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

    • searchConditionExpression

      SearchVectorsRequest.Builder searchConditionExpression(String searchConditionExpression)

      A condition expression used to filter the vector search results. The expression can reference attributes defined in the vector index search schema, including HASH and INLINE_FILTER key elements.

      Only the equality operator (=) is supported for HASH attributes. Comparison and range operators are supported for INLINE_FILTER attributes. Only top-level attributes from the search schema can be referenced.

      Parameters:
      searchConditionExpression - A condition expression used to filter the vector search results. The expression can reference attributes defined in the vector index search schema, including HASH and INLINE_FILTER key elements.

      Only the equality operator (=) is supported for HASH attributes. Comparison and range operators are supported for INLINE_FILTER attributes. Only top-level attributes from the search schema can be referenced.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • topK

      SearchVectorsRequest.Builder topK(Integer topK)

      The number of most similar results to return.

      Parameters:
      topK - The number of most similar results to return.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      SearchVectorsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      SearchVectorsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.