check_public_endpoint

checks/endpoint_check.py

@@ -1,17 +1,53 @@
 import requests
 import sys
 
-import requests
+'''
+# Example usage:
+endpoint = "https://api-inference.huggingface.co/models/gpt2"
+status_info = check_endpoint(endpoint)
 
-def is_public_endpoint(endpoint: str):
-    try:
-        # No Authorization header required for public models
+if status_info["status"]:
+    print("Success:", status_info["message"])
+else:
+    print("Error:", status_info["message"])
+    print("Status Code:", status_info["status_code"])
+    print("Response Data:", status_info["response_data"])
+'''
+
+def check_public_endpoint(endpoint: str):
+    """
+    Checks the given endpoint and provides a detailed status and message.
+
+    Args:
+        endpoint (str): The URL of the endpoint to check.
+
+    Returns:
+        dict: Contains status (True/False) and a message explaining the result.
+    """
+    result = {
+        "status": False,  # Default status is failure
+        "message": "Unknown error",  # Default message
+        "status_code": None,
+        "response_data": None
+    }
+
+    try: # No Authorization header required for public models
         response = requests.get(endpoint)
-         
-        # Log the response status and headers for better insight
-        print(f"Response status code: {response.status_code}")
-        print(f"Response headers: {response.headers}")
-        
+        result["status_code"] = response.status_code
+        result["response_data"] = response.text
+
+        if response.status_code == 200:
+            result["status"] = True
+            result["message"] = "Endpoint is reachable and returned a valid response."
+        else:
+            result["message"] = f"Request failed with status code {response.status_code}. Response: {response.text}"
+
+    except requests.exceptions.RequestException as e:
+        result["message"] = f"Request failed with exception: {e}"
+
+    return result
+
+'''
         # Check if the response status code is 200 and it returns inference data
         if response.status_code == 200:
             # Public models will return inference data without needing an API key
@@ -26,13 +62,8 @@ def is_public_endpoint(endpoint: str):
             else:
                 print("The response does not contain inference-related data.")
                 return False
-        else:
-            print(f"Failed to reach the endpoint, status code: {response.status_code}")
-            return False
-    except requests.exceptions.RequestException as e:
-        print(f"Request failed: {e}")
-        return False
-
+ 
+'''
 
 
 def is_huggingface_endpoint(endpoint: str):