pygeai 0.1.51b3__py3-none-any.whl → 0.6.0b15__py3-none-any.whl

pygeai/evaluation/clients.py

@@ -2,15 +2,18 @@ from pygeai.core.base.clients import BaseClient
 from pygeai.core.base.session import Session
 from pygeai.core.common.exceptions import MissingRequirementException
 from pygeai.core.services.rest import ApiService
+from pygeai.core.utils.validators import validate_status_code
 
 
 class EvaluationClient(BaseClient):
 
-    def __init__(self, api_key: str = None, base_url: str = None, alias: str = "default", eval_url: str = None):
-        super().__init__(api_key, base_url, alias)
-        eval_url = self.session.eval_url if not eval_url else None
+    def __init__(self, api_key: str = None, base_url: str = None, alias: str = None, eval_url: str = None, *,
+                 access_token: str = None, project_id: str = None):
+        super().__init__(api_key, base_url, alias, access_token=access_token, project_id=project_id)
+        eval_url = self.session.eval_url if not eval_url else eval_url
         if not eval_url:
             raise MissingRequirementException("EVAL URL must be defined in order to use the Evaluation module.")
 
         self.session.eval_url = eval_url
-        self.api_service = ApiService(base_url=self.session.eval_url, token=self.session.api_key)
+        token = self.session.access_token if self.session.access_token else self.session.api_key
+        self.api_service = ApiService(base_url=self.session.eval_url, token=token, project_id=self.session.project_id)

pygeai/evaluation/dataset/clients.py

@@ -9,6 +9,8 @@ from pygeai.evaluation.dataset.endpoints import (
     CREATE_FILTER_VARIABLE, LIST_FILTER_VARIABLES, GET_FILTER_VARIABLE, UPDATE_FILTER_VARIABLE, DELETE_FILTER_VARIABLE,
     UPLOAD_DATASET_ROWS_FILE
 )
+from pygeai.core.utils.validators import validate_status_code
+from pygeai.core.utils.parsers import parse_json_response
 
 
 class EvaluationDatasetClient(EvaluationClient):
@@ -22,8 +24,8 @@ class EvaluationDatasetClient(EvaluationClient):
         response = self.api_service.get(
             endpoint=LIST_DATASETS
         )
-        result = response.json()
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "dataset operation")
 
     def create_dataset(
             self,
@@ -56,8 +58,8 @@ class EvaluationDatasetClient(EvaluationClient):
             endpoint=CREATE_DATASET,
             data=data
         )
-        result = response.json()
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "dataset operation")
 
     def create_dataset_from_file(self, file_path: str) -> dict:
         """
@@ -82,8 +84,8 @@ class EvaluationDatasetClient(EvaluationClient):
                 headers=headers,
                 file=file
             )
-            result = response.json()
-            return result
+            validate_status_code(response)
+            return parse_json_response(response, "upload dataset file")
         finally:
             if file:
                 file.close()
@@ -100,8 +102,8 @@ class EvaluationDatasetClient(EvaluationClient):
         response = self.api_service.get(
             endpoint=endpoint
         )
-        result = response.json()
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "dataset operation")
 
     def update_dataset(
             self,
@@ -141,8 +143,8 @@ class EvaluationDatasetClient(EvaluationClient):
             endpoint=endpoint,
             data=data
         )
-        result = response.json()
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "dataset operation")
 
     def delete_dataset(self, dataset_id: str) -> dict:
         """
@@ -156,8 +158,8 @@ class EvaluationDatasetClient(EvaluationClient):
         response = self.api_service.delete(
             endpoint=endpoint
         )
-        result = response.json()
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "dataset operation")
 
     def create_dataset_row(self, dataset_id: str, row: dict) -> dict:
         """
@@ -173,8 +175,8 @@ class EvaluationDatasetClient(EvaluationClient):
             endpoint=endpoint,
             data=row
         )
-        result = response.json()
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "dataset operation")
 
     def list_dataset_rows(self, dataset_id: str) -> dict:
         """
@@ -188,8 +190,8 @@ class EvaluationDatasetClient(EvaluationClient):
         response = self.api_service.get(
             endpoint=endpoint
         )
