Merge pull request #56 from kbailey-basistech/RCB-473_Syntax-Dependencies

Rcb 473 syntax dependencies

Author: cp2boston

examples/syntax_dependencies.py

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+
+"""
+Example code to call Rosette API to get the syntactic dependencies of a document (at a given URL).
+"""
+
+import argparse
+import json
+import os
+
+from rosette.api import API, DocumentParameters
+
+
+def run(key, altUrl='https://api.rosette.com/rest/v1/'):
+    syntax_dependencies_data = "Sony Pictures is planning to shoot a good portion of the new \"Ghostbusters\" in Boston as well."
+    params = DocumentParameters()
+    params["content"] = syntax_dependencies_data
+    params["genre"] = "social-media"
+    # Create an API instance
+    api = API(user_key=key, service_url=altUrl)
+    return api.syntax_dependencies(params)
+
+
+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

@@ -841,3 +841,11 @@ def text_embedding(self, parameters):
         @type parameters: L{DocumentParameters} or L{str}
         @return: A python dictionary containing the results of text embedding."""
         return EndpointCaller(self, "text-embedding").call(parameters)
+
+    def syntax_dependencies(self, parameters):
+        """
+        Create an L{EndpointCaller} to identify the syntactic dependencies in the texts
+        to which it is applied and call it.
+        @type parameters: L{DocumentParameters} or L{str}
+        @return: A python dictionary containing the results of syntactic dependencies identification"""
+        return EndpointCaller(self, "syntax/dependencies").call(parameters)

tests/test_rosette_api.py

@@ -590,3 +590,14 @@ def test_the_text_embedded_endpoint(api, json_response, doc_params):
     assert result["name"] == "Rosette API"
     httpretty.disable()
     httpretty.reset()
+
+
+def test_the_syntax_dependencies_endpoint(api, json_response, doc_params):
+    httpretty.enable()
+    httpretty.register_uri(httpretty.POST, "https://api.rosette.com/rest/v1/syntax/dependencies",
+                           body=json_response, status=200, content_type="application/json")
+
+    result = api.syntax_dependencies(doc_params)
+    assert result["name"] == "Rosette API"
+    httpretty.disable()
+    httpretty.reset()