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

Inherits:

Struct

• Object
• Struct
• Aws::TranscribeStreamingService::Types::Entity

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #category ⇒ String

  The category of information identified.

• #confidence ⇒ Float

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

• #content ⇒ String

  The word or words identified as PII.

• #end_time ⇒ Float

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

• #start_time ⇒ Float

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

• #type ⇒ String

  The type of PII identified.

Instance Attribute Details

#category ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 347

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

#confidence ⇒ Float

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)

# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 347

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

#content ⇒ String

The word or words identified as PII.

Returns:

• (String)

# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 347

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

#end_time ⇒ Float

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

Returns:

• (Float)

# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 347

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

#start_time ⇒ Float

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

Returns:

• (Float)

# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 347

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

#type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 347

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