Class: Aws::Comprehend::Types::PiiEntity

Inherits:

Struct

• Object
• Struct
• Aws::Comprehend::Types::PiiEntity

Defined in:

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

Overview

Provides information about a PII entity.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #begin_offset ⇒ Integer

  A character offset in the input text that shows where the PII entity begins (the first character is at position 0).

• #end_offset ⇒ Integer

  A character offset in the input text that shows where the PII entity ends.

• #score ⇒ Float

  The level of confidence that Amazon Comprehend has in the accuracy of the detection.

• #type ⇒ String

  The entity's type.

Instance Attribute Details

#begin_offset ⇒ Integer

A character offset in the input text that shows where the PII entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Returns:

• (Integer)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5277

class PiiEntity < Struct.new(
  :score,
  :type,
  :begin_offset,
  :end_offset)
  SENSITIVE = []
  include Aws::Structure
end

#end_offset ⇒ Integer

A character offset in the input text that shows where the PII entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Returns:

• (Integer)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5277

class PiiEntity < Struct.new(
  :score,
  :type,
  :begin_offset,
  :end_offset)
  SENSITIVE = []
  include Aws::Structure
end

#score ⇒ Float

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

Returns:

• (Float)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5277

class PiiEntity < Struct.new(
  :score,
  :type,
  :begin_offset,
  :end_offset)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The entity's type.

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5277

class PiiEntity < Struct.new(
  :score,
  :type,
  :begin_offset,
  :end_offset)
  SENSITIVE = []
  include Aws::Structure
end