Added name_translation and name_similarity functions. Changed examples accordingly.

Author: fhasanaj28

examples/matched-name.py examples/name_similarity.pyexamples/matched-name.py renamed to examples/name_similarity.py

@@ -20,7 +20,7 @@ def run(key, altUrl='https://api.rosette.com/rest/v1/'):
     params = NameMatchingParameters()
     params["name1"] = {"text": matched_name_data1, "language": "eng", "entityType": "PERSON"}
     params["name2"] = {"text": matched_name_data2, "entityType": "PERSON"}
-    return api.matched_name(params)
+    return api.name_similarity(params)
 
 
 parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter, description='Calls the ' + os.path.splitext(os.path.basename(__file__))[0] + ' endpoint')

examples/translated-name.py examples/name_translation.pyexamples/translated-name.py renamed to examples/name_translation.py

@@ -20,7 +20,9 @@ def run(key, altUrl='https://api.rosette.com/rest/v1/'):
     params["name"] = translated_name_data
     params["entityType"] = "PERSON"
     params["targetLanguage"] = "eng"
-    return api.translated_name(params)
+    params["targetScript"] = "Latn"
+    params["targetScheme"] = "IC"
+    return api.name_translation(params)
 
 
 parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter, description='Calls the ' + os.path.splitext(os.path.basename(__file__))[0] + ' endpoint')

rosette/api.py

@@ -400,7 +400,7 @@ def __init__(self):
 
 
 class NameTranslationParameters(_DocumentParamSetBase):
-    """Parameter object for C{translated_name} endpoint.
+    """Parameter object for C{name-translation} endpoint.
     The following values may be set by the indexing (i.e.,C{ parms["name"]}) operator.  The values are all
     strings (when not C{None}).
     All are optional except C{name} and C{targetLanguage}.  Scripts are in
@@ -436,7 +436,7 @@ def validate(self):
 
 
 class NameMatchingParameters(_DocumentParamSetBase):
-    """Parameter object for C{matched_name} endpoint.
+    """Parameter object for C{name-similarity} endpoint.
     All are required.
 
     C{name1} The name to be matched, a C{name} object.
@@ -567,9 +567,9 @@ def call(self, parameters):
         """Invokes the endpoint to which this L{EndpointCaller} is bound.
         Passes data and metadata specified by C{parameters} to the server
         endpoint to which this L{EndpointCaller} object is bound.  For all
-        endpoints except C{translated_name} and C{matched_name}, it must be a L{DocumentParameters}
-        object or a string; for C{translated_name}, it must be an L{NameTranslationParameters} object;
-        for C{matched_name}, it must be an L{NameMatchingParameters} object. For relationships,
+        endpoints except C{name-translation} and C{name-similarity}, it must be a L{DocumentParameters}
+        object or a string; for C{name-translation}, it must be an L{NameTranslationParameters} object;
+        for C{name-similarity}, it must be an L{NameMatchingParameters} object. For relationships,
         it may be an L(DocumentParameters) or an L(RelationshipsParameters).
 
         In all cases, the result is returned as a python dictionary
@@ -579,12 +579,12 @@ def call(self, parameters):
         @param parameters: An object specifying the data,
         and possible metadata, to be processed by the endpoint.  See the
         details for those object types.
-        @type parameters: For C{translated_name}, L{NameTranslationParameters}, otherwise L{DocumentParameters} or L{str}
+        @type parameters: For C{name-translation}, L{NameTranslationParameters}, otherwise L{DocumentParameters} or L{str}
         @return: A python dictionary expressing the result of the invocation.
         """
 
         if not isinstance(parameters, _DocumentParamSetBase):
-            if self.suburl != "matched-name" and self.suburl != "translated-name":
+            if self.suburl != "name-similarity" and self.suburl != "name-translation":
                 text = parameters
                 parameters = DocumentParameters()
                 parameters['content'] = text
@@ -766,21 +766,40 @@ def relationships(self, parameters):
         @return: A python dictionary containing the results of relationship extraction."""
         return EndpointCaller(self, "relationships").call(parameters)
 
-    def translated_name(self, parameters):
+    def name_translation(self, parameters):
         """
         Create an L{EndpointCaller} to perform name analysis and translation
         upon the name to which it is applied and call it.
         @param parameters: An object specifying the data,
         and possible metadata, to be processed by the name translator.
         @type parameters: L{NameTranslationParameters}
         @return: A python dictionary containing the results of name translation."""
-        return EndpointCaller(self, "translated-name").call(parameters)
+        return EndpointCaller(self, "name-translation").call(parameters)
 
-    def matched_name(self, parameters):
+    def translated_name(self, parameters):
+        """ deprecated
+        Call name_translation to perform name analysis and translation
+        upon the name to which it is applied.
+        @param parameters: An object specifying the data,
+        and possible metadata, to be processed by the name translator.
+        @type parameters: L{NameTranslationParameters}
+        @return: A python dictionary containing the results of name translation."""
+        return self.name_translation(parameters)
+
+    def name_similarity(self, parameters):
         """
         Create an L{EndpointCaller} to perform name matching and call it.
         @param parameters: An object specifying the data,
         and possible metadata, to be processed by the name matcher.
         @type parameters: L{NameMatchingParameters}
         @return: A python dictionary containing the results of name matching."""
-        return EndpointCaller(self, "matched-name").call(parameters)
+        return EndpointCaller(self, "name-similarity").call(parameters)
+
+    def matched_name(self, parameters):
+        """ deprecated
+        Call name_similarity to perform name matching.
+        @param parameters: An object specifying the data,
+        and possible metadata, to be processed by the name matcher.
+        @type parameters: L{NameMatchingParameters}
+        @return: A python dictionary containing the results of name matching."""
+        return self.name_similarity(parameters)