Completes OPEN-4865 Raise custom Openlayer errors for well-known user errors for LLMs

Author: gustavocidornelas

openlayer/api.py

@@ -29,6 +29,7 @@
 from tqdm import tqdm
 from tqdm.utils import CallbackIOWrapper
 
+from . import constants
 from .exceptions import ExceptionMap, OpenlayerException
 from .version import __version__
 
@@ -39,7 +40,6 @@
 HTTP_RETRY_ALLOWED_METHODS = frozenset({"GET", "PUT", "POST"})
 
 CLIENT_METADATA = {"version": __version__}
-REQUESTS_TIMEOUT = 60 * 60 * 3  # 3 hours
 
 
 class StorageType(Enum):
@@ -230,7 +230,7 @@ def upload_blob_s3(
                     data=m,
                     headers=headers,
                     verify=VERIFY_REQUESTS,
-                    timeout=REQUESTS_TIMEOUT,
+                    timeout=constants.REQUESTS_TIMEOUT,
                 )
 
         if res.ok:
@@ -260,7 +260,7 @@ def upload_blob_gcs(
                     data=wrapped_file,
                     headers={"Content-Type": "application/x-gzip"},
                     verify=VERIFY_REQUESTS,
-                    timeout=REQUESTS_TIMEOUT,
+                    timeout=constants.REQUESTS_TIMEOUT,
                 )
         if res.ok:
             body["storageUri"] = presigned_json["storageUri"]
@@ -292,7 +292,7 @@ def upload_blob_azure(
                         "x-ms-blob-type": "BlockBlob",
                     },
                     verify=VERIFY_REQUESTS,
-                    timeout=REQUESTS_TIMEOUT,
+                    timeout=constants.REQUESTS_TIMEOUT,
                 )
         if res.ok:
             body["storageUri"] = presigned_json["storageUri"]

openlayer/constants.py

@@ -9,3 +9,6 @@
 # -------------------------------- Size limits ------------------------------- #
 MAXIMUM_CHARACTER_LIMIT = 10000
 MAXIMUM_TAR_FILE_SIZE = 25  # MB
+
+# ----------------------------------- APIs ----------------------------------- #
+REQUESTS_TIMEOUT = 60 * 60 * 3  # 3 hours

openlayer/exceptions.py

@@ -107,6 +107,38 @@ class OpenlayerTimeoutError(OpenlayerException):
     code = 504
 
 
