Merge pull request #53 from hannah-gaudet/RCB-444

RCB 444

Author: cp2boston

examples/entities_linked.py

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+
+"""
+Example code to call Rosette API to get linked (against Wikipedia) entities from a piece of text.
+"""
+
+import argparse
+import json
+import os
+
+from rosette.api import API, DocumentParameters
+
+
+def run(key, altUrl='https://api.rosette.com/rest/v1/'):
+    # Create an API instance
+    api = API(user_key=key, service_url=altUrl)
+
+    entities_linked_text_data = "Last month director Paul Feig announced the movie will have an all-star female cast including Kristen Wiig, Melissa McCarthy, Leslie Jones and Kate McKinnon."
+    params = DocumentParameters()
+    params["content"] = entities_linked_text_data
+    params["genre"] = "social-media"
+    # This syntax is deprecated, call api.entities(params)
+    return api.entities(params, True)
+
+
+parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter, description='Calls the ' + os.path.splitext(os.path.basename(__file__))[0] + ' endpoint')
+parser.add_argument('-k', '--key', help='Rosette API Key', required=True)
+parser.add_argument('-u', '--url', help="Alternative API URL", default='https://api.rosette.com/rest/v1/')
+
+if __name__ == '__main__':
+    args = parser.parse_args()
+    result = run(args.key, args.url)
+    print(json.dumps(result, indent=2, ensure_ascii=False, sort_keys=True).encode("utf8"))

rosette/api.py

@@ -27,6 +27,7 @@
 from socket import gaierror
 import requests
 import re
+import warnings
 
 _BINDING_VERSION = '1.1.1'
 _GZIP_BYTEARRAY = bytearray([0x1F, 0x8b, 0x08])
@@ -752,16 +753,23 @@ def morphology(self, parameters, facet=MorphologyOutput.COMPLETE):
         @return: A python dictionary containing the results of morphological analysis."""
         return EndpointCaller(self, "morphology/" + facet).call(parameters)
 
-    def entities(self, parameters):
+    def entities(self, parameters, resolve_entities=False):
         """
         Create an L{EndpointCaller}  to identify named entities found in the texts
         to which it is applied and call it. Linked entity information is optional, and
         its need must be specified at the time the operator is created.
         @param parameters: An object specifying the data,
         and possible metadata, to be processed by the entity identifier.
         @type parameters: L{DocumentParameters} or L{str}
+        @param resolve_entities: Specifies whether or not linked entity information will
+        be wanted.
+        @type resolve_entities: Boolean
         @return: A python dictionary containing the results of entity extraction."""
-        return EndpointCaller(self, "entities").call(parameters)
+        if resolve_entities:
+            warnings.warn("entities(params,resolve_entities) is deprecated and replaced by entities(params).", DeprecationWarning)
+            return EndpointCaller(self, "entities/linked").call(parameters)
+        else:
+            return EndpointCaller(self, "entities").call(parameters)
 
     def categories(self, parameters):
         """

tests/test_rosette_api.py

@@ -307,6 +307,21 @@ def test_the_entities_endpoint(api, json_response, doc_params):
     httpretty.disable()
     httpretty.reset()
 
+# Test the entities/linked endpoint
+
+
+def test_the_entities_linked_endpoint(api, json_response, doc_params):
+    httpretty.enable()
+    httpretty.register_uri(httpretty.POST, "https://api.rosette.com/rest/v1/info",
+                           body=json_response, status=200, content_type="application/json")
+    httpretty.register_uri(httpretty.POST, "https://api.rosette.com/rest/v1/entities/linked",
+                           body=json_response, status=200, content_type="application/json")
+
+    result = api.entities(doc_params, True)
+    assert result["name"] == "Rosette API"
+    httpretty.disable()
+    httpretty.reset()
+
 # Test the categories endpoint