llumo 0.1.0__py3-none-any.whl

llumo/__init__.py

@@ -0,0 +1,2 @@
+from .client import LlumoClient
+from .exceptions import LlumoAPIError

llumo/client.py

@@ -0,0 +1,76 @@
+import requests
+from .exceptions import LlumoAPIError
+
+class LlumoClient:
+    """
+    A client to interact with Llumo API for evaluating AI-generated responses
+    """
+
+    base_url = "https://app.llumo.ai/api"
+
+    def __init__(self, api_key):
+        """
+        Initializes the LlumoClient with the given API key.
+
+        Parameters:
+        - api_key (str): The Llumo API key for authentication.
+        """
+        self.api_key = api_key
+
+
+    def EvaluateGrounded(self, outputText, groundTruthText, embeddingModelName="Google", metricsName="Cosine"):
+        """
+        Evaluates the groundedness of a response using a similarity metric.
+
+        Parameters:
+        - outputText (str): The generated output text to evaluate.
+        - groundTruthText (str): The reference ground truth text.
+        - embeddingModelName (str): Name of the embedding model to use. Default is "Google".
+        - metricsName (str): Similarity metric to apply (e.g., "Bleu"). Default is "Cosine".
+
+        Returns:
+        - dict: Contains statusCode, message, and evaluation data if successful.
+
+        Raises:
+        - LlumoAPIError for all specific error types.
+        """
+        url = f"{self.base_url}/external/grounded-external"
+
+        requestBody = {
+            "prompt": outputText,
+            "groundTruth": groundTruthText,
+            "embeddingModel": embeddingModelName,
+            "similarityMetric": metricsName,
+        }
+
+        headers = {
+            "Authorization": f"Bearer {self.api_key}",
+            "Content-Type": "application/json"
+        }
+
+        try:
+            res = requests.post(url=url, json=requestBody, headers=headers)
+
+            if res.status_code == 401:
+                raise LlumoAPIError.InvalidApiKey()
+
+            res.raise_for_status()
+            result = res.json()
+
+            if 'data' not in result:
+                raise LlumoAPIError.InvalidApiResponse()
+
+            return {
+                "statusCode": result['data'].get('statusCode'),
+                "message": result['data'].get('message'),
+                "analytics": result['data']
+            }
+
+        except requests.exceptions.HTTPError as e:
+            raise LlumoAPIError.RequestFailed(str(e))
+        except ValueError:
+            raise LlumoAPIError.InvalidJsonResponse()
+        except Exception as e:
+            raise LlumoAPIError.UnexpectedError(str(e))
+
+

llumo/exceptions.py

@@ -0,0 +1,30 @@
+class LlumoAPIError(Exception):
+    """Base class for all Llumo SDK-related errors."""
+
+    def __init__(self, message):
+        self.message = message
+        super().__init__(self.message)
+
+    @staticmethod
+    def InvalidApiKey():
+        return LlumoAPIError("The provided API key is invalid or unauthorized")
+
+    @staticmethod
+    def InvalidApiResponse():
+        return LlumoAPIError("Invalid or UnexpectedError response from the API")
+
+    @staticmethod
+    def RequestFailed(detail="The request to the API failed"):
+        return LlumoAPIError(f"Request to the API failed: {detail}")
+
+    @staticmethod
+    def InvalidJsonResponse():
+        return LlumoAPIError("The API response is not in valid JSON format")
+
+    @staticmethod
+    def UnexpectedError(detail="An UnexpectedError error occurred"):
+        return LlumoAPIError(f"UnexpectedError error: {detail}")
+
+    @staticmethod
+    def EvalError(detail="Some error occured while processing"):
+        return LlumoAPIError(f"error: {detail}")

llumo-0.1.0.dist-info/METADATA

@@ -0,0 +1,23 @@
+Metadata-Version: 2.4
+Name: llumo
+Version: 0.1.0
+Summary: Python SDK for interacting with the Llumo ai API.
+Home-page: https://www.llumo.ai/
+Author: Llumo
+Author-email: product@llumo.ai
+License: Proprietary
+Requires-Python: >=3.7
+License-File: LICENSE
+Requires-Dist: requests>=2.25.1
+Requires-Dist: setuptools>=58.1.0
+Requires-Dist: twine>=6.1.0
+Requires-Dist: wheel>=0.45.1
+Requires-Dist: build>=1.2.2.post1
+Dynamic: author
+Dynamic: author-email
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

llumo-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+llumo/__init__.py,sha256=WT0Y6g-MtJqIIMpH1AoWQfL-XraaQDtMbjApjBHRPqk,72
+llumo/client.py,sha256=w1rd6uT4F-iwHty8xDqXy3Q5BM_9u1jgdSZvy032LQE,2468
+llumo/exceptions.py,sha256=BQcLqfViMxPklGIPJnH1tfajdytvuGpd5Sidv4ta6h0,1039
+llumo-0.1.0.dist-info/licenses/LICENSE,sha256=vMiqSi3KpDHq3RFxKiqdh10ZUF3PjE3nnntANU-HEu4,186
+llumo-0.1.0.dist-info/METADATA,sha256=OcJtsjap9U3XwzxjR03V4VzITQbPkOO_JgCcSgg0qo0,593
+llumo-0.1.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+llumo-0.1.0.dist-info/top_level.txt,sha256=d5zUTMI99llPtLRB8rtSrqELm_bOqX-bNC5IcwlDk88,6
+llumo-0.1.0.dist-info/RECORD,,

llumo-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (78.1.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

llumo-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,4 @@
+Copyright (c) 2025 Llumo AI
+
+All rights reserved. This software is proprietary and confidential. 
+Unauthorized copying, distribution, or use of this software is strictly prohibited.

llumo-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+llumo