Package org.apache.tika.parser.ner.corenlp

Class CoreNLPNERecogniser

java.lang.Object

org.apache.tika.parser.ner.corenlp.CoreNLPNERecogniser

All Implemented Interfaces:

NERecogniser

public class CoreNLPNERecogniser
extends Object
implements NERecogniser

This class offers an implementation of NERecogniser based on CRF classifiers from Stanford CoreNLP. This NER requires additional setup, due to runtime binding to Stanford CoreNLP. See Tika NER Wiki for configuring this recogniser.

See Also:

• NERecogniser

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_MODEL_PATH	default Model path
static final Set<String>	ENTITY_TYPES
static final String	MODEL_PROP_NAME
static final String	NER_3CLASS_MODEL
static final String	NER_4CLASS_MODEL
static final String	NER_7CLASS_MODEL

Fields inherited from interface org.apache.tika.parser.ner.NERecogniser

DATE, LOCATION, MISCELLANEOUS, MONEY, ORGANIZATION, PERCENT, PERSON, TIME

Constructor Summary

Constructors

Constructor	Description
CoreNLPNERecogniser()
CoreNLPNERecogniser(String modelPath)	Creates a NERecogniser by loading model from given path

Method Summary

Modifier and Type	Method	Description
Set<String>	getEntityTypes()	Gets set of entity types recognised by this recogniser
boolean	isAvailable()	checks if this Named Entity recogniser is available for service
static void	main(String[] args)
Map<String,Set<String>>	recognise(String text)	recognises names of entities in the text

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NER_3CLASS_MODEL

public static final String NER_3CLASS_MODEL

See Also:

• Constant Field Values

NER_4CLASS_MODEL

public static final String NER_4CLASS_MODEL

See Also:

• Constant Field Values

NER_7CLASS_MODEL

public static final String NER_7CLASS_MODEL

See Also:

• Constant Field Values

DEFAULT_MODEL_PATH

public static final String DEFAULT_MODEL_PATH

default Model path

See Also:

• Constant Field Values

MODEL_PROP_NAME

public static final String MODEL_PROP_NAME

See Also:

• Constant Field Values

ENTITY_TYPES

public static final Set<String> ENTITY_TYPES

Constructor Details

CoreNLPNERecogniser

public CoreNLPNERecogniser()

CoreNLPNERecogniser

public CoreNLPNERecogniser(String modelPath)

Creates a NERecogniser by loading model from given path

Parameters:

modelPath - path to NER model file

Method Details

main

public static void main(String[] args)
                 throws IOException,
com.github.openjson.JSONException

Throws:

IOException

com.github.openjson.JSONException

isAvailable

public boolean isAvailable()

Description copied from interface: NERecogniser

checks if this Named Entity recogniser is available for service

Specified by:

isAvailable in interface NERecogniser

Returns:

true if model was available, valid and was able to initialise the classifier. returns false when this recogniser is not available for service.

getEntityTypes

public Set<String> getEntityTypes()

Gets set of entity types recognised by this recogniser

Specified by:

getEntityTypes in interface NERecogniser

Returns:

set of entity classes/types

recognise

public Map<String,Set<String>> recognise(String text)

recognises names of entities in the text

Specified by:

recognise in interface NERecogniser

Parameters:

text - text which possibly contains names

Returns:

map of entity type -> set of names