Class: Aws::ComprehendMedical::Types::DetectEntitiesResponse

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 medical 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 Comprehend Medical; has in the detection and analysis. Attributes and traits of the entity are also returned.

Returns:



403
404
405
406
407
408
409
410
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 403

class DetectEntitiesResponse < Struct.new(
  :entities,
  :unmapped_attributes,
  :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)


403
404
405
406
407
408
409
410
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 403

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

#pagination_tokenString

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

Returns:

  • (String)


403
404
405
406
407
408
409
410
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 403

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

#unmapped_attributesArray<Types::UnmappedAttribute>

Attributes extracted from the input text that we were unable to relate to an entity.

Returns:



403
404
405
406
407
408
409
410
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 403

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