DICE API Documentation/com.embabel.dice.common/KnownEntity

KnownEntity

data class KnownEntity(val entity: <Error class: unknown class>, val role: String, val aliases: List<String> = emptyList())

A known entity with additional context for this extraction. Delegates to the wrapped NamedEntity.

Parameters

entity

The named entity

role

The role this entity plays in the current analysis, e.g., "The user in the conversation", "A referenced entity".

aliases

Alternate NAME forms this entity is also known by, beyond entity's primary name — e.g. a nickname ("Tom" for "Thomas") or a maiden/former name. Resolvers may match a chunk mention against any alias so an alt-name reference to the current user binds to the user rather than forking a new external entity. Distinct from alternate email ADDRESSES.

Constructors

KnownEntity

constructor(entity: <Error class: unknown class>, role: String, aliases: List<String> = emptyList())

Types

Companion

object Companion

RoleStep

class RoleStep(entity: <Error class: unknown class>)

Builder step requiring the role.

Properties

aliases

val aliases: List<String>

entity

val entity: <Error class: unknown class>

role

val role: String