Entity
Provides information about an entity.
Contents
- BeginOffset
-
The zero-based offset from the beginning of the source text to the first character in the entity.
This field is empty for non-text input.
Type: Integer
Required: No
- BlockReferences
-
A reference to each block for this entity. This field is empty for plain-text input.
Type: Array of BlockReference objects
Required: No
- EndOffset
-
The zero-based offset from the beginning of the source text to the last character in the entity.
This field is empty for non-text input.
Type: Integer
Required: No
- Score
-
The level of confidence that Amazon Comprehend has in the accuracy of the detection.
Type: Float
Required: No
- Text
-
The text of the entity.
Type: String
Length Constraints: Minimum length of 1.
Required: No
- Type
-
The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.
For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.
Type: String
Valid Values:
PERSON | LOCATION | ORGANIZATION | COMMERCIAL_ITEM | EVENT | DATE | QUANTITY | TITLE | OTHERRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
