Merge pull request #116 from rosette-api/WS-3314-update-key-header-and-urls

Ws 3314 update key header and urls

Author: seth-mg

README.md

@@ -1,28 +1,46 @@
-<a href="https://www.babelstreet.com/rosette"><img src="https://charts.babelstreet.com/icon.png" width="47" height="60"/></a>
-# Rosette by Babel Street
+<a href="https://www.babelstreet.com/rosette">
+<picture>
+  <source media="(prefers-color-scheme: light)" srcset="https://charts.babelstreet.com/icon-dark.png">
+  <source media="(prefers-color-scheme: dark)" srcset="https://charts.babelstreet.com/icon-light.png">
+  <img alt="Babel Street Logo" width="48" height="48">
+</picture>
+</a>
+
+# Analytics by Babel Street
 
 [![PyPI version](https://badge.fury.io/py/rosette-api.svg)](https://badge.fury.io/py/rosette-api)
 [![Python Versions](https://img.shields.io/pypi/pyversions/rosette-api.svg?color=dark%20green&label=Python%20Versions)](https://img.shields.io/pypi/pyversions/rosette-api.svg?color=dark%20green&label=Python%20Versions)
 
-Rosette uses natural language processing, statistical modeling, and machine learning to analyze unstructured and semi-structured text across hundreds of language-script combinations, revealing valuable information and actionable data. Rosette provides endpoints for extracting entities and relationships, translating and comparing the similarity of names, categorizing and adding linguistic tags to text and more. Rosette Server is the on-premises installation of Rosette, with access to Rosette's functions as RESTful web service endpoints. This solves cloud security worries and allows customization (models/indexes) as needed for your business.
+Our product is a full text processing pipeline from data preparation to extracting the most relevant information and 
+analysis utilizing precise, focused AI that has built-in human understanding. Text Analytics provides foundational 
+linguistic analysis for identifying languages and relating words. The result is enriched and normalized text for 
+high-speed search and processing without translation.
+
+Text Analytics extracts events and entities — people, organizations, and places — from unstructured text and adds the 
+structure of associating those entities into events that deliver only the necessary information for near real-time 
+decision making. Accompanying tools shorten the process of training AI models to recognize domain-specific events.
+
+The product delivers a multitude of ways to sharpen and expand search results. Semantic similarity expands search 
+beyond keywords to words with the same meaning, even in other languages. Sentiment analysis and topic extraction help 
+filter results to what’s relevant.
 
-## Rosette API Access
-- Rosette Cloud [Sign Up](https://developer.rosette.com/signup)
+## Analytics API Access
+- Analytics Cloud [Sign Up](https://developer.babelstreet.com/signup)
 
 ## Quick Start
 
 #### Installation
 `pip install rosette_api`
 
 #### Examples
-View small example programs for each Rosette endpoint
+View small example programs for each Analytics endpoint
 in the [examples](https://github.com/rosette-api/python/tree/develop/examples) directory.
 
 #### Documentation & Support
 - [Binding API](https://rosette-api.github.io/python/)
-- [Rosette Platform API](https://docs.babelstreet.com/API/en/index-en.html)
+- [Analytics Platform API](https://docs.babelstreet.com/API/en/index-en.html)
 - [Binding Release Notes](https://github.com/rosette-api/python/wiki/Release-Notes)
-- [Rosette Platform Release Notes](https://babelstreet.my.site.com/support/s/article/Rosette-Cloud-Release-Notes)
+- [Analytics Platform Release Notes](https://docs.babelstreet.com/Release/en/rosette-cloud.html)
 - [Support](https://babelstreet.my.site.com/support/s/)
 - [Binding License: Apache 2.0](https://github.com/rosette-api/python/blob/develop/LICENSE.txt)
 

docs/source/conf.py

@@ -47,8 +47,8 @@
 
 # General information about the project.
 project = ''
-copyright = '2024, Basis Technology'
-author = 'Basis Technology'
+copyright = '2024, Babel Street'
+author = 'Babel Street'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

docs/source/index.rst

@@ -6,7 +6,7 @@
 
 Python Binding
 ==========================================
-This is the API documentation for the Rosette API Python Binding.  For examples and usage, please refer to our `API Guide <http://developer.rosette.com/api-guide>`_.
+This is the API documentation for the Babel Street Analytics API Python Binding.  For examples and usage, please refer to our `API Guide <http://developer.babelstreet.com/api-guide>`_.
 
 .. toctree::
    :maxdepth: 2

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
+python -m venv 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
+python -m venv 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()