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

Inherits:
Struct
  • Object
show all
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 collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bounding_boxTypes::BoundingBox

Bounding box of the face.

Returns:



2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2862

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

#confidenceFloat

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

Returns:

  • (Float)


2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2862

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_idString

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

Returns:

  • (String)


2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2862

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_idString

Unique identifier that Amazon Rekognition assigns to the face.

Returns:

  • (String)


2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2862

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_idString

Unique identifier that Amazon Rekognition assigns to the input image.

Returns:

  • (String)


2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2862

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_versionString

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

Returns:

  • (String)


2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2862

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_idString

Unique identifier assigned to the user.

Returns:

  • (String)


2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 2862

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