-        result = response.json()
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "dataset operation")
 
     def get_dataset_row(self, dataset_id: str, dataset_row_id: str) -> dict:
         """
@@ -204,8 +206,8 @@ class EvaluationDatasetClient(EvaluationClient):
         response = self.api_service.get(
             endpoint=endpoint
         )
-        result = response.json()
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "dataset operation")
 
     def update_dataset_row(self, dataset_id: str, dataset_row_id: str, row: dict) -> dict:
         """
@@ -222,8 +224,8 @@ class EvaluationDatasetClient(EvaluationClient):
             endpoint=endpoint,
             data=row
         )
-        result = response.json()
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "dataset operation")
 
     def delete_dataset_row(self, dataset_id: str, dataset_row_id: str) -> dict:
         """
@@ -238,8 +240,8 @@ class EvaluationDatasetClient(EvaluationClient):
         response = self.api_service.delete(
             endpoint=endpoint
         )
-        result = response.json()
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "dataset operation")
 
     def create_expected_source(
             self,
@@ -270,8 +272,8 @@ class EvaluationDatasetClient(EvaluationClient):
             endpoint=endpoint,
             data=data
         )
-        result = response.json()
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "dataset operation")
 
     def list_expected_sources(self, dataset_id: str, dataset_row_id: str) -> dict:
         """
@@ -286,8 +288,8 @@ class EvaluationDatasetClient(EvaluationClient):
         response = self.api_service.get(
             endpoint=endpoint
         )
-        result = response.json()
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "dataset operation")
 
     def get_expected_source(self, dataset_id: str, dataset_row_id: str, expected_source_id: str) -> dict:
         """
@@ -303,8 +305,8 @@ class EvaluationDatasetClient(EvaluationClient):
         response = self.api_service.get(
             endpoint=endpoint
         )
-        result = response.json()
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "dataset operation")
 
     def update_expected_source(
             self,
@@ -337,8 +339,8 @@ class EvaluationDatasetClient(EvaluationClient):
             endpoint=endpoint,
             data=data
         )
-        result = response.json()
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "dataset operation")
 
     def delete_expected_source(self, dataset_id: str, dataset_row_id: str, expected_source_id: str) -> dict:
         """
@@ -354,8 +356,8 @@ class EvaluationDatasetClient(EvaluationClient):
         response = self.api_service.delete(
             endpoint=endpoint
         )
-        result = response.json()
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "dataset operation")
 
     def create_filter_variable(
             self,
@@ -389,8 +391,8 @@ class EvaluationDatasetClient(EvaluationClient):
             endpoint=endpoint,
             data=data
         )
-        result = response.json()
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "dataset operation")
 
     def list_filter_variables(self, dataset_id: str, dataset_row_id: str) -> dict:
         """
@@ -405,8 +407,8 @@ class EvaluationDatasetClient(EvaluationClient):
         response = self.api_service.get(
             endpoint=endpoint
         )
-        result = response.json()
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "dataset operation")
 
     def get_filter_variable(self, dataset_id: str, dataset_row_id: str, filter_variable_id: str) -> dict:
         """
@@ -422,8 +424,8 @@ class EvaluationDatasetClient(EvaluationClient):
         response = self.api_service.get(
             endpoint=endpoint
         )
-        result = response.json()
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "dataset operation")
 
     def update_filter_variable(
             self,
@@ -459,8 +461,8 @@ class EvaluationDatasetClient(EvaluationClient):
             endpoint=endpoint,
             data=data
         )
-        result = response.json()
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "dataset operation")
 
     def delete_filter_variable(self, dataset_id: str, dataset_row_id: str, filter_variable_id: str) -> dict:
         """
@@ -476,8 +478,8 @@ class EvaluationDatasetClient(EvaluationClient):
         response = self.api_service.delete(
             endpoint=endpoint
         )
-        result = response.json()
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "dataset operation")
 
     def upload_dataset_rows_file(self, dataset_id: str, file_path: str) -> dict:
         """
@@ -504,8 +506,8 @@ class EvaluationDatasetClient(EvaluationClient):
                 headers=headers,
                 file=file
             )
-            result = response.json()
-            return result
+            validate_status_code(response)
+            return parse_json_response(response, "upload dataset rows file")
         finally:
             if file:
                 file.close()

pygeai/evaluation/plan/clients.py

