Development 2 Test

.pre-commit-config.yaml

@@ -3,7 +3,7 @@ repos:
     hooks:
       - id: pytest-check
         name: pytest-check
-        entry: coverage run -m pytest tests/unit
+        entry: coverage run --source=. -m pytest tests/unit
         language: python
         pass_filenames: false
         types: [python]

aixplain/enums/__init__.py

@@ -13,4 +13,4 @@
 from .supplier import Supplier
 from .sort_by import SortBy
 from .sort_order import SortOrder
-from .model_status import ModelStatus
+from .response_status import ResponseStatus

aixplain/enums/response_status.py

@@ -0,0 +1,31 @@
+__author__ = "thiagocastroferreira"
+
+"""
+Copyright 2024 The aiXplain SDK authors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+Author: Duraikrishna Selvaraju, Thiago Castro Ferreira, Shreyas Sharma and Lucas Pavanelli
+Date: February 21st 2024
+Description:
+    Asset Enum
+"""
+
+from enum import Enum
+from typing import Text
+
+
+class ResponseStatus(Text, Enum):
+    IN_PROGRESS = "IN_PROGRESS"
+    SUCCESS = "SUCCESS"
+    FAILED = "FAILED"

aixplain/enums/supplier.py

@@ -48,6 +48,7 @@ def load_suppliers():
         headers = {"x-aixplain-key": aixplain_key, "Content-Type": "application/json"}
     else:
         headers = {"x-api-key": api_key, "Content-Type": "application/json"}
