Class: Aws::ComprehendMedical::Types::DetectPHIResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#entitiesArray<Types::Entity>

The collection of PHI entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in its detection.

Returns:



515
516
517
518
519
520
521
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 515

class DetectPHIResponse < Struct.new(
  :entities,
  :pagination_token,
  :model_version)
  SENSITIVE = []
  include Aws::Structure
end

#model_versionString

The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

Returns:

  • (String)


515
516
517
518
519
520
521
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 515

class DetectPHIResponse < Struct.new(
  :entities,
  :pagination_token,
  :model_version)
  SENSITIVE = []
  include Aws::Structure
end

#pagination_tokenString

If the result of the previous request to DetectPHI was truncated, include the PaginationToken to fetch the next page of PHI entities.

Returns:

  • (String)


515
516
517
518
519
520
521
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 515

class DetectPHIResponse < Struct.new(
  :entities,
  :pagination_token,
  :model_version)
  SENSITIVE = []
  include Aws::Structure
end