Merge pull request #62 from rosette-api/RCB-508_name-dedup-rct

Rcb 508 name dedup rct

Author: seth-mg

.gitignore

@@ -72,3 +72,6 @@ docs/_build/
 
 # PyBuilder
 target/
+
+settings.json
+*.orig

examples/README.md

@@ -12,30 +12,32 @@ You can now run your desired _endpoint_.py file to see it in action.
 For example, run `python/examples/categories.py` if you want to see the categories
 functionality demonstrated.
 
-All files require you to input your Rosette API User Key after --key to run.  
-For example: `python ping.py --key 1234567890`  
-All also allow you to input your own service URL if desired.  
-For example: `python ping.py --key 1234567890 --service_url http://www.myurl.com`    
+All files require you to input your Rosette API User Key after --key to run.
+For example: `python ping.py --key 1234567890`
+All also allow you to input your own service URL if desired.
+For example: `python ping.py --key 1234567890 --service_url http://www.myurl.com`
 Some (specified below) allow an additional input of either a file (.html or .txt) or a URL with `--file` or `--url`
 
 Each example, when run, prints its output to the console.
 
-| File Name                     | What it does                                          | 
-| -------------                 |-------------                                        | 
-| categories.py                    | Gets the category of a document at a URL              | 
-| entities.py                      | Gets the entities from a piece of text                | 
-| info.py                          | Gets information about Rosette API                    | 
-| language.py                      | Gets the language of a piece of text                  | 
-| matched-name.py                  | Gets the similarity score of two names                | 
-| morphology_complete.py               | Gets the complete morphological analysis of a piece of text| 
-| morphology_compound-components.py    | Gets the de-compounded words from a piece of text     | 
-| morphology_han-readings.py           | Gets the Chinese words from a piece of text           | 
-| morphology_lemmas.py                 | Gets the lemmas of words from a piece of text         | 
-| morphology_parts-of-speech.py        | Gets the part-of-speech tags for words in a piece of text | 
-| ping.py                          | Pings the Rosette API to check for reachability       | 
-| relationships.py                      | Gets the relationships between entities from a piece of text                | 
+| File Name                     | What it does                                          |
+| -------------                 |-------------                                        |
+| categories.py                    | Gets the category of a document at a URL              |
+| entities.py                      | Gets the entities from a piece of text                |
+| info.py                          | Gets information about Rosette API                    |
+| language.py                      | Gets the language of a piece of text                  |
+| matched-name.py                  | Gets the similarity score of two names                |
+| morphology_complete.py               | Gets the complete morphological analysis of a piece of text|
+| morphology_compound-components.py    | Gets the de-compounded words from a piece of text     |
+| morphology_han-readings.py           | Gets the Chinese words from a piece of text           |
+| morphology_lemmas.py                 | Gets the lemmas of words from a piece of text         |
+| morphology_parts-of-speech.py        | Gets the part-of-speech tags for words in a piece of text |
+| name_deduplication.py                | De-duplicates a list of names |
+| ping.py                          | Pings the Rosette API to check for reachability       |
+| relationships.py                      | Gets the relationships between entities from a piece of text                |
 | sentences.py                     | Gets the sentences from a piece of text               |
-| sentiment.py                     | Gets the sentiment of a local file                    | 
-| tokens.py                        | Gets the tokens (words) from a piece of text          | 
+| sentiment.py                     | Gets the sentiment of a local file                    |
+| tokens.py                        | Gets the tokens (words) from a piece of text          |
 | translated-name.py               | Translates a name from one language to another        |
+| transliteration.py               | Transliterates the given text |
 

examples/language.py

@@ -18,7 +18,7 @@ def run(key, altUrl='https://api.rosette.com/rest/v1/'):
     language_data = "Por favor Señorita, says the man."
     params = DocumentParameters()
     params["content"] = language_data
-    api.setCustomHeaders("X-RosetteAPI-App", "python-app")
+    api.setcustom_headers("X-RosetteAPI-App", "python-app")
     try:
         return api.language(params)
     except RosetteException as e:

examples/morphology_compound-components.py

@@ -8,7 +8,7 @@
 import json
 import os
 
-from rosette.api import API, DocumentParameters, MorphologyOutput, RosetteException
+from rosette.api import API, DocumentParameters, RosetteException
 
 
 def run(key, altUrl='https://api.rosette.com/rest/v1/'):
