Class: Aws::Rekognition::Types::Face

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::Face

Defined in:

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

Overview

Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bounding_box ⇒ Types::BoundingBox

  Bounding box of the face.

• #confidence ⇒ Float

  Confidence level that the bounding box contains a face (and not a different object such as a tree).

• #external_image_id ⇒ String

  Identifier that you assign to all the faces in the input image.

• #face_id ⇒ String

  Unique identifier that Amazon Rekognition assigns to the face.

• #image_id ⇒ String

  Unique identifier that Amazon Rekognition assigns to the input image.

• #index_faces_model_version ⇒ String

  The version of the face detect and storage model that was used when indexing the face vector.

• #user_id ⇒ String

  Unique identifier assigned to the user.

Instance Attribute Details

#bounding_box ⇒ Types::BoundingBox

Bounding box of the face.

Returns:

• (Types::BoundingBox)

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

class Face < Struct.new(
  :face_id,
  :bounding_box,
  :image_id,
  :external_image_id,
  :confidence,
  :index_faces_model_version,
  :user_id)
  SENSITIVE = []
  include Aws::Structure
end

#confidence ⇒ Float

Confidence level that the bounding box contains a face (and not a different object such as a tree).

Returns:

• (Float)

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

class Face < Struct.new(
  :face_id,
  :bounding_box,
  :image_id,
  :external_image_id,
  :confidence,
  :index_faces_model_version,
  :user_id)
  SENSITIVE = []
  include Aws::Structure
end

#external_image_id ⇒ String

Identifier that you assign to all the faces in the input image.

Returns:

• (String)

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

class Face < Struct.new(
  :face_id,
  :bounding_box,
  :image_id,
  :external_image_id,
  :confidence,
  :index_faces_model_version,
  :user_id)
  SENSITIVE = []
  include Aws::Structure
end

#face_id ⇒ String

Unique identifier that Amazon Rekognition assigns to the face.

Returns:

• (String)

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

class Face < Struct.new(
  :face_id,
  :bounding_box,
  :image_id,
  :external_image_id,
  :confidence,
  :index_faces_model_version,
  :user_id)
  SENSITIVE = []
  include Aws::Structure
end

#image_id ⇒ String

Unique identifier that Amazon Rekognition assigns to the input image.

Returns:

• (String)

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

class Face < Struct.new(
  :face_id,
  :bounding_box,
  :image_id,
  :external_image_id,
  :confidence,
  :index_faces_model_version,
  :user_id)
  SENSITIVE = []
  include Aws::Structure
end

#index_faces_model_version ⇒ String

The version of the face detect and storage model that was used when indexing the face vector.

Returns:

• (String)

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

class Face < Struct.new(
  :face_id,
  :bounding_box,
  :image_id,
  :external_image_id,
  :confidence,
  :index_faces_model_version,
  :user_id)
  SENSITIVE = []
  include Aws::Structure
end

#user_id ⇒ String

Unique identifier assigned to the user.

Returns:

• (String)

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

class Face < Struct.new(
  :face_id,
  :bounding_box,
  :image_id,
  :external_image_id,
  :confidence,
  :index_faces_model_version,
  :user_id)
  SENSITIVE = []
  include Aws::Structure
end