Merge pull request #695 from FlorentinD/eap-preparation

Prepare session notebook for EAP

Author: FlorentinD

doc/modules/ROOT/pages/tutorials/gds-sessions.adoc

@@ -22,9 +22,16 @@ listing, and deletion.
 
 == Prerequisites
 
-This notebook requires having an AuraDB instance available. We also need
-to have the `graphdatascience` Python library installed, version
-`1.11a4` or later.
+This notebook requires having an AuraDB instance available and have the
+GDS sessions feature enabled for your tenant. Contact your account
+manager to get the features enabled.
+
+We also need to have the `graphdatascience` Python library installed,
+version `1.11a4` or later.
+
+
+
+
 
 [source, python, role=no-test]
 ----
@@ -51,7 +58,9 @@ client_id = os.environ["AURA_API_CLIENT_ID"]
 client_secret = os.environ["AURA_API_CLIENT_SECRET"]
 
 # If your account is a member of several tenants, you must also specify the tenant ID to use
-sessions = GdsSessions(api_credentials=AuraAPICredentials(client_id, client_secret))
+tenant_id = os.environ.get("AURA_API_TENANT_ID", None)
+
+sessions = GdsSessions(api_credentials=AuraAPICredentials(client_id, client_secret, tenant_id=tenant_id))
 ----
 
 == Creating a new session

examples/gds-sessions.ipynb

@@ -40,11 +40,23 @@
    "source": [
     "## Prerequisites\n",
     "\n",
-    "This notebook requires having an AuraDB instance available.\n",
+    "This notebook requires having an AuraDB instance available and have the GDS sessions feature enabled for your tenant. \n",
+    "Contact your account manager to get the features enabled. \n",
+    "\n",
     "We also need to have the `graphdatascience` Python library installed, version `1.11a4` or later.\n",
     "\n"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": []
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": []
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -84,7 +96,9 @@
     "client_secret = os.environ[\"AURA_API_CLIENT_SECRET\"]\n",
     "\n",
     "# If your account is a member of several tenants, you must also specify the tenant ID to use\n",
-    "sessions = GdsSessions(api_credentials=AuraAPICredentials(client_id, client_secret))"
+    "tenant_id = os.environ.get(\"AURA_API_TENANT_ID\", None)\n",
+    "\n",
+    "sessions = GdsSessions(api_credentials=AuraAPICredentials(client_id, client_secret, tenant_id=tenant_id))"
    ]
   },
   {

graphdatascience/session/aura_api.py

@@ -32,14 +32,14 @@ def __init__(self, message: str, status_code: int):
 
 class AuraApi:
     def __init__(self, client_id: str, client_secret: str, tenant_id: Optional[str] = None) -> None:
-        self._dev_env = os.environ.get("AURA_ENV")
+        self._aura_env = os.environ.get("AURA_ENV")
 
-        if not self._dev_env:
+        if not self._aura_env or self._aura_env == "production":
             self._base_uri = "https://api.neo4j.io"
-        elif self._dev_env == "staging":
+        elif self._aura_env == "staging":
             self._base_uri = "https://api-staging.neo4j.io"
         else:
-            self._base_uri = f"https://api-{self._dev_env}.neo4j-dev.io"
+            self._base_uri = f"https://api-{self._aura_env}.neo4j-dev.io"
 
         self._auth = AuraApi.Auth(oauth_url=f"{self._base_uri}/oauth/token", credentials=(client_id, client_secret))
         self._logger = logging.getLogger()
@@ -268,9 +268,6 @@ def _check_endpoint_expiry(self, resp: requests.Response) -> None:
                 DeprecationWarning,
             )
 
-    def _instance_type(self) -> str:
-        return "enterprise-ds" if not self._dev_env else "professional-ds"
-
     class Auth(requests.auth.AuthBase):
         class Token:
             access_token: str

graphdatascience/session/gds_sessions.py

@@ -22,12 +22,12 @@ class AuraAPICredentials:
     Attributes:
         client_id (str): The client ID for authentication.
         client_secret (str): The client secret for authentication.
-        tenant (Optional[str]): The tenant for authentication. Needed if a client belongs to multiple tenants.
+        tenant_id (Optional[str]): The tenant ID for authentication. Needed if a client belongs to multiple tenants.
     """
 
     client_id: str
     client_secret: str
-    tenant: Optional[str] = None
+    tenant_id: Optional[str] = None
 
 
 class GdsSessions:
@@ -42,8 +42,8 @@ def __init__(self, api_credentials: AuraAPICredentials) -> None:
         Args:
             api_credentials (AuraAPICredentials): The Aura API credentials used for establishing a connection.
         """
-        aura_api = AuraApi(api_credentials.client_id, api_credentials.client_secret, api_credentials.tenant)
-        session_type_flag = os.environ.get("USE_DEDICATED_SESSIONS", "false").lower() == "true"
+        aura_api = AuraApi(api_credentials.client_id, api_credentials.client_secret, api_credentials.tenant_id)
+        session_type_flag = os.environ.get("USE_DEDICATED_SESSIONS", "true").lower() == "true"
         self._impl: Union[DedicatedSessions, AuraDsSessions] = (
             DedicatedSessions(aura_api) if session_type_flag else AuraDsSessions(aura_api)
         )