Entity

    A Named Entity represents a real-world object inside Arkindex. It's linked to one or more Element through a MetaData or a Transcription.

    Rules🔗

    • An Entity must belong to a pre-defined set of type:
      • Person
      • Location
      • Organization
      • Number
      • Date
      • Subject (as in subject-matter: History, Architecture, ...)
      • Misc (should be restricted as a fallback option)
    • An Entity should be unique per project
      • but we cannot enforce this at the database level, as we could have two different persons with the same name in a project.
    • An Entity may be linked to another entity through an EntityLink:
      • this link establishes a hierarchy between a parent entity and a child entity
    • An EntityLink must have a role defined throughEntityRole
      • this is important to know which type of relation is defined between the two entities
    • An Entity may be linked to an Element through a MetaData
      • For example, this is used to share a common location for several books
    • An Entity may be linked to an Element through a Transcription
      • A single Transcription may have several Entity (for example 2 persons and a location)
      • A TranscriptionEntity is used to specify precisely where in the transcription text is situated the entity
      • A TranscriptionEntity can be moderated by a human annotator through the web interface
    Relations between entities and other parts of a Project
    Relations between entities and other parts of a Project

    A link between two entities can be created through an EntityLink, by specifying

    • which Entity is the parent.
    • which Entity is the child.
    • which EntityRole links them together.

    For example, to create "Mother - Son" relationship, you'll need:

    • an EntityRole named "Mother - Son" (the name is just for display purposes)
    • An Entity of type Person, named "Alice"
    • An Entity of type Person, named "George"

    Then you'll be able to link "Alice" and "George", using the "Mother - Son" relationship.

    An EntityLink can be used to link entities of different types:

    • an Organisation and a Person: this may be an "Employee" relationship
    • a Date and a Location: this would become an Event
    This system allows us to modelise any Entity structure as a graph
    This system allows us to modelise any Entity structure as a graph

    Web interface🔗

    Arkindex's web interface enables you to:

    • View each entity and their usage on an element.
    • View relations between entities.

    Contributors on a project are allowed to:

    • Validate or Reject entities usage on a transcription.
    Entities appear clearly on a transcription, with their type and approval
    Entities appear clearly on a transcription, with their type and approval
    You can validate entities positions and pertinence on a Transcription
    You can validate entities positions and pertinence on a Transcription

    Below on the same panel, you can found the list of entities attached to this element and their relations.

    Entities list and roles panel on the details panel Entities list and roles panel on the details panel
    Entities list and roles panel on the details panel

    By clicking on an entity you can access its dedicated page, which contains its details, relations and links to elements.

    Entity details page
    Entity details page

    API Endpoints🔗

    These endpoints are the most useful to handle entities: