medcat.data.entities
====================

.. py:module:: medcat.data.entities


Classes
-------

.. autoapisummary::

   medcat.data.entities.MetaAnnotation
   medcat.data.entities.Entity
   medcat.data.entities.Entities
   medcat.data.entities.OnlyCUIEntities


Module Contents
---------------

.. py:class:: MetaAnnotation

   Bases: :py:obj:`TypedDict`


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)


   .. py:attribute:: value
      :type:  str


   .. py:attribute:: confidence
      :type:  float


   .. py:attribute:: name
      :type:  str


   .. py:method:: __contains__()

      True if the dictionary has the specified key, else False.



   .. py:method:: __delattr__()

      Implement delattr(self, name).



   .. py:method:: __delitem__()

      Delete self[key].



   .. py:method:: __dir__()

      Default dir() implementation.



   .. py:method:: __eq__()

      Return self==value.



   .. py:method:: __format__()

      Default object formatter.



   .. py:method:: __ge__()

      Return self>=value.



   .. py:method:: __getattribute__()

      Return getattr(self, name).



   .. py:method:: __getitem__()

      x.__getitem__(y) <==> x[y]



   .. py:method:: __gt__()

      Return self>value.



   .. py:method:: __init__()

      Initialize self.  See help(type(self)) for accurate signature.



   .. py:method:: __ior__()

      Return self|=value.



   .. py:method:: __iter__()

      Implement iter(self).



   .. py:method:: __le__()

      Return self<=value.



   .. py:method:: __len__()

      Return len(self).



   .. py:method:: __lt__()

      Return self<value.



   .. py:method:: __ne__()

      Return self!=value.



   .. py:method:: __new__()

      Create and return a new object.  See help(type) for accurate signature.



   .. py:method:: __or__()

      Return self|value.



   .. py:method:: __reduce__()

      Helper for pickle.



   .. py:method:: __reduce_ex__()

      Helper for pickle.



   .. py:method:: __repr__()

      Return repr(self).



   .. py:method:: __reversed__()

      Return a reverse iterator over the dict keys.



   .. py:method:: __ror__()

      Return value|self.



   .. py:method:: __setattr__()

      Implement setattr(self, name, value).



   .. py:method:: __setitem__()

      Set self[key] to value.



   .. py:method:: __sizeof__()

      D.__sizeof__() -> size of D in memory, in bytes



   .. py:method:: __str__()

      Return str(self).



   .. py:method:: __subclasshook__()

      Abstract classes can override this to customize issubclass().

      This is invoked early on by abc.ABCMeta.__subclasscheck__().
      It should return True, False or NotImplemented.  If it returns
      NotImplemented, the normal algorithm is used.  Otherwise, it
      overrides the normal algorithm (and the outcome is cached).



   .. py:method:: clear()

      D.clear() -> None.  Remove all items from D.



   .. py:method:: copy()

      D.copy() -> a shallow copy of D



   .. py:method:: get()

      Return the value for key if key is in the dictionary, else default.



   .. py:method:: items()

      D.items() -> a set-like object providing a view on D's items



   .. py:method:: keys()

      D.keys() -> a set-like object providing a view on D's keys



   .. py:method:: pop()

      D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

      If the key is not found, return the default if given; otherwise,
      raise a KeyError.



   .. py:method:: popitem()

      Remove and return a (key, value) pair as a 2-tuple.

      Pairs are returned in LIFO (last-in, first-out) order.
      Raises KeyError if the dict is empty.



   .. py:method:: setdefault()

      Insert key with a value of default if key is not in the dictionary.

      Return the value for key if key is in the dictionary, else default.



   .. py:method:: update()

      D.update([E, ]**F) -> None.  Update D from dict/iterable E and F.
      If E is present and has a .keys() method, then does:  for k in E: D[k] = E[k]
      If E is present and lacks a .keys() method, then does:  for k, v in E: D[k] = v
      In either case, this is followed by: for k in F:  D[k] = F[k]



   .. py:method:: values()

      D.values() -> an object providing a view on D's values



