Class: Aws::TranscribeStreamingService::Types::Entity

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-transcribestreamingservice/types.rb

Overview

Contains entities identified as personally identifiable information (PII) in your transcription output, along with various associated attributes. Examples include category, confidence score, type, stability score, and start and end times.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#categoryString

The category of information identified. The only category is ‘PII`.

Returns:

  • (String)


339
340
341
342
343
344
345
346
347
348
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 339

class Entity < Struct.new(
  :start_time,
  :end_time,
  :category,
  :type,
  :content,
  :confidence)
  SENSITIVE = []
  include Aws::Structure
end

#confidenceFloat

The confidence score associated with the identified PII entity in your audio.

Confidence scores are values between 0 and 1. A larger value indicates a higher probability that the identified entity correctly matches the entity spoken in your media.

Returns:

  • (Float)


339
340
341
342
343
344
345
346
347
348
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 339

class Entity < Struct.new(
  :start_time,
  :end_time,
  :category,
  :type,
  :content,
  :confidence)
  SENSITIVE = []
  include Aws::Structure
end

#contentString

The word or words identified as PII.

Returns:

  • (String)


339
340
341
342
343
344
345
346
347
348
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 339

class Entity < Struct.new(
  :start_time,
  :end_time,
  :category,
  :type,
  :content,
  :confidence)
  SENSITIVE = []
  include Aws::Structure
end

#end_timeFloat

The end time, in milliseconds, of the utterance that was identified as PII.

Returns:

  • (Float)


339
340
341
342
343
344
345
346
347
348
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 339

class Entity < Struct.new(
  :start_time,
  :end_time,
  :category,
  :type,
  :content,
  :confidence)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeFloat

The start time, in milliseconds, of the utterance that was identified as PII.

Returns:

  • (Float)


339
340
341
342
343
344
345
346
347
348
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 339

class Entity < Struct.new(
  :start_time,
  :end_time,
  :category,
  :type,
  :content,
  :confidence)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The type of PII identified. For example, ‘NAME` or `CREDIT_DEBIT_NUMBER`.

Returns:

  • (String)


339
340
341
342
343
344
345
346
347
348
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 339

class Entity < Struct.new(
  :start_time,
  :end_time,
  :category,
  :type,
  :content,
  :confidence)
  SENSITIVE = []
  include Aws::Structure
end