@@ -5,6 +5,8 @@ from pygeai.evaluation.plan.endpoints import LIST_EVALUATION_PLANS, CREATE_EVALU
     UPDATE_EVALUATION_PLAN, DELETE_EVALUATION_PLAN, LIST_EVALUATION_PLAN_SYSTEM_METRICS, \
     ADD_EVALUATION_PLAN_SYSTEM_METRIC, GET_EVALUATION_PLAN_SYSTEM_METRIC, UPDATE_EVALUATION_PLAN_SYSTEM_METRIC, \
     DELETE_EVALUATION_PLAN_SYSTEM_METRIC, LIST_SYSTEM_METRICS, GET_SYSTEM_METRIC, EXECUTE_EVALUATION_PLAN
+from pygeai.core.utils.validators import validate_status_code
+from pygeai.core.utils.parsers import parse_json_response
 
 
 class EvaluationPlanClient(EvaluationClient):
@@ -18,8 +20,8 @@ class EvaluationPlanClient(EvaluationClient):
         response = self.api_service.get(
             endpoint=LIST_EVALUATION_PLANS
         )
-        result = json.loads(response.content)
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "evaluation plan operation")
 
     def create_evaluation_plan(
             self,
@@ -68,8 +70,8 @@ class EvaluationPlanClient(EvaluationClient):
             endpoint=CREATE_EVALUATION_PLAN,
             data=data
         )
-        result = json.loads(response.content)
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "evaluation plan operation")
 
     def get_evaluation_plan(self, evaluation_plan_id: str) -> dict:
         """
@@ -83,8 +85,8 @@ class EvaluationPlanClient(EvaluationClient):
         response = self.api_service.get(
             endpoint=endpoint
         )
-        result = json.loads(response.content)
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "evaluation plan operation")
 
     def update_evaluation_plan(
             self,
@@ -139,8 +141,8 @@ class EvaluationPlanClient(EvaluationClient):
             endpoint=endpoint,
             data=data
         )
-        result = json.loads(response.content)
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "evaluation plan operation")
 
     def delete_evaluation_plan(self, evaluation_plan_id: str) -> dict:
         """
@@ -154,8 +156,8 @@ class EvaluationPlanClient(EvaluationClient):
         response = self.api_service.delete(
             endpoint=endpoint
         )
-        result = json.loads(response.content)
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "evaluation plan operation")
 
     def list_evaluation_plan_system_metrics(self, evaluation_plan_id: str) -> dict:
         """
@@ -169,8 +171,8 @@ class EvaluationPlanClient(EvaluationClient):
         response = self.api_service.get(
             endpoint=endpoint
         )
-        result = json.loads(response.content)
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "evaluation plan operation")
 
     def add_evaluation_plan_system_metric(
             self,
@@ -196,8 +198,8 @@ class EvaluationPlanClient(EvaluationClient):
             endpoint=endpoint,
             data=data
         )
-        result = json.loads(response.content)
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "evaluation plan operation")
 
     def get_evaluation_plan_system_metric(self, evaluation_plan_id: str, system_metric_id: str) -> dict:
         """
@@ -212,8 +214,8 @@ class EvaluationPlanClient(EvaluationClient):
         response = self.api_service.get(
             endpoint=endpoint
         )
-        result = json.loads(response.content)
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "evaluation plan operation")
 
     def update_evaluation_plan_system_metric(
             self,
@@ -238,8 +240,8 @@ class EvaluationPlanClient(EvaluationClient):
             endpoint=endpoint,
             data=data
         )
-        result = json.loads(response.content)
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "evaluation plan operation")
 
     def delete_evaluation_plan_system_metric(self, evaluation_plan_id: str, system_metric_id: str) -> dict:
         """
@@ -254,8 +256,8 @@ class EvaluationPlanClient(EvaluationClient):
         response = self.api_service.delete(
             endpoint=endpoint
         )
-        result = json.loads(response.content)
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "evaluation plan operation")
 
     def list_system_metrics(self) -> dict:
         """
@@ -266,8 +268,8 @@ class EvaluationPlanClient(EvaluationClient):
         response = self.api_service.get(
             endpoint=LIST_SYSTEM_METRICS
         )
-        result = json.loads(response.content)
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "evaluation plan operation")
 
     def get_system_metric(self, system_metric_id: str) -> dict:
         """
@@ -281,8 +283,8 @@ class EvaluationPlanClient(EvaluationClient):
         response = self.api_service.get(
             endpoint=endpoint
         )
-        result = json.loads(response.content)
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "evaluation plan operation")
 
     def execute_evaluation_plan(self, evaluation_plan_id: str) -> dict:
         """
