Merge pull request #65 from Nixtla/feat/add_token_validator_endpoint

feat: add validate token method
Nixtla · Aug 7, 2023 · 577fa2c · 577fa2c
2 parents 3f44347 + b4bd506
commit 577fa2c
Show file tree

Hide file tree

Showing 3 changed files with 201 additions and 71 deletions.
diff --git a/nbs/timegpt.ipynb b/nbs/timegpt.ipynb
diff --git a/nixtlats/_modidx.py b/nixtlats/_modidx.py
@@ -20,4 +20,6 @@
                                                                                   'nixtlats/timegpt.py'),
                                   'nixtlats.timegpt.TimeGPT.forecast': ('timegpt.html#timegpt.forecast', 'nixtlats/timegpt.py'),
                                   'nixtlats.timegpt.TimeGPT.request_headers': ( 'timegpt.html#timegpt.request_headers',
-                                                                                'nixtlats/timegpt.py')}}}
+                                                                                'nixtlats/timegpt.py'),
+                                  'nixtlats.timegpt.TimeGPT.validate_token': ( 'timegpt.html#timegpt.validate_token',
+                                                                               'nixtlats/timegpt.py')}}}
diff --git a/nixtlats/timegpt.py b/nixtlats/timegpt.py
@@ -1,16 +1,19 @@
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/timegpt.ipynb.
 
 # %% auto 0
-__all__ = []
+__all__ = ['logger']
 
 # %% ../nbs/timegpt.ipynb 5
+import logging
 import inspect
 import json
 import requests
 from typing import Dict, List, Optional, Union
 
 import pandas as pd
 
+logger = logging.getLogger()
+
 # %% ../nbs/timegpt.ipynb 7
 class TimeGPT:
     """
@@ -48,6 +51,19 @@ def _parse_response(self, response) -> Dict:
             raise Exception(response)
         return resp
 
+    def validate_token(self) -> bool:
+        """Returns True if your token is valid."""
+        response = requests.post(
+            f"{self.api_url}/validate_token_front",
+            headers=self.request_headers,
+        )
+        valid = True
+        try:
+            response = self._parse_response(response)
+        except:
+            valid = False
+        return valid
+
     def _input_size(self, freq: str):
         response_input_size = requests.post(
             f"{self.api_url}/timegpt_input_size",
@@ -240,6 +256,11 @@ def forecast(
             DataFrame with TimeGPT forecasts for point predictions and probabilistic
             predictions (if level is not None).
         """
+        if not self.validate_token():
+            raise Exception(
+                "Token not valid, please go to https://dashboard.nixtla.io/ to get yours"
+            )
+
         df, X_df, drop_uid = self._validate_inputs(
             df=df,
             X_df=X_df,