Struct SearchFacesByImageInput 

#[non_exhaustive]
pub struct SearchFacesByImageInput {
    pub collection_id: Option<String>,
    pub image: Option<Image>,
    pub max_faces: Option<i32>,
    pub face_match_threshold: Option<f32>,
    pub quality_filter: Option<QualityFilter>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

collection_id: Option<String>

ID of the collection to search.

image: Option<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 is not 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.

max_faces: Option<i32>

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

face_match_threshold: Option<f32>

(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

quality_filter: Option<QualityFilter>

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. 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 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. The default value is NONE.

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

Implementations

impl SearchFacesByImageInput

pub fn collection_id(&self) -> Option<&str>

ID of the collection to search.

pub fn image(&self) -> Option<&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 is not 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.

pub fn max_faces(&self) -> Option<i32>

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

pub fn face_match_threshold(&self) -> Option<f32>

(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

pub fn quality_filter(&self) -> Option<&QualityFilter>

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. 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 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. The default value is NONE.

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

impl SearchFacesByImageInput

pub fn builder() -> SearchFacesByImageInputBuilder

Creates a new builder-style object to manufacture SearchFacesByImageInput.

Trait Implementations

impl Clone for SearchFacesByImageInput

fn clone(&self) -> SearchFacesByImageInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchFacesByImageInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for SearchFacesByImageInput

fn eq(&self, other: &SearchFacesByImageInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SearchFacesByImageInput