Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Entity

Provides information about an extracted medical entity.

Hierarchy

  • Entity

Index

Properties

Optional Attributes

Attributes: Attribute[]

The extracted attributes that relate to this entity.

Optional BeginOffset

BeginOffset: undefined | number

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.

Optional Category

Category: EntityType | string

The category of the entity.

Optional EndOffset

EndOffset: undefined | number

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.

Optional Id

Id: undefined | number

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

Optional Score

Score: undefined | number

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

Optional Text

Text: undefined | string

The segment of input text extracted as this entity.

Optional Traits

Traits: Trait[]

Contextual information for the entity.

Optional Type

Type: EntitySubType | string

Describes the specific type of entity with category of entities.