Class: Aws::Rekognition::Types::GetFaceLivenessSessionResultsResponse

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::GetFaceLivenessSessionResultsResponse

Defined in:

gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #audit_images ⇒ Array<Types::AuditImage>

  A set of images from the Face Liveness video that can be used for audit purposes.

• #challenge ⇒ Types::Challenge

  Contains information regarding the challenge type used for the Face Liveness check.

• #confidence ⇒ Float

  Probabalistic confidence score for if the person in the given video was live, represented as a float value between 0 to 100.

• #feedback ⇒ Array<Types::FeedbackItem>

  A list of conditions that were detected in the Face Liveness video and that contributed to the returned Confidence score.

• #metadata ⇒ Types::SessionMetadata

  Metadata about the client that streamed the video for the Face Liveness session.

• #reference_image ⇒ Types::AuditImage

  A high-quality image from the Face Liveness video that can be used for face comparison or search.

• #session_id ⇒ String

  The sessionId for which this request was called.

• #status ⇒ String

  Represents a status corresponding to the state of the session.

Instance Attribute Details

#audit_images ⇒ Array<Types::AuditImage>

A set of images from the Face Liveness video that can be used for audit purposes. It includes a bounding box of the face and the Base64-encoded bytes that return an image. If the CreateFaceLivenessSession request included an OutputConfig argument, the image will be uploaded to an S3Object specified in the output configuration. If no Amazon S3 bucket is defined, raw bytes are sent instead.

Returns:

• (Array<Types::AuditImage>)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3718

class GetFaceLivenessSessionResultsResponse < Struct.new(
  :session_id,
  :status,
  :confidence,
  :reference_image,
  :audit_images,
  :challenge,
  :feedback,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#challenge ⇒ Types::Challenge

Contains information regarding the challenge type used for the Face Liveness check.

Returns:

• (Types::Challenge)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3718

class GetFaceLivenessSessionResultsResponse < Struct.new(
  :session_id,
  :status,
  :confidence,
  :reference_image,
  :audit_images,
  :challenge,
  :feedback,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#confidence ⇒ Float

Probabalistic confidence score for if the person in the given video was live, represented as a float value between 0 to 100.

Returns:

• (Float)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3718

class GetFaceLivenessSessionResultsResponse < Struct.new(
  :session_id,
  :status,
  :confidence,
  :reference_image,
  :audit_images,
  :challenge,
  :feedback,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#feedback ⇒ Array<Types::FeedbackItem>

A list of conditions that were detected in the Face Liveness video and that contributed to the returned Confidence score. Each item contains a code and a human-readable message. Feedback is returned only for sessions with a Status of SUCCEEDED, and the list is empty when no such conditions were detected.

Returns:

• (Array<Types::FeedbackItem>)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3718

class GetFaceLivenessSessionResultsResponse < Struct.new(
  :session_id,
  :status,
  :confidence,
  :reference_image,
  :audit_images,
  :challenge,
  :feedback,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#metadata ⇒ Types::SessionMetadata

Metadata about the client that streamed the video for the Face Liveness session.

Returns:

• (Types::SessionMetadata)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3718

class GetFaceLivenessSessionResultsResponse < Struct.new(
  :session_id,
  :status,
  :confidence,
  :reference_image,
  :audit_images,
  :challenge,
  :feedback,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#reference_image ⇒ Types::AuditImage

A high-quality image from the Face Liveness video that can be used for face comparison or search. It includes a bounding box of the face and the Base64-encoded bytes that return an image. If the CreateFaceLivenessSession request included an OutputConfig argument, the image will be uploaded to an S3Object specified in the output configuration. In case the reference image is not returned, it's recommended to retry the Liveness check.

Returns:

• (Types::AuditImage)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3718

class GetFaceLivenessSessionResultsResponse < Struct.new(
  :session_id,
  :status,
  :confidence,
  :reference_image,
  :audit_images,
  :challenge,
  :feedback,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#session_id ⇒ String

The sessionId for which this request was called.

Returns:

• (String)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3718

class GetFaceLivenessSessionResultsResponse < Struct.new(
  :session_id,
  :status,
  :confidence,
  :reference_image,
  :audit_images,
  :challenge,
  :feedback,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Represents a status corresponding to the state of the session. Possible statuses are: CREATED, IN_PROGRESS, SUCCEEDED, FAILED, EXPIRED.

Returns:

• (String)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3718

class GetFaceLivenessSessionResultsResponse < Struct.new(
  :session_id,
  :status,
  :confidence,
  :reference_image,
  :audit_images,
  :challenge,
  :feedback,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end