ADD: NER

indicoio/text/ner.py

@@ -0,0 +1,30 @@
+from indicoio.utils.api import api_handler
+import indicoio.config as config
+
+def named_entities(text, cloud=None, batch=False, api_key=None, **kwargs):
+    """
+    Given input text, returns named entities (proper nouns) found in the text
+
+    Example usage:
+
+    .. code-block:: python
+
+       >>> text = "London Underground's boss Mike Brown warned that the strike ..."
+       >>> entities = indicoio.named_entities(text)
+       {u'London Underground': {u'categories': {u'location': 0.583755654607989,
+          u'organization': 0.07460487821791033,
+          u'person': 0.07304850776658672,
+          u'unknown': 0.2685909594075139},
+         u'confidence': 0.846188063604044},
+        u'Mike Brown': {u'categories': {u'location': 0.025813884950623898,
+          u'organization': 0.06661470013014613,
+          u'person': 0.08723850624560824,
+          u'unknown': 0.8203329086736217},
+         u'confidence': 0.8951793008234012}}
+
+    :param text: The text to be analyzed.
+    :type text: str or unicode
+    :rtype: Dictionary of language probability pairs
+    """
+    url_params = {"batch": batch, "api_key": api_key}
+    return api_handler(text, cloud=cloud, api="namedentities", url_params=url_params, **kwargs)