.. py:class:: Entity

   Bases: :py:obj:`TypedDict`


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)


   .. py:attribute:: pretty_name
      :type:  str


   .. py:attribute:: cui
      :type:  str


   .. py:attribute:: type_ids
      :type:  list[str]


   .. py:attribute:: source_value
      :type:  str


   .. py:attribute:: detected_name
      :type:  str


   .. py:attribute:: acc
      :type:  float


   .. py:attribute:: context_similarity
      :type:  float


   .. py:attribute:: start
      :type:  int


   .. py:attribute:: end
      :type:  int


   .. py:attribute:: id
      :type:  int


   .. py:attribute:: meta_anns
      :type:  dict[str, MetaAnnotation]


   .. py:attribute:: context_left
      :type:  list[str]


   .. py:attribute:: context_center
      :type:  list[str]


   .. py:attribute:: context_right
      :type:  list[str]


   .. py:method:: __contains__()

      True if the dictionary has the specified key, else False.



   .. py:method:: __delattr__()

      Implement delattr(self, name).



   .. py:method:: __delitem__()

      Delete self[key].



   .. py:method:: __dir__()

      Default dir() implementation.



   .. py:method:: __eq__()

      Return self==value.



   .. py:method:: __format__()

      Default object formatter.



   .. py:method:: __ge__()

      Return self>=value.



   .. py:method:: __getattribute__()

      Return getattr(self, name).



   .. py:method:: __getitem__()

      x.__getitem__(y) <==> x[y]



   .. py:method:: __gt__()

      Return self>value.



   .. py:method:: __init__()

      Initialize self.  See help(type(self)) for accurate signature.



   .. py:method:: __ior__()

      Return self|=value.



   .. py:method:: __iter__()

      Implement iter(self).



   .. py:method:: __le__()

      Return self<=value.



   .. py:method:: __len__()

      Return len(self).



   .. py:method:: __lt__()

      Return self<value.



   .. py:method:: __ne__()

      Return self!=value.



   .. py:method:: __new__()

      Create and return a new object.  See help(type) for accurate signature.



   .. py:method:: __or__()

      Return self|value.



   .. py:method:: __reduce__()

      Helper for pickle.



   .. py:method:: __reduce_ex__()

      Helper for pickle.



   .. py:method:: __repr__()

      Return repr(self).



   .. py:method:: __reversed__()

      Return a reverse iterator over the dict keys.



   .. py:method:: __ror__()

      Return value|self.



   .. py:method:: __setattr__()

      Implement setattr(self, name, value).



   .. py:method:: __setitem__()

      Set self[key] to value.



   .. py:method:: __sizeof__()

      D.__sizeof__() -> size of D in memory, in bytes



   .. py:method:: __str__()

      Return str(self).



   .. py:method:: __subclasshook__()

      Abstract classes can override this to customize issubclass().

      This is invoked early on by abc.ABCMeta.__subclasscheck__().
      It should return True, False or NotImplemented.  If it returns
      NotImplemented, the normal algorithm is used.  Otherwise, it
      overrides the normal algorithm (and the outcome is cached).



   .. py:method:: clear()

      D.clear() -> None.  Remove all items from D.



   .. py:method:: copy()

      D.copy() -> a shallow copy of D



   .. py:method:: get()

      Return the value for key if key is in the dictionary, else default.



   .. py:method:: items()

      D.items() -> a set-like object providing a view on D's items



   .. py:method:: keys()

      D.keys() -> a set-like object providing a view on D's keys



   .. py:method:: pop()

      D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

      If the key is not found, return the default if given; otherwise,
      raise a KeyError.



   .. py:method:: popitem()

      Remove and return a (key, value) pair as a 2-tuple.

      Pairs are returned in LIFO (last-in, first-out) order.
      Raises KeyError if the dict is empty.



   .. py:method:: setdefault()

      Insert key with a value of default if key is not in the dictionary.

      Return the value for key if key is in the dictionary, else default.



   .. py:method:: update()

      D.update([E, ]**F) -> None.  Update D from dict/iterable E and F.
      If E is present and has a .keys() method, then does:  for k in E: D[k] = E[k]
      If E is present and lacks a .keys() method, then does:  for k, v in E: D[k] = v
      In either case, this is followed by: for k in F:  D[k] = F[k]



   .. py:method:: values()

      D.values() -> an object providing a view on D's values



.. py:class:: Entities

   Bases: :py:obj:`TypedDict`


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)


   .. py:attribute:: entities
      :type:  dict[int, Entity]


   .. py:attribute:: tokens
      :type:  list[str]


   .. py:attribute:: text
      :type:  Optional[str]


   .. py:method:: __contains__()

      True if the dictionary has the specified key, else False.



   .. py:method:: __delattr__()

      Implement delattr(self, name).



   .. py:method:: __delitem__()

      Delete self[key].



   .. py:method:: __dir__()

      Default dir() implementation.



   .. py:method:: __eq__()

      Return self==value.



   .. py:method:: __format__()

      Default object formatter.



   .. py:method:: __ge__()

      Return self>=value.



   .. py:method:: __getattribute__()

      Return getattr(self, name).



   .. py:method:: __getitem__()

      x.__getitem__(y) <==> x[y]



   .. py:method:: __gt__()

      Return self>value.



   .. py:method:: __init__()

      Initialize self.  See help(type(self)) for accurate signature.



   .. py:method:: __ior__()

      Return self|=value.



   .. py:method:: __iter__()

      Implement iter(self).



   .. py:method:: __le__()

      Return self<=value.



   .. py:method:: __len__()

      Return len(self).



   .. py:method:: __lt__()

      Return self<value.



   .. py:method:: __ne__()

      Return self!=value.



   .. py:method:: __new__()

      Create and return a new object.  See help(type) for accurate signature.



   .. py:method:: __or__()

      Return self|value.



   .. py:method:: __reduce__()

      Helper for pickle.



   .. py:method:: __reduce_ex__()

      Helper for pickle.



   .. py:method:: __repr__()

      Return repr(self).



   .. py:method:: __reversed__()

      Return a reverse iterator over the dict keys.



   .. py:method:: __ror__()

      Return value|self.



   .. py:method:: __setattr__()

      Implement setattr(self, name, value).



   .. py:method:: __setitem__()

      Set self[key] to value.



   .. py:method:: __sizeof__()

      D.__sizeof__() -> size of D in memory, in bytes



   .. py:method:: __str__()

      Return str(self).



   .. py:method:: __subclasshook__()

      Abstract classes can override this to customize issubclass().

      This is invoked early on by abc.ABCMeta.__subclasscheck__().
      It should return True, False or NotImplemented.  If it returns
      NotImplemented, the normal algorithm is used.  Otherwise, it
      overrides the normal algorithm (and the outcome is cached).



   .. py:method:: clear()

      D.clear() -> None.  Remove all items from D.



   .. py:method:: copy()

      D.copy() -> a shallow copy of D



   .. py:method:: get()

      Return the value for key if key is in the dictionary, else default.



   .. py:method:: items()

      D.items() -> a set-like object providing a view on D's items



   .. py:method:: keys()

      D.keys() -> a set-like object providing a view on D's keys



   .. py:method:: pop()

      D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

      If the key is not found, return the default if given; otherwise,
      raise a KeyError.



   .. py:method:: popitem()

      Remove and return a (key, value) pair as a 2-tuple.

      Pairs are returned in LIFO (last-in, first-out) order.
      Raises KeyError if the dict is empty.



   .. py:method:: setdefault()

      Insert key with a value of default if key is not in the dictionary.

      Return the value for key if key is in the dictionary, else default.



   .. py:method:: update()

      D.update([E, ]**F) -> None.  Update D from dict/iterable E and F.
      If E is present and has a .keys() method, then does:  for k in E: D[k] = E[k]
      If E is present and lacks a .keys() method, then does:  for k, v in E: D[k] = v
      In either case, this is followed by: for k in F:  D[k] = F[k]



   .. py:method:: values()

      D.values() -> an object providing a view on D's values



