| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.ComprehendMedical.DetectEntitiesV2
Description
Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information. Amazon Comprehend Medical only detects medical entities in English language texts.
The DetectEntitiesV2 operation replaces the DetectEntities operation.
This new action uses a different model for determining the entities in
your medical text and changes the way that some entities are returned in
the output. You should use the DetectEntitiesV2 operation in all new
applications.
The DetectEntitiesV2 operation returns the Acuity and Direction
entities as attributes instead of types.
Synopsis
- data DetectEntitiesV2 = DetectEntitiesV2' {}
- newDetectEntitiesV2 :: Text -> DetectEntitiesV2
- detectEntitiesV2_text :: Lens' DetectEntitiesV2 Text
- data DetectEntitiesV2Response = DetectEntitiesV2Response' {}
- newDetectEntitiesV2Response :: Int -> Text -> DetectEntitiesV2Response
- detectEntitiesV2Response_paginationToken :: Lens' DetectEntitiesV2Response (Maybe Text)
- detectEntitiesV2Response_unmappedAttributes :: Lens' DetectEntitiesV2Response (Maybe [UnmappedAttribute])
- detectEntitiesV2Response_httpStatus :: Lens' DetectEntitiesV2Response Int
- detectEntitiesV2Response_entities :: Lens' DetectEntitiesV2Response [Entity]
- detectEntitiesV2Response_modelVersion :: Lens' DetectEntitiesV2Response Text
Creating a Request
data DetectEntitiesV2 Source #
See: newDetectEntitiesV2 smart constructor.
Constructors
| DetectEntitiesV2' | |
Instances
Arguments
| :: Text | |
| -> DetectEntitiesV2 |
Create a value of DetectEntitiesV2 with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:text:DetectEntitiesV2', detectEntitiesV2_text - A UTF-8 string containing the clinical content being examined for
entities. Each string must contain fewer than 20,000 bytes of
characters.
Request Lenses
detectEntitiesV2_text :: Lens' DetectEntitiesV2 Text Source #
A UTF-8 string containing the clinical content being examined for entities. Each string must contain fewer than 20,000 bytes of characters.
Destructuring the Response
data DetectEntitiesV2Response Source #
See: newDetectEntitiesV2Response smart constructor.
Constructors
| DetectEntitiesV2Response' | |
Fields
| |
Instances
newDetectEntitiesV2Response Source #
Arguments
| :: Int | |
| -> Text | |
| -> DetectEntitiesV2Response |
Create a value of DetectEntitiesV2Response with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:paginationToken:DetectEntitiesV2Response', detectEntitiesV2Response_paginationToken - If the result to the DetectEntitiesV2 operation was truncated, include
the PaginationToken to fetch the next page of entities.
$sel:unmappedAttributes:DetectEntitiesV2Response', detectEntitiesV2Response_unmappedAttributes - Attributes extracted from the input text that couldn't be related to an
entity.
$sel:httpStatus:DetectEntitiesV2Response', detectEntitiesV2Response_httpStatus - The response's http status code.
$sel:entities:DetectEntitiesV2Response', detectEntitiesV2Response_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 in the detection and analysis. Attributes
and traits of the entity are also returned.
$sel:modelVersion:DetectEntitiesV2Response', detectEntitiesV2Response_modelVersion - 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.
Response Lenses
detectEntitiesV2Response_paginationToken :: Lens' DetectEntitiesV2Response (Maybe Text) Source #
If the result to the DetectEntitiesV2 operation was truncated, include
the PaginationToken to fetch the next page of entities.
detectEntitiesV2Response_unmappedAttributes :: Lens' DetectEntitiesV2Response (Maybe [UnmappedAttribute]) Source #
Attributes extracted from the input text that couldn't be related to an entity.
detectEntitiesV2Response_httpStatus :: Lens' DetectEntitiesV2Response Int Source #
The response's http status code.
detectEntitiesV2Response_entities :: Lens' DetectEntitiesV2Response [Entity] Source #
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 in the detection and analysis. Attributes and traits of the entity are also returned.
detectEntitiesV2Response_modelVersion :: Lens' DetectEntitiesV2Response Text Source #
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.