Serialized Form

Package com.amazonaws.services.comprehendmedical.model

Class com.amazonaws.services.comprehendmedical.model.Attribute extends Object implements Serializable

Serialized Fields

type

String type

The type of attribute.

score

Float score

The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute.

relationshipScore

Float relationshipScore

The level of confidence that Comprehend Medical has that this attribute is correctly related to this entity.

id

Integer id

The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.

beginOffset

Integer beginOffset

The 0-based character offset in the input text that shows where the attribute begins. The offset returns the UTF-8 code point in the string.

endOffset

Integer endOffset

The 0-based character offset in the input text that shows where the attribute ends. The offset returns the UTF-8 code point in the string.

text

String text

The segment of input text extracted as this attribute.

traits

List<E> traits

Contextual information for this attribute.

Class com.amazonaws.services.comprehendmedical.model.AWSComprehendMedicalException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.comprehendmedical.model.DetectEntitiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

text

String text

A UTF-8 text string containing the clinical content being examined for entities. Each string must contain fewer than 20,000 bytes of characters.

Class com.amazonaws.services.comprehendmedical.model.DetectEntitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

entities

List<E> entities

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.

unmappedAttributes

List<E> unmappedAttributes

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

paginationToken

String paginationToken

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

Class com.amazonaws.services.comprehendmedical.model.DetectPHIRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

text

String text

A UTF-8 text string containing the clinical content being examined for PHI entities. Each string must contain fewer than 20,000 bytes of characters.

Class com.amazonaws.services.comprehendmedical.model.DetectPHIResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

entities

List<E> entities

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 Comprehend Medical has in its detection.

paginationToken

String paginationToken

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

Class com.amazonaws.services.comprehendmedical.model.Entity extends Object implements Serializable

Serialized Fields

id

Integer id

The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.

beginOffset

Integer beginOffset

The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.

endOffset

Integer endOffset

The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.

score

Float score

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

text

String text

The segment of input text extracted as this entity.

category

String category

The category of the entity.

type

String type

Describes the specific type of entity with category of entities.

traits

List<E> traits

Contextual information for the entity

attributes

List<E> attributes

The extracted attributes that relate to this entity.

Class com.amazonaws.services.comprehendmedical.model.InternalServerException extends AWSComprehendMedicalException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.comprehendmedical.model.InvalidEncodingException extends AWSComprehendMedicalException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.comprehendmedical.model.InvalidRequestException extends AWSComprehendMedicalException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.comprehendmedical.model.ServiceUnavailableException extends AWSComprehendMedicalException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.comprehendmedical.model.TextSizeLimitExceededException extends AWSComprehendMedicalException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.comprehendmedical.model.TooManyRequestsException extends AWSComprehendMedicalException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.comprehendmedical.model.Trait extends Object implements Serializable

Serialized Fields

name

String name

Provides a name or contextual description about the trait.

score

Float score

The level of confidence that Comprehend Medical has in the accuracy of this trait.

Class com.amazonaws.services.comprehendmedical.model.UnmappedAttribute extends Object implements Serializable

Serialized Fields

type

String type

The type of the attribute, could be one of the following values: "MEDICATION", "MEDICAL_CONDITION", "ANATOMY", "TEST_AND_TREATMENT_PROCEDURE" or "PERSONAL_HEALTH_INFORMATION".

attribute

Attribute attribute

The specific attribute that has been extracted but not mapped to an entity.