Documentation

Provides information about an entity.

See: newEntity smart constructor.

Create a value of Entity 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:

Entity, entity_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.

$sel:blockReferences:Entity', entity_blockReferences - A reference to each block for this entity. This field is empty for plain-text input.

Entity, entity_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.

$sel:score:Entity', entity_score - The level of confidence that Amazon Comprehend has in the accuracy of the detection.

$sel:text:Entity', entity_text - The text of the entity.

$sel:type':Entity', entity_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.

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.

A reference to each block for this entity. This field is empty for plain-text input.

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.

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

The text of the entity.

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.