# Copyright 2024, Battelle Energy Alliance, LLC ALL RIGHTS RESERVED
from spacy.language import Language
import logging
[docs]
logger = logging.getLogger(__name__)
@Language.factory("general_entity", default_config={"patterns": {'label': 'general', 'pattern': [{'LOWER': 'possible'}], 'id': 'general'}, "asSpan":True})
[docs]
def create_general_component(nlp, name, patterns, asSpan):
return GeneralEntity(nlp, patterns, asSpan=asSpan)
[docs]
class GeneralEntity(object):
"""
General Entity Recognition class
How to use it:
.. code-block:: python
from GeneralEntity import GeneralEntity
nlp = spacy.load("en_core_web_sm")
patterns = {'label': 'general', 'pattern': [{'LOWER': 'possible'}], 'id': 'general'}
cmatcher = generalEntity(nlp, patterns)
doc = nlp("Vibration seems like it is coming from the shaft.")
updatedDoc = cmatcher(doc)
or:
.. code-block:: python
nlp.add_pipe('general_entity', config={"patterns": {'label': 'general', 'pattern': [{'LOWER': 'possible'}], 'id': 'general'}, "asSpan":True})
newDoc = nlp(doc.text)
"""
def __init__(self, nlp, patterns, asSpan=True, callback=None):
"""
Args:
nlp: spacy nlp model
patterns: list/dict, patterns for general entity
"""
[docs]
self.name = 'general_entity'
if not isinstance(patterns, list) and isinstance(patterns, dict):
patterns = [patterns]
# do we need to pop out other pipes?
if not nlp.has_pipe('entity_ruler'):
if not nlp.has_pipe('aliasResolver'):
nlp.add_pipe('entity_ruler')
else:
nlp.add_pipe('entity_ruler', before='aliasResolver')
[docs]
self.entityRuler = nlp.get_pipe('entity_ruler')
self.entityRuler.add_patterns(patterns)
[docs]
def __call__(self, doc):
"""
Args:
doc: spacy.tokens.doc.Doc, the processed document using nlp pipelines
"""
doc = self.entityRuler(doc)
return doc