Package io.goobi.viewer.api.rest.model.ner

package io.goobi.viewer.api.rest.model.ner

Model classes for named-entity recognition (NER) results exposed through the REST API, representing tags, tag groups, page and document references, and aggregated tag counts.

Related Packages

Package	Description
io.goobi.viewer.api.rest.model	Shared data transfer objects and helper classes used across REST API versions, including generic request parameters, response wrappers, and user-facing model facades.
io.goobi.viewer.api.rest.model.index	Model classes representing Solr index field metadata exposed through the REST API, such as field information descriptors used for index inspection endpoints.
io.goobi.viewer.api.rest.model.monitoring	Model classes for the application health and monitoring REST endpoints, encapsulating the aggregated status information returned by monitoring checks.
io.goobi.viewer.api.rest.model.tasks	Model classes for asynchronous background task management in the REST API, representing task descriptors, parameters, and the central task manager.

Class	Description
DocumentReference	REST API model representing a digitized document identified by its persistent identifier (PI), together with the NER tag groups found across its pages.
ElementReference	REST API model referencing a single named-entity element within a page of a digitized document.
MultiPageReference	REST API model representing a contiguous range of pages (defined by a first and last page order number) that share a set of NER tag counts.
NERTag	REST API model representing a single named-entity recognition (NER) tag extracted from a digitized document.
NERTag.Type	Enumerates the recognized categories of named entities, such as persons, locations, corporations, events, and miscellaneous types.
PageReference	REST API model representing a single page of a digitized document and the NER tag counts found on it.
TagCount	REST API model aggregating the occurrences of a single named-entity tag value and type within a page group.
TagGroup	Common interface for NER result containers that group TagCount entries by page scope — either a single page (PageReference) or a contiguous page range (MultiPageReference).