+# -------------------------- LLM-specific exceptions ------------------------- #
+class OpenlayerLlmException(OpenlayerException):
+    """Generic LLM exception class"""
+
+    def __init__(self, message):
+        super().__init__(message)
+
+
+class OpenlayerUnsupportedLlmProvider(OpenlayerLlmException):
+    """Unsupported provider exception class"""
+
+    def __init__(self, message, provider):
+        message = f"Unsupported LLM provider '{provider}'. " + message
+        super().__init__(message)
+
+
+class OpenlayerMissingLlmApiKey(OpenlayerLlmException):
+    """Missing LLM API key exception class"""
+
+    def __init__(self, message):
+        message = "Missing API key for the LLM provider. " + message
+        super().__init__(message)
+
+
+class OpenlayerInvalidLlmApiKey(OpenlayerLlmException):
+    """Invalid LLM API key exception class"""
+
+    def __init__(self, message):
+        message = "Invalid API key for the LLM provider. " + message
+        super().__init__(message)
+
+
 ExceptionMap: Dict[int, OpenlayerException] = {
     OpenlayerInvalidRequest.code: OpenlayerInvalidRequest,
     OpenlayerUnauthorized.code: OpenlayerUnauthorized,

openlayer/model_runners/ll_model_runners.py

@@ -17,6 +17,8 @@
 import requests
 from tqdm import tqdm
 
+from .. import constants
+from .. import exceptions as openlayer_exceptions
 from . import base_model_runner
 
 
@@ -287,8 +289,8 @@ def __init__(
     ):
         super().__init__(logger, **kwargs)
         if kwargs.get("anthropic_api_key") is None:
-            raise ValueError(
-                "Anthropic API key must be provided. Please pass it as the "
+            raise openlayer_exceptions.OpenlayerMissingLlmApiKey(
+                "Please pass your Anthropic API key as the "
                 "keyword argument 'anthropic_api_key'"
             )
 
@@ -358,8 +360,8 @@ def __init__(
     ):
         super().__init__(logger, **kwargs)
         if kwargs.get("cohere_api_key") is None:
-            raise ValueError(
-                "Cohere API key must be provided. Please pass it as the "
+            raise openlayer_exceptions.OpenlayerMissingLlmApiKey(
+                "Please pass your Cohere API key as the "
                 "keyword argument 'cohere_api_key'"
             )
 
@@ -374,8 +376,8 @@ def _initialize_llm(self):
                 api_key=self.cohere_api_key, check_api_key=True
             )
         except Exception as e:
-            raise ValueError(
-                "Cohere API key is invalid. Please pass a valid API key as the "
+            raise openlayer_exceptions.OpenlayerInvalidLlmApiKey(
+                "Please pass a valid Cohere API key as the "
                 f"keyword argument 'cohere_api_key' \n Error message: {e}"
             ) from e
         if self.model_config.get("model") is None:
@@ -441,8 +443,8 @@ def __init__(
     ):
         super().__init__(logger, **kwargs)
         if kwargs.get("openai_api_key") is None:
-            raise ValueError(
-                "OpenAI API key must be provided. Please pass it as the "
+            raise openlayer_exceptions.OpenlayerMissingLlmApiKey(
+                "Please pass your OpenAI API key as the "
                 "keyword argument 'openai_api_key'"
             )
 
@@ -459,8 +461,8 @@ def _initialize_llm(self):
         try:
             openai.Model.list()
         except Exception as e:
-            raise ValueError(
-                "OpenAI API key is invalid. Please pass a valid API key as the "
+            raise openlayer_exceptions.OpenlayerInvalidLlmApiKey(
+                "Please pass a valid OpenAI API key as the "
                 f"keyword argument 'openai_api_key' \n Error message: {e}"
             ) from e
         if self.model_config.get("model") is None:
@@ -540,8 +542,7 @@ def _initialize_llm(self):
         """Initializes the self-hosted LL model."""
         # Check if API key is valid
         try:
-            # TODO: move request timeout to constants.py
-            requests.get(self.url, timeout=10800)
+            requests.get(self.url, timeout=constants.REQUESTS_TIMEOUT)
         except Exception as e:
             raise ValueError(
                 "URL is invalid. Please pass a valid URL as the "
@@ -574,8 +575,9 @@ def _make_request(self, llm_input: str) -> Dict[str, Any]:
             "Content-Type": "application/json",
         }
         data = {self.input_key: llm_input}
-        # TODO: move request timeout to constants.py
-        response = requests.post(self.url, headers=headers, json=data, timeout=10800)
+        response = requests.post(
+            self.url, headers=headers, json=data, timeout=constants.REQUESTS_TIMEOUT
+        )
         if response.status_code == 200:
             response_data = response.json()[0]
             return response_data

openlayer/models.py

@@ -9,7 +9,7 @@
 from enum import Enum
 from typing import Any, Dict
 
-from . import tasks, utils
+from . import exceptions, tasks, utils
 from .model_runners import (
     base_model_runner,
     ll_model_runners,
@@ -172,7 +172,12 @@ def _create_ll_model_runner(
             raise ValueError("Model provider is required for LLM task types.")
 
         if model_provider not in ModelRunnerFactory._LLM_PROVIDERS:
-            raise ValueError(f"Model provider `{model_provider}` is not supported.")
+            raise exceptions.OpenlayerUnsupportedLlmProvider(
+                provider=model_provider,
+                message="\nCurrently, the supported providers are: 'OpenAI', 'Cohere',"
+                " 'Anthropic', 'SelfHosted', 'HuggingFace'. Reach out if you'd like us"
+                " to support your use case.",
+            )
 
         model_runner_class = ModelRunnerFactory._LL_MODEL_RUNNERS[task_type.value][
             model_provider