unitypredict 1.1.47__tar.gz → 1.1.48__tar.gz

{unitypredict-1.1.47 → unitypredict-1.1.48}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unitypredict
-Version: 1.1.47
+Version: 1.1.48
 Summary:  
 Home-page: https://unitypredict.com
 Author: UnityPredict

{unitypredict-1.1.47 → unitypredict-1.1.48}/unitypredict/UnityPredictClient.py

@@ -7,6 +7,15 @@ import time
 import requests
 
 class UnityPredictFileTransmitDto:
+
+    """
+    Represents a file to be transmitted to the UnityPredict API.
+
+    Attributes:
+        FileName (str): The name of the file.
+        FileHandle (IOBase): The IOBase is a byte stream representation for the file content. This is commonly created by using the python io library's 'open' function.
+    """
+
     FileName: str = ''
     FileHandle: IOBase = None
 
@@ -15,6 +24,15 @@ class UnityPredictFileTransmitDto:
         self.FileHandle = fileHandle
 
 class UnityPredictFileReceivedDto:
+    
+    """
+    Represents a file received from the UnityPredict API.
+
+    Attributes:
+        FileName (str): The name of the file.
+        LocalFilePath (str): The local path where the file was saved.
+    """
+    
     FileName: str = ''
     LocalFilePath: str = ''
 
@@ -23,6 +41,17 @@ class UnityPredictFileReceivedDto:
         self.LocalFilePath = localFilePath
 
 class UnityPredictRequest:
+
+    """
+    Represents a UnityPredict request.
+
+    Attributes:
+        ContextId (str): An optional context ID for the request.
+        InputValues (dict): A dictionary of input values for the model, where the key is the input variable name and the value of the variable's value.
+        DesiredOutcomes (list): A list of desired output variable names.
+        OutputFolderPath (str): The target path for saving model's output files (this is optional/not used if the model doesn't produce any output files).
+    """
+
     ContextId: str = ''
     InputValues: dict
     DesiredOutcomes: list
@@ -36,6 +65,19 @@ class UnityPredictRequest:
 
     
 class UnityPredictResponse:
+
+    """
+    Represents a response from the UnityPredict API.
+
+    Attributes:
+        ContextId (str): The ID of the request context.
+        RequestId (str): The ID of the request.
+        ErrorMessages (str): Error messages, if any.
+        ComputeCost (float): The estimated compute cost of the request.
+        Outcomes (dict): A dictionary containing the processed output values, including file details if applicable.
+        Status (str|None): The current status of the request (e.g., "Processing", "Completed", "Error" or None).
+    """
+
     ContextId: str = ''
     RequestId: str = ''
     ErrorMessages: str = ''
@@ -45,18 +87,31 @@ class UnityPredictResponse:
     Status: str|None = None
         
 class UnityPredictClient:
+
+    """
+    A client class for interacting with the UnityPredict API.
+
+    Attributes:
+        ApiKey (str): The API key for authentication.
+        ApiBaseUrl (str): The base URL of the UnityPredict API.
+        ApiMaxTimeout (int): The maximum wait time (in seconds) for synchronous responses.
+    """
+
     ApiKey: str = ''
     ApiBaseUrl: str = 'https://api.prod.unitypredict.com/api'
     ApiMaxTimeout: int = 12 * 60 * 60
 
-    # Async Variables
-    _asyncResult: UnityPredictResponse = None
-    _asyncResponseJson: any = {}
-
     def __init__(self, apiKey, apiMaxTimeoutInSec = 12 * 60 * 60):
+        
+        """
+        Initializes a UnityPredictClient instance.
+
+        Args:
+            apiKey (str): The UnityPredict API key for authentication.
+            apiMaxTimeoutInSec (int, optional): The maximum wait time (in seconds) for synchronous responses. Defaults to 12 hours.
+        """
         self.ApiKey = f"APIKEY@{apiKey}"
         self.ApiMaxTimeout = apiMaxTimeoutInSec
-        self._asyncResult = UnityPredictResponse()
 
 
 
@@ -198,6 +253,18 @@ class UnityPredictClient:
     
     
     def Predict(self, modelId: str, request: UnityPredictRequest) -> UnityPredictResponse:
+            
+            """
+            Sends a synchronous prediction request to the UnityPredict API.
+
+            Args:
+                modelId (str): The ID of the model to use for prediction.
+                request (UnityPredictRequest): The prediction request object, containing input values, desired outcomes, and output folder path.
+
+            Returns:
+                UnityPredictResponse: The response from the UnityPredict API, containing the results and status.
+            """
+            
             results = UnityPredictResponse()
 
             apiKey = self.ApiKey
@@ -258,12 +325,18 @@ class UnityPredictClient:
 
             return results
     
-    def AsyncPredict(self, modelId: str, request: UnityPredictRequest):
+    def AsyncPredict(self, modelId: str, request: UnityPredictRequest) -> UnityPredictResponse:
 
-        ##### 
-        # The request can contain file objects so we need to change those to file names before sending out
-        #####
-        # first get a list of file that we'll need to upload later & update the POST obj
+        """
+        Initiates an asynchronous inference for the specified model. The function will return the response with a RequestId and Status = 'Processing'. Use the 'GetRequestStatus' function with the returned RequestId to check on the status of the run and retrieve the results.
+
+        Args:
+            modelId (str): The Model Id of the specific model you want to invoke.
+            request (UnityPredictRequest): The inference request of type UnityPredictRequest, containing input values, desired outputs variables, and an (optional) OutputFolderPath for use with models that generate output files.
+
+        Returns:
+            UnityPredictResponse: The initial response from the API, containing the request ID and status.
+        """
 
         try:
         
@@ -294,7 +367,19 @@ class UnityPredictClient:
             return results
         
     
-    def GetRequestStatus(self, requestId: str, outputFolderPath: str = ""):
+    def GetRequestStatus(self, requestId: str, outputFolderPath: str = "") -> UnityPredictResponse:
+
+
+        """
+        Retrieves the status of an asynchronous prediction request.
+
+        Args:
+            requestId (str): The ID of the asynchronous request.
+            outputFolderPath (str, optional): The output folder path for saving results. Defaults to an empty string.
+
+        Returns:
+            UnityPredictResponse: The updated response with the current status and results, if available.
+        """
 
         apiKey = self.ApiKey
         apiBaseUrl = self.ApiBaseUrl

{unitypredict-1.1.47 → unitypredict-1.1.48}/unitypredict.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unitypredict
-Version: 1.1.47
+Version: 1.1.48
 Summary:  
 Home-page: https://unitypredict.com
 Author: UnityPredict