@@ -296,5 +298,5 @@ class EvaluationPlanClient(EvaluationClient):
         response = self.api_service.post(
             endpoint=endpoint,
         )
-        result = json.loads(response.content)
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "evaluation plan operation")

pygeai/evaluation/result/clients.py

@@ -2,9 +2,27 @@ import json
 
 from pygeai.evaluation.clients import EvaluationClient
 from pygeai.evaluation.result.endpoints import LIST_EVALUATION_RESULTS, GET_EVALUATION_RESULT
+from pygeai.core.utils.validators import validate_status_code
+from pygeai.core.utils.parsers import parse_json_response
 
 
 class EvaluationResultClient(EvaluationClient):
+    """
+    Client for interacting with the Evaluation Result API.
+    
+    This API is read-only and retrieves results from executed evaluation plans.
+    
+    .. warning::
+        The API documentation at https://docs.globant.ai/en/wiki?856,Evaluation+Result+API
+        contains several typos in field names. The actual API responses use these typo'd names:
+        
+        - evaluationResultAssitantRevision (missing 's' in Assistant)
+        - evaluationResultChunckCount (should be Chunk, not Chunck)
+        - evaluationResultChunckSize (should be Chunk, not Chunck)
+        - evaluationResultaMaxTokens (lowercase 'a' should be uppercase 'M', no 'a')
+        
+        Our implementation returns these fields as-is from the API.
+    """
 
     def list_evaluation_results(self, evaluation_plan_id: str) -> dict:
         """
@@ -13,13 +31,20 @@ class EvaluationResultClient(EvaluationClient):
         :param evaluation_plan_id: str - The ID of the evaluation plan.
 
         :return: dict - API response containing a list of evaluation results.
+        
+        .. note::
+            Response contains evaluation result objects with fields including:
+            dataSetId, evaluationPlanId, evaluationResultId, evaluationResultStatus,
+            evaluationResultCost, evaluationResultDuration, and others.
+            
+            See class documentation for field name typos in the API.
         """
         endpoint = LIST_EVALUATION_RESULTS.format(evaluationPlanId=evaluation_plan_id)
         response = self.api_service.get(
             endpoint=endpoint
         )
-        result = json.loads(response.content)
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "evaluation plan operation")
 
     def get_evaluation_result(self, evaluation_result_id: str) -> dict:
         """
@@ -27,11 +52,19 @@ class EvaluationResultClient(EvaluationClient):
 
         :param evaluation_result_id: str - The ID of the evaluation result.
 
-        :return: dict - The evaluation result metadata as a dictionary.
+        :return: dict - The evaluation result metadata as a dictionary, including row-level data.
+        
+        .. note::
+            Response includes all fields from list_evaluation_results plus a 'rows' array
+            containing detailed row-level evaluation data with fields like:
+            dataSetRowId, evaluationResultRowStatus, evaluationResultRowOutput,
+            evaluationResultRowCost, etc.
+            
+            See class documentation for field name typos in the API.
         """
         endpoint = GET_EVALUATION_RESULT.format(evaluationResultId=evaluation_result_id)
         response = self.api_service.get(
             endpoint=endpoint
         )
-        result = json.loads(response.content)
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "evaluation plan operation")

pygeai/gam/clients.py

@@ -1,13 +1,51 @@
-from json import JSONDecodeError
 
+from pygeai import logger
 from pygeai.core.base.clients import BaseClient
-from pygeai.core.common.exceptions import MissingRequirementException
-from pygeai.core.services.rest import ApiService
-from pygeai.gam.endpoints import GET_ACCESS_TOKEN_V2, GET_USER_INFO_V2
+from pygeai.core.common.exceptions import MissingRequirementException, InvalidAPIResponseException
+from pygeai.core.utils.validators import validate_status_code
+from pygeai.core.utils.parsers import parse_json_response
+from pygeai.gam.endpoints import GET_ACCESS_TOKEN_V2, GET_USER_INFO_V2, IDP_SIGNIN_V1
 
 
 class GAMClient(BaseClient):
 
