Interface IndexFacesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<IndexFacesRequest.Builder,IndexFacesRequest>, RekognitionRequest.Builder, SdkBuilder<IndexFacesRequest.Builder,IndexFacesRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
IndexFacesRequest
public static interface IndexFacesRequest.Builder extends RekognitionRequest.Builder, SdkPojo, CopyableBuilder<IndexFacesRequest.Builder,IndexFacesRequest>

  • Method Details

    • collectionId

      IndexFacesRequest.Builder collectionId(String collectionId)

      The ID of an existing collection to which you want to add the faces that are detected in the input images.

      Parameters:
      collectionId - The ID of an existing collection to which you want to add the faces that are detected in the input images.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • image

      IndexFacesRequest.Builder image(Image image)

      The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes isn't supported.

      If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

      Parameters:
      image - The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes isn't supported.

      If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

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

    • image

      default IndexFacesRequest.Builder image(Consumer<Image.Builder> image)

      The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes isn't supported.

      If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to image(Image).

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

    • externalImageId

      IndexFacesRequest.Builder externalImageId(String externalImageId)

      The ID you want to assign to all the faces detected in the image.

      Parameters:
      externalImageId - The ID you want to assign to all the faces detected in the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • detectionAttributesWithStrings

      IndexFacesRequest.Builder detectionAttributesWithStrings(Collection<String> detectionAttributes)

      An array of facial attributes you want to be returned. A DEFAULT subset of facial attributes - BoundingBox, Confidence, Pose, Quality, and Landmarks - will always be returned. You can request for specific facial attributes (in addition to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or just ["FACE_OCCLUDED"]. You can request for all facial attributes by using ["ALL"]. Requesting more attributes may increase response time.

      If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

      Parameters:
      detectionAttributes - An array of facial attributes you want to be returned. A DEFAULT subset of facial attributes - BoundingBox, Confidence, Pose, Quality, and Landmarks - will always be returned. You can request for specific facial attributes (in addition to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or just ["FACE_OCCLUDED"]. You can request for all facial attributes by using ["ALL"]. Requesting more attributes may increase response time.

      If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

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

    • detectionAttributesWithStrings

      IndexFacesRequest.Builder detectionAttributesWithStrings(String... detectionAttributes)

      An array of facial attributes you want to be returned. A DEFAULT subset of facial attributes - BoundingBox, Confidence, Pose, Quality, and Landmarks - will always be returned. You can request for specific facial attributes (in addition to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or just ["FACE_OCCLUDED"]. You can request for all facial attributes by using ["ALL"]. Requesting more attributes may increase response time.

      If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

      Parameters:
      detectionAttributes - An array of facial attributes you want to be returned. A DEFAULT subset of facial attributes - BoundingBox, Confidence, Pose, Quality, and Landmarks - will always be returned. You can request for specific facial attributes (in addition to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or just ["FACE_OCCLUDED"]. You can request for all facial attributes by using ["ALL"]. Requesting more attributes may increase response time.

      If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

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

    • detectionAttributes

      IndexFacesRequest.Builder detectionAttributes(Collection<Attribute> detectionAttributes)

      An array of facial attributes you want to be returned. A DEFAULT subset of facial attributes - BoundingBox, Confidence, Pose, Quality, and Landmarks - will always be returned. You can request for specific facial attributes (in addition to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or just ["FACE_OCCLUDED"]. You can request for all facial attributes by using ["ALL"]. Requesting more attributes may increase response time.

      If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

      Parameters:
      detectionAttributes - An array of facial attributes you want to be returned. A DEFAULT subset of facial attributes - BoundingBox, Confidence, Pose, Quality, and Landmarks - will always be returned. You can request for specific facial attributes (in addition to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or just ["FACE_OCCLUDED"]. You can request for all facial attributes by using ["ALL"]. Requesting more attributes may increase response time.

      If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

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

    • detectionAttributes

      IndexFacesRequest.Builder detectionAttributes(Attribute... detectionAttributes)

      An array of facial attributes you want to be returned. A DEFAULT subset of facial attributes - BoundingBox, Confidence, Pose, Quality, and Landmarks - will always be returned. You can request for specific facial attributes (in addition to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or just ["FACE_OCCLUDED"]. You can request for all facial attributes by using ["ALL"]. Requesting more attributes may increase response time.

      If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

      Parameters:
      detectionAttributes - An array of facial attributes you want to be returned. A DEFAULT subset of facial attributes - BoundingBox, Confidence, Pose, Quality, and Landmarks - will always be returned. You can request for specific facial attributes (in addition to the default list) - by using ["DEFAULT", "FACE_OCCLUDED"] or just ["FACE_OCCLUDED"]. You can request for all facial attributes by using ["ALL"]. Requesting more attributes may increase response time.

      If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

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

    • maxFaces

      IndexFacesRequest.Builder maxFaces(Integer maxFaces)

      The maximum number of faces to index. The value of MaxFaces must be greater than or equal to 1. IndexFaces returns no more than 100 detected faces in an image, even if you specify a larger value for MaxFaces.

      If IndexFaces detects more faces than the value of MaxFaces, the faces with the lowest quality are filtered out first. If there are still more faces than the value of MaxFaces, the faces with the smallest bounding boxes are filtered out (up to the number that's needed to satisfy the value of MaxFaces). Information about the unindexed faces is available in the UnindexedFaces array.

      The faces that are returned by IndexFaces are sorted by the largest face bounding box size to the smallest size, in descending order.

      MaxFaces can be used with a collection associated with any version of the face model.

      Parameters:
      maxFaces - The maximum number of faces to index. The value of MaxFaces must be greater than or equal to 1. IndexFaces returns no more than 100 detected faces in an image, even if you specify a larger value for MaxFaces.

      If IndexFaces detects more faces than the value of MaxFaces, the faces with the lowest quality are filtered out first. If there are still more faces than the value of MaxFaces, the faces with the smallest bounding boxes are filtered out (up to the number that's needed to satisfy the value of MaxFaces). Information about the unindexed faces is available in the UnindexedFaces array.

      The faces that are returned by IndexFaces are sorted by the largest face bounding box size to the smallest size, in descending order.

      MaxFaces can be used with a collection associated with any version of the face model.

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

    • qualityFilter

      IndexFacesRequest.Builder qualityFilter(String qualityFilter)

      A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't indexed. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The default value is AUTO. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed.

      To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

      Parameters:
      qualityFilter - A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't indexed. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The default value is AUTO. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed.

      To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

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

    • qualityFilter

      IndexFacesRequest.Builder qualityFilter(QualityFilter qualityFilter)

      A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't indexed. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The default value is AUTO. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed.

      To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

      Parameters:
      qualityFilter - A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't indexed. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The default value is AUTO. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed.

      To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

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

    • overrideConfiguration

      IndexFacesRequest.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

      IndexFacesRequest.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.