.. py:class:: OnlyCUIEntities

   Bases: :py:obj:`TypedDict`


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)


   .. py:attribute:: entities
      :type:  dict[int, str]


   .. py:attribute:: tokens
      :type:  list[str]


   .. py:attribute:: text
      :type:  Optional[str]


   .. py:method:: __contains__()

      True if the dictionary has the specified key, else False.



   .. py:method:: __delattr__()

      Implement delattr(self, name).



   .. py:method:: __delitem__()

      Delete self[key].



   .. py:method:: __dir__()

      Default dir() implementation.



   .. py:method:: __eq__()

      Return self==value.



   .. py:method:: __format__()

      Default object formatter.



   .. py:method:: __ge__()

      Return self>=value.



   .. py:method:: __getattribute__()

      Return getattr(self, name).



   .. py:method:: __getitem__()

      x.__getitem__(y) <==> x[y]



   .. py:method:: __gt__()

      Return self>value.



   .. py:method:: __init__()

      Initialize self.  See help(type(self)) for accurate signature.



   .. py:method:: __ior__()

      Return self|=value.



   .. py:method:: __iter__()

      Implement iter(self).



   .. py:method:: __le__()

      Return self<=value.



   .. py:method:: __len__()

      Return len(self).



   .. py:method:: __lt__()

      Return self<value.



   .. py:method:: __ne__()

      Return self!=value.



   .. py:method:: __new__()

      Create and return a new object.  See help(type) for accurate signature.



   .. py:method:: __or__()

      Return self|value.



   .. py:method:: __reduce__()

      Helper for pickle.



   .. py:method:: __reduce_ex__()

      Helper for pickle.



   .. py:method:: __repr__()

      Return repr(self).



   .. py:method:: __reversed__()

      Return a reverse iterator over the dict keys.



   .. py:method:: __ror__()

      Return value|self.



   .. py:method:: __setattr__()

      Implement setattr(self, name, value).



   .. py:method:: __setitem__()

      Set self[key] to value.



   .. py:method:: __sizeof__()

      D.__sizeof__() -> size of D in memory, in bytes



   .. py:method:: __str__()

      Return str(self).



   .. py:method:: __subclasshook__()

      Abstract classes can override this to customize issubclass().

      This is invoked early on by abc.ABCMeta.__subclasscheck__().
      It should return True, False or NotImplemented.  If it returns
      NotImplemented, the normal algorithm is used.  Otherwise, it
      overrides the normal algorithm (and the outcome is cached).



   .. py:method:: clear()

      D.clear() -> None.  Remove all items from D.



   .. py:method:: copy()

      D.copy() -> a shallow copy of D



   .. py:method:: get()

      Return the value for key if key is in the dictionary, else default.



   .. py:method:: items()

      D.items() -> a set-like object providing a view on D's items



   .. py:method:: keys()

      D.keys() -> a set-like object providing a view on D's keys



   .. py:method:: pop()

      D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

      If the key is not found, return the default if given; otherwise,
      raise a KeyError.



   .. py:method:: popitem()

      Remove and return a (key, value) pair as a 2-tuple.

      Pairs are returned in LIFO (last-in, first-out) order.
      Raises KeyError if the dict is empty.



   .. py:method:: setdefault()

      Insert key with a value of default if key is not in the dictionary.

      Return the value for key if key is in the dictionary, else default.



   .. py:method:: update()

      D.update([E, ]**F) -> None.  Update D from dict/iterable E and F.
      If E is present and has a .keys() method, then does:  for k in E: D[k] = E[k]
      If E is present and lacks a .keys() method, then does:  for k, v in E: D[k] = v
      In either case, this is followed by: for k in F:  D[k] = F[k]



   .. py:method:: values()

      D.values() -> an object providing a view on D's values