@@ -19,7 +19,7 @@ def run(key, altUrl='https://api.rosette.com/rest/v1/'):
     params = DocumentParameters()
     params["content"] = morphology_compound_components_data
     try:
-        return api.morphology(params, MorphologyOutput.COMPOUND_COMPONENTS)
+        return api.morphology(params, api.morphology_output['COMPOUND_COMPONENTS'])
     except RosetteException as e:
         print(e)
 

examples/morphology_han-readings.py

@@ -8,7 +8,7 @@
 import json
 import os
 
-from rosette.api import API, DocumentParameters, MorphologyOutput, RosetteException
+from rosette.api import API, DocumentParameters, RosetteException
 
 
 def run(key, altUrl='https://api.rosette.com/rest/v1/'):
@@ -19,7 +19,7 @@ def run(key, altUrl='https://api.rosette.com/rest/v1/'):
     params = DocumentParameters()
     params["content"] = morphology_han_readings_data
     try:
-        return api.morphology(params, MorphologyOutput.HAN_READINGS)
+        return api.morphology(params, api.morphology_output['HAN_READINGS'])
     except RosetteException as e:
         print(e)
 

examples/morphology_lemmas.py

@@ -8,7 +8,7 @@
 import json
 import os
 
-from rosette.api import API, DocumentParameters, MorphologyOutput, RosetteException
+from rosette.api import API, DocumentParameters, RosetteException
 
 
 def run(key, altUrl='https://api.rosette.com/rest/v1/'):
@@ -19,7 +19,7 @@ def run(key, altUrl='https://api.rosette.com/rest/v1/'):
     params = DocumentParameters()
     params["content"] = morphology_lemmas_data
     try:
-        return api.morphology(params, MorphologyOutput.LEMMAS)
+        return api.morphology(params, api.morphology_output['LEMMAS'])
     except RosetteException as e:
         print(e)
 

examples/morphology_parts-of-speech.py

@@ -8,7 +8,7 @@
 import json
 import os
 
-from rosette.api import API, DocumentParameters, MorphologyOutput, RosetteException
+from rosette.api import API, DocumentParameters, RosetteException
 
 
 def run(key, altUrl='https://api.rosette.com/rest/v1/'):
@@ -19,7 +19,7 @@ def run(key, altUrl='https://api.rosette.com/rest/v1/'):
     params = DocumentParameters()
     params["content"] = morphology_parts_of_speech_data
     try:
-        return api.morphology(params, MorphologyOutput.PARTS_OF_SPEECH)
+        return api.morphology(params, api.morphology_output['PARTS_OF_SPEECH'])
     except RosetteException as e:
         print(e)
 

examples/name_deduplication.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+
+"""
+Example code to call Rosette API to deduplicate a list of names.
+"""
+
+import argparse
+import json
+import os
+
+from rosette.api import API, NameDeduplicationParameters, RosetteException
+
+
+def run(key, altUrl='https://api.rosette.com/rest/v1/'):
+    # Create an API instance
+    api = API(user_key=key, service_url=altUrl)
+
+    dedup_list = ["John Smith", "Johnathon Smith", "Fred Jones"]
+    threshold = 0.75
+    params = NameDeduplicationParameters()
+    params["names"] = dedup_list
+    params["threshold"] = threshold
+    try:
+        return api.name_deduplication(params)
+    except RosetteException as e:
+        print(e)
+
+
+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"))

examples/relationships.py

@@ -17,7 +17,7 @@ def run(key, altUrl='https://api.rosette.com/rest/v1/'):
     relationships_text_data = "Bill Gates, Microsoft's former CEO, is a philanthropist."
     params = DocumentParameters()
     params["content"] = relationships_text_data
-    api.setOption('accuracyMode', 'PRECISION')
+    api.set_option('accuracyMode', 'PRECISION')
     try:
         return api.relationships(params)
     except RosetteException as e:

examples/transliteration.py

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+
+"""
+Example code to call Rosette API to transliterate a piece of text.
+"""
+
+import argparse
+import json
+import os
+
+from rosette.api import API, DocumentParameters, RosetteException
+
+
+def run(key, altUrl='https://api.rosette.com/rest/v1/'):
+    # Create an API instance
+    api = API(user_key=key, service_url=altUrl)
+
+    transliteration_data = "Some random text"
+    params = DocumentParameters()
+    params["content"] = transliteration_data
+
+    try:
+        return api.transliteration(params)
+    except RosetteException as e:
+        print(e)
+
+
+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"))