Loading TOC...

entity functions

The table below lists all the entity built-in functions (in this namespace: http://marklogic.com/entity).

Use the entity enrichment library to manage entity dictionaries and perform dictionary-based entity extraction and enrichment. For details, see Entity Extraction and Enrichment in the Search Developer's Guide.

The entity enrichment library module is installed as the following file:

  • install_dir/Modules/MarkLogic/entity.xqy

where install_dir is the directory in which MarkLogic Server is installed.

To use this module in your own XQuery modules, include the following line in your XQuery prolog:

import module namespace entity="http://marklogic.com/entity" at "/MarkLogic/entity.xqy"

5 functions
Function name Description
entity:dictionary-insert Put an entity dictionary into the database in the appropriate format.
entity:dictionary-load Load an entity dictionary from the filesystem into the database in the appropriate format.
entity:enrich Returns the entity-enriched XML for the given XML node using the provided dictionary.
entity:extract Extract entities from a document using the provided entity dictionary.
entity:skos-dictionary Construct an entity dictionary from a SKOS ontology loaded into the database as triples.