+    logging.debug(f"Start service for GET API Creation  - {url} - {headers}")
     r = _request_with_retry("get", url, headers=headers)
     if not 200 <= r.status_code < 300:
         raise Exception(

aixplain/factories/file_factory.py

@@ -91,7 +91,7 @@ def check_storage_type(cls, input_link: Any) -> StorageType:
         Returns:
             StorageType: URL, TEXT or FILE
         """
-        if os.path.exists(input_link) is True:
+        if os.path.exists(input_link) is True and os.path.isfile(input_link) is True:
             return StorageType.FILE
         elif (
             input_link.startswith("s3://")

aixplain/factories/model_factory.py

@@ -222,7 +222,7 @@ def _get_assets_from_page(
     @classmethod
     def list(
         cls,
-        function: Function,
+        function: Optional[Function] = None,
         query: Optional[Text] = "",
         suppliers: Optional[Union[Supplier, List[Supplier]]] = None,
         source_languages: Optional[Union[Language, List[Language]]] = None,

aixplain/factories/pipeline_factory/utils.py

@@ -88,7 +88,7 @@ def build_from_response(response: Dict, load_architecture: bool = False) -> Pipe
                             data_type=custom_input.get("dataType"),
                             code=custom_input["code"],
                             value=custom_input.get("value"),
-                            is_required=custom_input.get("isRequired", False),
+                            is_required=custom_input.get("isRequired", True),
                         )
                 node.number = node_json["number"]
                 node.label = node_json["label"]

aixplain/modules/model/__init__.py

@@ -32,7 +32,7 @@
 from typing import Union, Optional, Text, Dict
 from datetime import datetime
 from aixplain.modules.model.response import ModelResponse
-from aixplain.enums import ModelStatus
+from aixplain.enums.response_status import ResponseStatus
 
 
 class Model(Asset):
@@ -106,6 +106,7 @@ def to_dict(self) -> Dict:
         return {
             "id": self.id,
             "name": self.name,
+            "description": self.description,
             "supplier": self.supplier,
             "additional_info": clean_additional_info,
             "input_params": self.input_params,
@@ -118,7 +119,9 @@ def __repr__(self):
         except Exception:
             return f"<Model: {self.name} by {self.supplier}>"
 
-    def sync_poll(self, poll_url: Text, name: Text = "model_process", wait_time: float = 0.5, timeout: float = 300) -> Dict:
+    def sync_poll(
+        self, poll_url: Text, name: Text = "model_process", wait_time: float = 0.5, timeout: float = 300
+    ) -> ModelResponse:
         """Keeps polling the platform to check whether an asynchronous call is done.
 
         Args:
@@ -135,7 +138,7 @@ def sync_poll(self, poll_url: Text, name: Text = "model_process", wait_time: flo
         # keep wait time as 0.2 seconds the minimum
         wait_time = max(wait_time, 0.2)
         completed = False
-        response_body = {"status": "FAILED", "completed": False}
+        response_body = ModelResponse(status=ResponseStatus.FAILED, completed=False)
         while not completed and (end - start) < timeout:
             try:
                 response_body = self.poll(poll_url, name=name)
@@ -147,13 +150,17 @@ def sync_poll(self, poll_url: Text, name: Text = "model_process", wait_time: flo
                     if wait_time < 60:
                         wait_time *= 1.1
             except Exception as e:
-                response_body = {"status": "FAILED", "completed": False, "error_message": "No response from the service."}
+                response_body = ModelResponse(
+                    status=ResponseStatus.FAILED, completed=False, error_message="No response from the service."
+                )
                 logging.error(f"Polling for Model: polling for {name}: {e}")
                 break
         if response_body["completed"] is True:
             logging.debug(f"Polling for Model: Final status of polling for {name}: {response_body}")
         else:
-            response_body["status"] = "FAILED"
+            response_body = ModelResponse(
+                status=ResponseStatus.FAILED, completed=False, error_message="No response from the service."
+            )
             logging.error(
                 f"Polling for Model: Final status of polling for {name}: No response in {timeout} seconds - {response_body}"
             )
@@ -174,11 +181,11 @@ def poll(self, poll_url: Text, name: Text = "model_process") -> ModelResponse:
         try:
             resp = r.json()
             if resp["completed"] is True:
-                status = ModelStatus.SUCCESS
+                status = ResponseStatus.SUCCESS
                 if "error_message" in resp or "supplierError" in resp:
-                    status = ModelStatus.FAILED
+                    status = ResponseStatus.FAILED
             else:
-                status = ModelStatus.IN_PROGRESS
+                status = ResponseStatus.IN_PROGRESS
             logging.debug(f"Single Poll for Model: Status of polling for {name}: {resp}")
             return ModelResponse(
                 status=resp.pop("status", status),
@@ -195,7 +202,7 @@ def poll(self, poll_url: Text, name: Text = "model_process") -> ModelResponse:
             resp = {"status": "FAILED"}
             logging.error(f"Single Poll for Model: Error of polling for {name}: {e}")
             return ModelResponse(
-                status=ModelStatus.FAILED,
+                status=ResponseStatus.FAILED,
                 error_message=str(e),
                 completed=False,
             )
@@ -205,7 +212,7 @@ def run(
         data: Union[Text, Dict],
         name: Text = "model_process",
         timeout: float = 300,
-        parameters: Optional[Dict] = {},
+        parameters: Optional[Dict] = None,
         wait_time: float = 0.5,
     ) -> ModelResponse:
         """Runs a model call.
@@ -214,7 +221,7 @@ def run(
             data (Union[Text, Dict]): link to the input data
             name (Text, optional): ID given to a call. Defaults to "model_process".
             timeout (float, optional): total polling time. Defaults to 300.
-            parameters (Dict, optional): optional parameters to the model. Defaults to "{}".
+            parameters (Dict, optional): optional parameters to the model. Defaults to None.
             wait_time (float, optional): wait time in seconds between polling calls. Defaults to 0.5.
 
         Returns:
@@ -234,9 +241,9 @@ def run(
                 msg = f"Error in request for {name} - {traceback.format_exc()}"
                 logging.error(f"Model Run: Error in running for {name}: {e}")
                 end = time.time()
-                response = {"status": "FAILED", "error": msg, "runTime": end - start}
+                response = {"status": "FAILED", "error_message": msg, "runTime": end - start}
         return ModelResponse(
-            status=response.pop("status", ModelStatus.FAILED),
+            status=response.pop("status", ResponseStatus.FAILED),
             data=response.pop("data", ""),
             details=response.pop("details", {}),
             completed=response.pop("completed", False),
@@ -247,13 +254,15 @@ def run(
             **response,
         )
 
-    def run_async(self, data: Union[Text, Dict], name: Text = "model_process", parameters: Optional[Dict] = {}) -> ModelResponse:
+    def run_async(
+        self, data: Union[Text, Dict], name: Text = "model_process", parameters: Optional[Dict] = None
+    ) -> ModelResponse:
         """Runs asynchronously a model call.
 
         Args:
             data (Union[Text, Dict]): link to the input data
             name (Text, optional): ID given to a call. Defaults to "model_process".
-            parameters (Dict, optional): optional parameters to the model. Defaults to "{}".
+            parameters (Dict, optional): optional parameters to the model. Defaults to None.
 
         Returns:
             dict: polling URL in response
@@ -263,7 +272,7 @@ def run_async(self, data: Union[Text, Dict], name: Text = "model_process", param
         payload = build_payload(data=data, parameters=parameters)
         response = call_run_endpoint(payload=payload, url=url, api_key=self.api_key)
         return ModelResponse(
-            status=response.pop("status", ModelStatus.FAILED),
+            status=response.pop("status", ResponseStatus.FAILED),
             data=response.pop("data", ""),
             details=response.pop("details", {}),
             completed=response.pop("completed", False),

aixplain/modules/model/llm_model.py

@@ -29,7 +29,7 @@
 from aixplain.utils import config
 from typing import Union, Optional, List, Text, Dict
 from aixplain.modules.model.response import ModelResponse
-from aixplain.enums import ModelStatus
+from aixplain.enums.response_status import ResponseStatus
 
 
 class LLM(Model):
@@ -104,7 +104,7 @@ def run(
         top_p: float = 1.0,
         name: Text = "model_process",
         timeout: float = 300,
-        parameters: Optional[Dict] = {},
+        parameters: Optional[Dict] = None,
         wait_time: float = 0.5,
     ) -> ModelResponse:
         """Synchronously running a Large Language Model (LLM) model.
@@ -119,21 +119,23 @@ def run(
             top_p (float, optional): Top P. Defaults to 1.0.
             name (Text, optional): ID given to a call. Defaults to "model_process".
             timeout (float, optional): total polling time. Defaults to 300.
-            parameters (Dict, optional): optional parameters to the model. Defaults to "{}".
+            parameters (Dict, optional): optional parameters to the model. Defaults to None.
             wait_time (float, optional): wait time in seconds between polling calls. Defaults to 0.5.
 
         Returns:
             Dict: parsed output from model
         """
         start = time.time()
+        if parameters is None:
+            parameters = {}
         parameters.update(
             {
-                "context": parameters["context"] if "context" in parameters else context,
-                "prompt": parameters["prompt"] if "prompt" in parameters else prompt,
-                "history": parameters["history"] if "history" in parameters else history,
-                "temperature": parameters["temperature"] if "temperature" in parameters else temperature,
-                "max_tokens": parameters["max_tokens"] if "max_tokens" in parameters else max_tokens,
-                "top_p": parameters["top_p"] if "top_p" in parameters else top_p,
+                "context": parameters.get("context", context),
+                "prompt": parameters.get("prompt", prompt),
+                "history": parameters.get("history", history),
+                "temperature": parameters.get("temperature", temperature),
+                "max_tokens": parameters.get("max_tokens", max_tokens),
+                "top_p": parameters.get("top_p", top_p),
             }
         )
         payload = build_payload(data=data, parameters=parameters)
@@ -152,7 +154,7 @@ def run(
                 end = time.time()
                 response = {"status": "FAILED", "error": msg, "elapsed_time": end - start}
         return ModelResponse(
-            status=response.pop("status", ModelStatus.FAILED),
+            status=response.pop("status", ResponseStatus.FAILED),
             data=response.pop("data", ""),
             details=response.pop("details", {}),
             completed=response.pop("completed", False),
@@ -173,7 +175,7 @@ def run_async(
         max_tokens: int = 128,
         top_p: float = 1.0,
         name: Text = "model_process",
-        parameters: Optional[Dict] = {},
+        parameters: Optional[Dict] = None,
     ) -> ModelResponse:
         """Runs asynchronously a model call.
 
@@ -186,27 +188,29 @@ def run_async(
             max_tokens (int, optional): Maximum Generation Tokens. Defaults to 128.
             top_p (float, optional): Top P. Defaults to 1.0.
             name (Text, optional): ID given to a call. Defaults to "model_process".
-            parameters (Dict, optional): optional parameters to the model. Defaults to "{}".
+            parameters (Dict, optional): optional parameters to the model. Defaults to None.
 
         Returns:
             dict: polling URL in response
         """
         url = f"{self.url}/{self.id}"
         logging.debug(f"Model Run Async: Start service for {name} - {url}")
+        if parameters is None:
+            parameters = {}
         parameters.update(
             {
-                "context": parameters["context"] if "context" in parameters else context,
-                "prompt": parameters["prompt"] if "prompt" in parameters else prompt,
-                "history": parameters["history"] if "history" in parameters else history,
-                "temperature": parameters["temperature"] if "temperature" in parameters else temperature,
-                "max_tokens": parameters["max_tokens"] if "max_tokens" in parameters else max_tokens,
-                "top_p": parameters["top_p"] if "top_p" in parameters else top_p,
+                "context": parameters.get("context", context),
+                "prompt": parameters.get("prompt", prompt),
+                "history": parameters.get("history", history),
+                "temperature": parameters.get("temperature", temperature),
+                "max_tokens": parameters.get("max_tokens", max_tokens),
+                "top_p": parameters.get("top_p", top_p),
             }
         )
         payload = build_payload(data=data, parameters=parameters)
         response = call_run_endpoint(payload=payload, url=url, api_key=self.api_key)
         return ModelResponse(
-            status=response.pop("status", ModelStatus.FAILED),
+            status=response.pop("status", ResponseStatus.FAILED),
             data=response.pop("data", ""),
             details=response.pop("details", {}),
             completed=response.pop("completed", False),

aixplain/modules/model/response.py

@@ -1,15 +1,13 @@
-from dataclasses import dataclass
 from typing import Text, Any, Optional, Dict, List, Union
-from aixplain.enums import ModelStatus
+from aixplain.enums import ResponseStatus
 
 
-@dataclass
 class ModelResponse:
     """ModelResponse class to store the response of the model run."""
 
     def __init__(
         self,
-        status: ModelStatus,
+        status: ResponseStatus,
         data: Text = "",
         details: Optional[Union[Dict, List]] = {},
         completed: bool = False,

aixplain/modules/model/utils.py

@@ -3,12 +3,15 @@
 import json
 import logging
 from aixplain.utils.file_utils import _request_with_retry
-from typing import Dict, Text, Union
+from typing import Dict, Text, Union, Optional
 
 
-def build_payload(data: Union[Text, Dict], parameters: Dict = {}):
+def build_payload(data: Union[Text, Dict], parameters: Optional[Dict] = None):
     from aixplain.factories import FileFactory
 
+    if parameters is None:
+        parameters = {}
+
     data = FileFactory.to_link(data)
     if isinstance(data, dict):
         payload = data