comprehendmedical/aws.sdk.kotlin.services.comprehendmedical.model/Attribute

Attribute

An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the dosage of a medication taken. It contains information about the attribute such as id, begin and end offset within the input text, and the segment of the input text.

Types

Builder

class Builder

Companion

object Companion

Properties

beginOffset

val beginOffset: Int?

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.

category

val category: EntityType?

The category of attribute.

endOffset

val endOffset: Int?

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.

val id: Int?

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

relationshipScore

val relationshipScore: Float?

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

relationshipType

val relationshipType: RelationshipType?

The type of relationship between the entity and attribute. Type for the relationship is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.

score

val score: Float?

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

text

val text: String?

The segment of input text extracted as this attribute.

traits

val traits: List<Trait>?

Contextual information for this attribute.

type

val type: EntitySubType?

The type of attribute.