Entity

public struct Entity : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The extracted attributes that relate to this entity.

    Declaration

    Swift

    public let attributes: [Attribute]?

  • 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.

    Declaration

    Swift

    public let beginOffset: Int?

  • The category of the entity.

    Declaration

    Swift

    public let category: EntityType?

  • 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.

    Declaration

    Swift

    public let endOffset: Int?
  • id

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

    Declaration

    Swift

    public let id: Int?

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

    Declaration

    Swift

    public let score: Float?

  • The segment of input text extracted as this entity.

    Declaration

    Swift

    public let text: String?

  • Contextual information for the entity.

    Declaration

    Swift

    public let traits: [Trait]?

  • Describes the specific type of entity with category of entities.

    Declaration

    Swift

    public let type: EntitySubType?

  • Undocumented

    Declaration

    Swift

    public init(attributes: [Attribute]? = nil, beginOffset: Int? = nil, category: EntityType? = nil, endOffset: Int? = nil, id: Int? = nil, score: Float? = nil, text: String? = nil, traits: [Trait]? = nil, type: EntitySubType? = nil)