+    def generate_signing_url(
+            self,
+            client_id: str = None,
+            redirect_uri: str = None,
+            scope: str = "gam_user_data",
+            state: str = None,
+            response_type: str = "code"
+    ):
+        """
+        Generates the URL for the GAM OAuth 2.0 signin endpoint to initiate user authentication.
+        This method does not perform the signin itself but provides the URL for redirection in a browser-based flow.
+
+        :param client_id: str - Client ID of the application. Required.
+        :param redirect_uri: str - Callback URL configured in the application. Required.
+        :param scope: str - Scope of the user account to access (e.g., "gam_user_data").
+            Defaults to "gam_user_data".
+        :param state: str - Random string to store the status before the request. Required.
+        :param response_type: str - Response type for the signin request. Defaults to "code".
+        :return: str - The URL to redirect to for user authentication in a browser.
+        :raises MissingRequirementException: If required parameters are missing.
+        """
+        if not all([client_id, redirect_uri, state]):
+            raise MissingRequirementException("client_id, redirect_uri, and state are required.")
+
+        params = {
+            "response_type": response_type,
+            "client_id": client_id,
+            "redirect_uri": redirect_uri,
+            "state": state
+        }
+        if scope:
+            params["scope"] = scope
+
+        endpoint = f"{self.api_service.base_url}{IDP_SIGNIN_V1}"
+        redirect_url = f"{endpoint}?{'&'.join(f'{k}={v}' for k, v in params.items())}"
+        return redirect_url
+
     def get_access_token(
             self,
             client_id: str = None,
@@ -67,12 +105,8 @@ class GAMClient(BaseClient):
             headers=headers,
             form=True
         )
-        try:
-            result = response.json()
-        except JSONDecodeError as e:
-            result = response.text
-
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "get access token")
 
     def get_user_info(
             self,
@@ -93,12 +127,8 @@ class GAMClient(BaseClient):
             endpoint=GET_USER_INFO_V2,
             headers=headers
         )
-        try:
-            result = response.json()
-        except JSONDecodeError as e:
-            result = response.text
-
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "get user info")
 
     def refresh_access_token(
             self,
@@ -136,21 +166,13 @@ class GAMClient(BaseClient):
             headers=headers,
             form=True
         )
-        try:
-            result = response.json()
-        except JSONDecodeError as e:
-            result = response.text
-
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "refresh access token")
 
     def get_authentication_types(self):
         response = self.api_service.get(
             endpoint=GET_ACCESS_TOKEN_V2,
             params={},
         )
-        try:
-            result = response.json()
-        except JSONDecodeError as e:
-            result = response.text
-
-        return result
+        validate_status_code(response)
+        return parse_json_response(response, "get authentication types")

pygeai/gam/endpoints.py

@@ -1,3 +1,4 @@
 GET_ACCESS_TOKEN_V2 = "oauth/gam/v2.0/access_token"     # POST -> Sends the user credentials to get a new Token
 GET_USER_INFO_V2 = "oauth/gam/v2.0/userinfo"            # GET -> Send the access_token obtained in the previous request and get the user info depending on the scopes you have indicated.
-GET_AUTHENTICATION_TYPES_V1 = "v1/gam/authentication-types"     # GET -> Get authentication types
+GET_AUTHENTICATION_TYPES_V1 = "v1/gam/authentication-types"     # GET -> Get authentication types
+IDP_SIGNIN_V1 = "/oauth/gam/signin"     # NO METHOD -> Just generates URL for authentication in browser

pygeai/health/clients.py

@@ -0,0 +1,24 @@
+
+from pygeai import logger
+from pygeai.core.base.clients import BaseClient
+from pygeai.core.common.exceptions import InvalidAPIResponseException
+from pygeai.core.utils.validators import validate_status_code
+from pygeai.core.utils.parsers import parse_json_response
+from pygeai.health.endpoints import STATUS_CHECK_V1
+
+
+class HealthClient(BaseClient):
+
+    def check_api_status(self) -> dict:
+        """
+        Checks the status of the API.
+
+        :return: dict - The API response as a JSON object containing details about the API status.
+        If the response cannot be parsed as JSON, returns the raw response text.
+        """
+        endpoint = STATUS_CHECK_V1
+        response = self.api_service.get(
+            endpoint=endpoint
+        )
+        validate_status_code(response)
+        return parse_json_response(response, "check API status")

pygeai/health/endpoints.py

@@ -0,0 +1 @@
+STATUS_CHECK_V1 = "/v1/system/status"   # GET -> Health Check SAIA APIs