WS-3314: update examples

Author: Adam Soos

examples/README.md

@@ -1,18 +1,18 @@
 ## Endpoint Examples
 
-Each example file demonstrates one of the capabilities of the Rosette Platform.
+Each example file demonstrates one of the capabilities of the Babel Street Analytics Platform.
 
 Here are some methods for running the examples.  Each example will also accept an optional `--url` parameter for
 overriding the default URL.
 
-A note on prerequisites.  Rosette API only supports TLS 1.2 so ensure your toolchain also supports it.
+A note on prerequisites.  Analytics API only supports TLS 1.2 so ensure your toolchain also supports it.
 
 #### Virtualenv/Latest Release
 ```
 git clone git@github.com:rosette-api/python.git
 cd python/examples
-virtualenv rosette_venv
-source rosette_venv/bin/activate
+virtualenv analytics_venv
+source analytics_venv/bin/activate
 pip install rosette_api
 python ping.py -k $API_KEY
 ```
@@ -21,8 +21,8 @@ python ping.py -k $API_KEY
 ```
 git clone git@github.com:rosette-api/python.git
 cd python
-virtualenv rosette_venv
-source rosette_venv/bin/activate
+virtualenv analytics_venv
+source analytics_venv/bin/activate
 python setup.py install
 cd examples
 python ping.py -k $API_KEY

examples/address_similarity.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Example code to call Rosette API to get match score (similarity) of two addresses.
+Example code to call Analytics API to get match score (similarity) of two addresses.
 """
 
 import argparse
@@ -10,7 +10,7 @@
 from rosette.api import API, AddressSimilarityParameters, RosetteException
 
 
-def run(key, alt_url='https://api.rosette.com/rest/v1/'):
+def run(key, alt_url='https://analytics.babelstreet.com/rest/v1/'):
     """ Run the example """
     # Create an API instance
     api = API(user_key=key, service_url=alt_url)
@@ -29,9 +29,9 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
 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('-k', '--key', help='Analytics API Key', required=True)
 PARSER.add_argument('-u', '--url', help="Alternative API URL",
-                    default='https://api.rosette.com/rest/v1/')
+                    default='https://analytics.babelstreet.com/rest/v1/')
 
 if __name__ == '__main__':
     ARGS = PARSER.parse_args()

examples/categories.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 """
-Example code to call Rosette API to get the category of a document (at a given URL).
+Example code to call Analytics API to get the category of a document (at a given URL).
 """
 
 import argparse
@@ -12,16 +12,16 @@
 from rosette.api import API, DocumentParameters, RosetteException
 
 
-def run(key, alt_url='https://api.rosette.com/rest/v1/'):
+def run(key, alt_url='https://analytics.babelstreet.com/rest/v1/'):
     """ Run the example """
     categories_text_data = "If you are a fan of the British television series Downton Abbey and you are planning to be in New York anytime before April 2nd, there is a perfect stop for you while in town."
     # 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
+    # and other available options, see Analytics Features & Functions
+    # https://developer.babelstreet.com/features-and-functions#categorization
 
     # api.set_option('singleLabel', 'true')
     # api.set_option('scoreThreshold',- 0.20)
@@ -38,9 +38,9 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
 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('-k', '--key', help='Analytics API Key', required=True)
 PARSER.add_argument('-u', '--url', help="Alternative API URL",
-                    default='https://api.rosette.com/rest/v1/')
+                    default='https://analytics.babelstreet.com/rest/v1/')
 
 if __name__ == '__main__':
     ARGS = PARSER.parse_args()

examples/entities.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Example code to call Rosette API to get entities from a piece of text.
+Example code to call Analytics API to get entities from a piece of text.
 """
 
 import argparse
@@ -10,15 +10,15 @@
 from rosette.api import API, DocumentParameters, RosetteException
 
 
-def run(key, alt_url='https://api.rosette.com/rest/v1/'):
+def run(key, alt_url='https://analytics.babelstreet.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
+    # and other available options, see Analytics Features & Functions
+    # https://developer.babelstreet.com/features-and-functions#entity-extraction-and-linking
 
     # api.set_option('calculateSalience','true')
     # api.set_option('linkEntities','false')
@@ -36,9 +36,9 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
 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('-k', '--key', help='Analytics API Key', required=True)
 PARSER.add_argument('-u', '--url', help="Alternative API URL",
-                    default='https://api.rosette.com/rest/v1/')
+                    default='https://analytics.babelstreet.com/rest/v1/')
 
 if __name__ == '__main__':
     ARGS = PARSER.parse_args()

examples/events.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Example code to call Rosette API to get events from a piece of text.
+Example code to call Analytics API to get events from a piece of text.
 """
 
 import argparse
@@ -10,7 +10,7 @@
 from rosette.api import API, DocumentParameters, RosetteException
 
 
-def run(key, alt_url='https://api.rosette.com/rest/v1/'):
+def run(key, alt_url='https://analytics.babelstreet.com/rest/v1/'):
     """ Run the example """
     # Create an API instance
     api = API(user_key=key, service_url=alt_url)
@@ -27,9 +27,9 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
 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('-k', '--key', help='Analytics API Key', required=True)
 PARSER.add_argument('-u', '--url', help="Alternative API URL",
-                    default='https://api.rosette.com/rest/v1/')
+                    default='https://analytics.babelstreet.com/rest/v1/')
 
 if __name__ == '__main__':
     ARGS = PARSER.parse_args()

examples/events_negation.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Example code to call Rosette API to get events, based on a set negation option, from a piece of text.
+Example code to call Analytics API to get events, based on a set negation option, from a piece of text.
 """
 
 import argparse
@@ -10,7 +10,7 @@
 from rosette.api import API, DocumentParameters, RosetteException
 
 
-def run(key, alt_url='https://api.rosette.com/rest/v1/'):
+def run(key, alt_url='https://analytics.babelstreet.com/rest/v1/'):
     """ Run the example """
     # Create an API instance
     api = API(user_key=key, service_url=alt_url)
@@ -31,9 +31,9 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
 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('-k', '--key', help='Analytics API Key', required=True)
 PARSER.add_argument('-u', '--url', help="Alternative API URL",
-                    default='https://api.rosette.com/rest/v1/')
+                    default='https://analytics.babelstreet.com/rest/v1/')
 
 if __name__ == '__main__':
     ARGS = PARSER.parse_args()

examples/info.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Example code to call Rosette API to get information such as version and build
+Example code to call Analytics API to get information such as version and build
 """
 
 import argparse
@@ -10,7 +10,7 @@
 from rosette.api import API, RosetteException
 
 
-def run(key, alt_url='https://api.rosette.com/rest/v1/'):
+def run(key, alt_url='https://analytics.babelstreet.com/rest/v1/'):
     """ Run the example """
     # Create an API instance
     api = API(user_key=key, service_url=alt_url)
@@ -24,9 +24,9 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
 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('-k', '--key', help='Analytics API Key', required=True)
 PARSER.add_argument('-u', '--url', help="Alternative API URL",
-                    default='https://api.rosette.com/rest/v1/')
+                    default='https://analytics.babelstreet.com/rest/v1/')
 
 if __name__ == '__main__':
     ARGS = PARSER.parse_args()

examples/language.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Example code to call Rosette API to determine the language of a piece of text.
+Example code to call Analytics API to determine the language of a piece of text.
 """
 
 import argparse
@@ -10,7 +10,7 @@
 from rosette.api import API, DocumentParameters, RosetteException
 
 
-def run(key, alt_url='https://api.rosette.com/rest/v1/'):
+def run(key, alt_url='https://analytics.babelstreet.com/rest/v1/'):
     """ Run the example """
     # Create an API instance
     api = API(user_key=key, service_url=alt_url)
@@ -28,9 +28,9 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
 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('-k', '--key', help='Analytics API Key', required=True)
 PARSER.add_argument('-u', '--url', help="Alternative API URL",
-                    default='https://api.rosette.com/rest/v1/')
+                    default='https://analytics.babelstreet.com/rest/v1/')
 
 if __name__ == '__main__':
     ARGS = PARSER.parse_args()

examples/language_multilingual.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Example code to call Rosette API to determine the language of a piece of text.
+Example code to call Analytics API to determine the language of a piece of text.
 """
 
 import argparse
@@ -10,7 +10,7 @@
 from rosette.api import API, DocumentParameters, RosetteException
 
 
-def run(key, alt_url='https://api.rosette.com/rest/v1/'):
+def run(key, alt_url='https://analytics.babelstreet.com/rest/v1/'):
     """ Run the example """
     # Create an API instance
     api = API(user_key=key, service_url=alt_url)
@@ -30,9 +30,9 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
 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('-k', '--key', help='Analytics API Key', required=True)
 PARSER.add_argument('-u', '--url', help="Alternative API URL",
-                    default='https://api.rosette.com/rest/v1/')
+                    default='https://analytics.babelstreet.com/rest/v1/')
 
 if __name__ == '__main__':
     ARGS = PARSER.parse_args()

examples/morphology_complete.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 """
-Example code to call Rosette API to get the complete morphological analysis of a piece of text.
+Example code to call Analytics API to get the complete morphological analysis of a piece of text.
 """
 
 import argparse
@@ -10,15 +10,15 @@
 from rosette.api import API, DocumentParameters, RosetteException
 
 
-def run(key, alt_url='https://api.rosette.com/rest/v1/'):
+def run(key, alt_url='https://analytics.babelstreet.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
+    # and other available options, see Analytics Features & Functions
+    # https://developer.babelstreet.com/features-and-functions#morphological-analysis-introduction
 
     # api.set_option('modelType','perceptron') #Valid for Chinese and Japanese only
 
@@ -34,9 +34,9 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
 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('-k', '--key', help='Analytics API Key', required=True)
 PARSER.add_argument('-u', '--url', help="Alternative API URL",
-                    default='https://api.rosette.com/rest/v1/')
+                    default='https://analytics.babelstreet.com/rest/v1/')
 
 if __name__ == '__main__':
     ARGS = PARSER.parse_args()