added comments to show options (#85)

* added comments to show options

* fixing travis error

* fixing travis errors

* travis error file

Author: krczeck

examples/categories.py

@@ -15,10 +15,19 @@
 
 def run(key, alt_url='https://api.rosette.com/rest/v1/'):
     """ Run the example """
-    categories_url_data = "https://onlocationvacations.com/2015/03/05/the-new-ghostbusters-movie-begins-filming-in-boston-in-june/"
+    categories_url_data = "https://onlocationvacations.com/2018/02/06/downton-abbey-exhibition-extended-april-2-nyc/"
     url = categories_url_data
     # Create an API instance
     api = API(user_key=key, service_url=alt_url)
+
+    # Set selected API options
+    # For more information on the functionality of these
+    # and other available options, see Rosette Features & Functions
+    # https://developer.rosette.com/features-and-functions#categorization
+
+    # api.set_option('singleLabel', 'true')
+    # api.set_option('scoreThreshold',- 0.20)
+
     params = DocumentParameters()
 
     # Use a URL to input data instead of a string

examples/entities.py

@@ -15,6 +15,15 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
     """ Run the example """
     # Create an API instance
     api = API(user_key=key, service_url=alt_url)
+
+    # Set selected API options.
+    # For more information on the functionality of these
+    # and other available options, see Rosette Features & Functions
+    # https://developer.rosette.com/features-and-functions#entity-extraction-and-linking
+
+    # api.set_option('calculateSalience','true')
+    # api.set_option('linkEntities','false')
+
     entities_text_data = "The Securities and Exchange Commission today announced the leadership of the agency’s trial unit.  Bridget Fitzpatrick has been named Chief Litigation Counsel of the SEC and David Gottesman will continue to serve as the agency’s Deputy Chief Litigation Counsel. Since December 2016, Ms. Fitzpatrick and Mr. Gottesman have served as Co-Acting Chief Litigation Counsel.  In that role, they were jointly responsible for supervising the trial unit at the agency’s Washington D.C. headquarters as well as coordinating with litigators in the SEC’s 11 regional offices around the country."
     params = DocumentParameters()
     params["content"] = entities_text_data

examples/morphology_complete.py

@@ -16,6 +16,13 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
     # Create an API instance
     api = API(user_key=key, service_url=alt_url)
 
+    # Set selected API options.
+    # For more information on the functionality of these
+    # and other available options, see Rosette Features & Functions
+    # https://developer.rosette.com/features-and-functions#morphological-analysis-introduction
+
+    # api.set_option('modelType','perceptron') #Valid for Chinese and Japanese only
+
     morphology_complete_data = "The quick brown fox jumped over the lazy dog. 👍🏾 Yes he did. B)"
     params = DocumentParameters()
     params["content"] = morphology_complete_data

examples/morphology_compound-components.py

@@ -16,6 +16,13 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
     # Create an API instance
     api = API(user_key=key, service_url=alt_url)
 
+    # Set selected API options.
+    # For more information on the functionality of these
+    # and other available options, see Rosette Features & Functions
+    # https://developer.rosette.com/features-and-functions#morphological-analysis-introduction
+
+    # api.set_option('modelType','perceptron') #Valid for Chinese and Japanese only
+
     morphology_compound_components_data = "Rechtsschutzversicherungsgesellschaften"
     params = DocumentParameters()
     params["content"] = morphology_compound_components_data

examples/morphology_han-readings.py

@@ -15,6 +15,12 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
     """ Run the example """
     # Create an API instance
     api = API(user_key=key, service_url=alt_url)
+    # Set selected API options.
+    # For more information on the functionality of these
+    # and other available options, see Rosette Features & Functions
+    # https://developer.rosette.com/features-and-functions#morphological-analysis-introduction
+
+    # api.set_option('modelType','perceptron') #Valid for Chinese and Japanese only
 
     morphology_han_readings_data = "北京大学生物系主任办公室内部会议"
     params = DocumentParameters()

examples/morphology_lemmas.py

@@ -16,6 +16,13 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
     # Create an API instance
     api = API(user_key=key, service_url=alt_url)
 
+    # Set selected API options.
+    # For more information on the functionality of these
+    # and other available options, see Rosette Features & Functions
+    # https://developer.rosette.com/features-and-functions#morphological-analysis-introduction
+
+    # api.set_option('modelType','perceptron') #Valid for Chinese and Japanese only
+
     morphology_lemmas_data = "The fact is that the geese just went back to get a rest and I'm not banking on their return soon"
     params = DocumentParameters()
     params["content"] = morphology_lemmas_data

examples/morphology_parts-of-speech.py

@@ -16,6 +16,13 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
     # Create an API instance
     api = API(user_key=key, service_url=alt_url)
 
+    # Set selected API options.
+    # For more information on the functionality of these
+    # and other available options, see Rosette Features & Functions
+    # https://developer.rosette.com/features-and-functions#morphological-analysis-introduction
+
+    # api.set_option('modelType','perceptron') # Valid for Chinese and Japanese only
+
     morphology_parts_of_speech_data = "The fact is that the geese just went back to get a rest and I'm not banking on their return soon"
     params = DocumentParameters()
     params["content"] = morphology_parts_of_speech_data

examples/sentiment.py

@@ -24,6 +24,12 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
 
     # Create an API instance
     api = API(user_key=key, service_url=alt_url)
+    # Set selected API options.
+    # For more information on the functionality of these
+    # and other available options, see Rosette Features & Functions
+    # https://developer.rosette.com/features-and-functions#sentiment-analysis
+
+    # api.set_option('modelType','dnn') #Valid for English only
 
     params = DocumentParameters()
     params["language"] = "eng"

examples/tokens.py

@@ -16,6 +16,13 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
     # Create an API instance
     api = API(user_key=key, service_url=alt_url)
 
+    # Set selected API options.
+    # For more information on the functionality of these
+    # and other available options, see Rosette Features & Functions
+    # https://developer.rosette.com/features-and-functions#tokenization
+
+    # api.set_option('modelType','perceptron') #Valid for Chinese and Japanese only
+
     tokens_data = "北京大学生物系主任办公室内部会议"
     params = DocumentParameters()
     params["content"] = tokens_data

examples/topics.py

@@ -16,6 +16,14 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
     # Create an API instance
     api = API(user_key=key, service_url=alt_url)
 
+    # Set selected API options.
+    # For more information on the functionality of these
+    # and other available options, see Rosette Features & Functions
+    # https://developer.rosette.com/features-and-functions#topic-extraction
+
+    # api.set_option('keyphraseSalienceThreshold','.5')
+    # api.set_option('conceptSalienceThreshold','.1')
+
     topics_data = "Lily Collins is in talks to join Nicholas Hoult in Chernin Entertainment and Fox Searchlight's J.R.R. Tolkien biopic Tolkien. Anthony Boyle, known for playing Scorpius Malfoy in the British play Harry Potter and the Cursed Child, also has signed on for the film centered on the famed author. In Tolkien, Hoult will play the author of the Hobbit and Lord of the Rings book series that were later adapted into two Hollywood trilogies from Peter Jackson. Dome Karukoski is directing the project."
     params = DocumentParameters()
     params["content"] = topics_data