entities/linked deprecation

Author: Hannah

examples/entities_linked.py

@@ -0,0 +1,32 @@
+# -*- 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"
+    return api.entities(params, True)  # entity linking is turned on
+
+
+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

@@ -752,16 +752,24 @@ 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_explicit("the /entities/linked endpoint is replaced by /entities.", DeprecationWarning)
+            return EndpointCaller(self, "entities/linked").call(parameters)
+        else:
+            return EndpointCaller(self, "entities").call(parameters)
+
 
     def categories(self, parameters):
         """