AWS SDK for C++  1.9.129
AWS SDK for C++
Public Member Functions | List of all members
Aws::Rekognition::Model::CompareFacesRequest Class Reference

#include <CompareFacesRequest.h>

+ Inheritance diagram for Aws::Rekognition::Model::CompareFacesRequest:

Public Member Functions

 CompareFacesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const ImageGetSourceImage () const
 
bool SourceImageHasBeenSet () const
 
void SetSourceImage (const Image &value)
 
void SetSourceImage (Image &&value)
 
CompareFacesRequestWithSourceImage (const Image &value)
 
CompareFacesRequestWithSourceImage (Image &&value)
 
const ImageGetTargetImage () const
 
bool TargetImageHasBeenSet () const
 
void SetTargetImage (const Image &value)
 
void SetTargetImage (Image &&value)
 
CompareFacesRequestWithTargetImage (const Image &value)
 
CompareFacesRequestWithTargetImage (Image &&value)
 
double GetSimilarityThreshold () const
 
bool SimilarityThresholdHasBeenSet () const
 
void SetSimilarityThreshold (double value)
 
CompareFacesRequestWithSimilarityThreshold (double value)
 
const QualityFilterGetQualityFilter () const
 
bool QualityFilterHasBeenSet () const
 
void SetQualityFilter (const QualityFilter &value)
 
void SetQualityFilter (QualityFilter &&value)
 
CompareFacesRequestWithQualityFilter (const QualityFilter &value)
 
CompareFacesRequestWithQualityFilter (QualityFilter &&value)
 
- Public Member Functions inherited from Aws::Rekognition::RekognitionRequest
virtual ~RekognitionRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file CompareFacesRequest.h.

Constructor & Destructor Documentation

◆ CompareFacesRequest()

Aws::Rekognition::Model::CompareFacesRequest::CompareFacesRequest ( )

Member Function Documentation

◆ GetQualityFilter()

const QualityFilter& Aws::Rekognition::Model::CompareFacesRequest::GetQualityFilter ( ) const
inline

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't compared. 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.

Definition at line 198 of file CompareFacesRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Rekognition::Model::CompareFacesRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::Rekognition::Model::CompareFacesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file CompareFacesRequest.h.

◆ GetSimilarityThreshold()

double Aws::Rekognition::Model::CompareFacesRequest::GetSimilarityThreshold ( ) const
inline

The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.

Definition at line 164 of file CompareFacesRequest.h.

◆ GetSourceImage()

const Image& Aws::Rekognition::Model::CompareFacesRequest::GetSourceImage ( ) const
inline

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.

Definition at line 46 of file CompareFacesRequest.h.

◆ GetTargetImage()

const Image& Aws::Rekognition::Model::CompareFacesRequest::GetTargetImage ( ) const
inline

The target 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.

Definition at line 107 of file CompareFacesRequest.h.

◆ QualityFilterHasBeenSet()

bool Aws::Rekognition::Model::CompareFacesRequest::QualityFilterHasBeenSet ( ) const
inline

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't compared. 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.

Definition at line 213 of file CompareFacesRequest.h.

◆ SerializePayload()

Aws::String Aws::Rekognition::Model::CompareFacesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetQualityFilter() [1/2]

void Aws::Rekognition::Model::CompareFacesRequest::SetQualityFilter ( const QualityFilter value)
inline

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't compared. 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.

Definition at line 228 of file CompareFacesRequest.h.

◆ SetQualityFilter() [2/2]

void Aws::Rekognition::Model::CompareFacesRequest::SetQualityFilter ( QualityFilter &&  value)
inline

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't compared. 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.

Definition at line 243 of file CompareFacesRequest.h.

◆ SetSimilarityThreshold()

void Aws::Rekognition::Model::CompareFacesRequest::SetSimilarityThreshold ( double  value)
inline

The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.

Definition at line 176 of file CompareFacesRequest.h.

◆ SetSourceImage() [1/2]

void Aws::Rekognition::Model::CompareFacesRequest::SetSourceImage ( const Image value)
inline

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.

Definition at line 66 of file CompareFacesRequest.h.

◆ SetSourceImage() [2/2]

void Aws::Rekognition::Model::CompareFacesRequest::SetSourceImage ( Image &&  value)
inline

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.

Definition at line 76 of file CompareFacesRequest.h.

◆ SetTargetImage() [1/2]

void Aws::Rekognition::Model::CompareFacesRequest::SetTargetImage ( const Image value)
inline

The target 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.

Definition at line 127 of file CompareFacesRequest.h.

◆ SetTargetImage() [2/2]

void Aws::Rekognition::Model::CompareFacesRequest::SetTargetImage ( Image &&  value)
inline

The target 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.

Definition at line 137 of file CompareFacesRequest.h.

◆ SimilarityThresholdHasBeenSet()

bool Aws::Rekognition::Model::CompareFacesRequest::SimilarityThresholdHasBeenSet ( ) const
inline

The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.

Definition at line 170 of file CompareFacesRequest.h.

◆ SourceImageHasBeenSet()

bool Aws::Rekognition::Model::CompareFacesRequest::SourceImageHasBeenSet ( ) const
inline

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.

Definition at line 56 of file CompareFacesRequest.h.

◆ TargetImageHasBeenSet()

bool Aws::Rekognition::Model::CompareFacesRequest::TargetImageHasBeenSet ( ) const
inline

The target 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.

Definition at line 117 of file CompareFacesRequest.h.

◆ WithQualityFilter() [1/2]

CompareFacesRequest& Aws::Rekognition::Model::CompareFacesRequest::WithQualityFilter ( const QualityFilter value)
inline

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't compared. 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.

Definition at line 258 of file CompareFacesRequest.h.

◆ WithQualityFilter() [2/2]

CompareFacesRequest& Aws::Rekognition::Model::CompareFacesRequest::WithQualityFilter ( QualityFilter &&  value)
inline

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't compared. 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.

Definition at line 273 of file CompareFacesRequest.h.

◆ WithSimilarityThreshold()

CompareFacesRequest& Aws::Rekognition::Model::CompareFacesRequest::WithSimilarityThreshold ( double  value)
inline

The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.

Definition at line 182 of file CompareFacesRequest.h.

◆ WithSourceImage() [1/2]

CompareFacesRequest& Aws::Rekognition::Model::CompareFacesRequest::WithSourceImage ( const Image value)
inline

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.

Definition at line 86 of file CompareFacesRequest.h.

◆ WithSourceImage() [2/2]

CompareFacesRequest& Aws::Rekognition::Model::CompareFacesRequest::WithSourceImage ( Image &&  value)
inline

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.

Definition at line 96 of file CompareFacesRequest.h.

◆ WithTargetImage() [1/2]

CompareFacesRequest& Aws::Rekognition::Model::CompareFacesRequest::WithTargetImage ( const Image value)
inline

The target 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.

Definition at line 147 of file CompareFacesRequest.h.

◆ WithTargetImage() [2/2]

CompareFacesRequest& Aws::Rekognition::Model::CompareFacesRequest::WithTargetImage ( Image &&  value)
inline

The target 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.

Definition at line 157 of file CompareFacesRequest.h.


The documentation for this class was generated from the following file: