craft-ai-sdk 0.58.0rc1__tar.gz → 0.59.0__tar.gz

{craft_ai_sdk-0.58.0rc1 → craft_ai_sdk-0.59.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: craft-ai-sdk
-Version: 0.58.0rc1
+Version: 0.59.0
 Summary: Craft AI MLOps platform SDK
 Home-page: https://www.craft.ai/
 License: Apache-2.0

{craft_ai_sdk-0.58.0rc1 → craft_ai_sdk-0.59.0}/craft_ai_sdk/__init__.py

@@ -14,4 +14,4 @@ from .io import (  # noqa: F401
 )
 
 
-__version__ = "0.58.0rc1"
+__version__ = "0.59.0"

{craft_ai_sdk-0.58.0rc1 → craft_ai_sdk-0.59.0}/craft_ai_sdk/core/deployments.py

@@ -3,7 +3,10 @@ from ..constants import (
     DEPLOYMENT_MODES,
     DEPLOYMENT_STATUS,
 )
-from ..io import InputSource, OutputDestination
+from ..io import (
+    _validate_inputs_mapping,
+    _validate_outputs_mapping,
+)
 from ..sdk import BaseCraftAiSdk
 from ..exceptions import SdkException
 from ..utils import (
@@ -11,6 +14,7 @@ from ..utils import (
     log_func_result,
     log_action,
     remove_keys_from_dict,
+    remove_none_values,
 )
 
 
@@ -22,6 +26,7 @@ def create_deployment(
     execution_rule,
     mode=DEPLOYMENT_MODES.ELASTIC,
     schedule=None,
+    endpoint_url_path=None,
     inputs_mapping=None,
     outputs_mapping=None,
     description=None,
@@ -89,6 +94,12 @@ def create_deployment(
                 * ``"0 0 5 * *"`` will execute the deployment every 5th day of
                   the month at midnight.
 
+        endpoint_url_path (:obj:`str`, optional): Applicable only if ``execution_rule``
+          is ``"endpoint"``. The last part of the URL (address) used to trigger the
+          endpoint deployment. See the note below on how to trigger the endpoint. By
+          default the value of ``deployment_name`` is used. This can be used to
+          customize the URL independently of ``deployment_name``.
+
         inputs_mapping(:obj:`list` of instances of :class:`InputSource`):
             List of input mappings, to map pipeline inputs to different
             sources (such as constant values, endpoint inputs, or environment
@@ -252,8 +263,9 @@ def create_deployment(
       When ``execution_rule`` is ``"endpoint"``:
 
         * When the endpoint deployment is created, it creates an HTTP endpoint which can
-          be called at ``POST {environment_url}/endpoints/{endpoint_name}``. You can get
-          `environment_url` with `sdk.base_environment_url`.
+          be called at ``POST {environment_url}/endpoints/{endpoint_url_path}``. You can
+          get `environment_url` with `sdk.base_environment_url`. `endpoint_url_path` is
+          the `endpoint_name` if `enpoint_url_path` is not provided.
         * Only one step input can be mapped to an endpoint as an
           ``"endpoint_input_name"`` if it is of type ``"file"``.
         * Only one step output can be mapped to an endpoint as an
@@ -353,34 +365,19 @@ def create_deployment(
         else:
             data["schedule"] = schedule
 
-    if inputs_mapping is not None:
-        if any(
-            [
-                not isinstance(input_mapping_, InputSource)
-                for input_mapping_ in inputs_mapping
-            ]
-        ):
-            raise ValueError("'inputs' must be a list of instances of InputSource.")
-        data["inputs_mapping"] = [
-            input_mapping_.to_dict() for input_mapping_ in inputs_mapping
-        ]
-
-    if outputs_mapping is not None:
-        if any(
-            [
-                not isinstance(output_mapping_, OutputDestination)
-                for output_mapping_ in outputs_mapping
-            ]
-        ):
+    if endpoint_url_path is not None:
+        if execution_rule != "endpoint":
             raise ValueError(
-                "'outputs' must be a list of instances of OutputDestination."
+                "'endpoint_url_path' can only be specified if 'execution_rule' is \
+'endpoint'."
             )
-        data["outputs_mapping"] = [
-            output_mapping_.to_dict() for output_mapping_ in outputs_mapping
-        ]
+        else:
+            data["endpoint_url_path"] = endpoint_url_path
 
-    # filter optional parameters
-    data = {k: v for k, v in data.items() if v is not None}
+    data["inputs_mapping"] = _validate_inputs_mapping(inputs_mapping)
+    data["outputs_mapping"] = _validate_outputs_mapping(outputs_mapping)
+
+    data = remove_none_values(data)
 
     log_action(
         sdk,
@@ -397,6 +394,14 @@ def create_deployment(
     )
 
 
+FINAL_DEPLOYMENT_STATUSES = [
+    DEPLOYMENT_STATUS.UP,
+    DEPLOYMENT_STATUS.CREATION_FAILED,
+    DEPLOYMENT_STATUS.DISABLED,
+    DEPLOYMENT_STATUS.STANDBY,
+]
+
+
 def get_deployment(
     sdk: BaseCraftAiSdk, deployment_name, wait_for_completion=False, timeout_s=None
 ):
@@ -521,10 +526,9 @@ def get_deployment(
         start_time = sdk._get_time()
         elapsed_time = 0
         deployment_status = DEPLOYMENT_STATUS.CREATION_PENDING
-        while deployment_status not in [
-            DEPLOYMENT_STATUS.UP,
-            DEPLOYMENT_STATUS.CREATION_FAILED,
-        ] and (timeout_s is None or elapsed_time < timeout_s):
+        while deployment_status not in FINAL_DEPLOYMENT_STATUSES and (
+            timeout_s is None or elapsed_time < timeout_s
+        ):
             deployment = sdk._get(
                 f"{base_url}?wait_for_completion=true", allow_redirects=False
             )
@@ -539,7 +543,7 @@ details.",
                 name="CreationFailedException",
             )
 
-        if deployment_status != DEPLOYMENT_STATUS.UP:
+        if deployment_status not in FINAL_DEPLOYMENT_STATUSES:
             raise SdkException(
                 'The deployment was not ready in time. It is still being created but \
 this function stopped trying. Please check its status with "get_deployment" with \
@@ -562,6 +566,68 @@ wait_for_completion parameter set to false.',
     return remove_keys_from_dict(deployment, {"is_archived", "id", "pipeline.id"})
 
 
+@log_func_result("Deployment update")
+def update_deployment(
+    sdk: BaseCraftAiSdk,
+    deployment_name,
+    is_enabled=None,
+    inputs_mapping=None,
+    outputs_mapping=None,
+    schedule=None,
+    wait_for_completion=True,
+    timeout_s=None,
+):
+    """Update the specified properties of a deployment. The properties that can be
+    updated include enabling/disabling the deployment, updating input/output values,
+    and changing the deployment schedule. Only one property can be updated at a time.
+
+    Args:
+        deployment_name (:obj:`str`): Name of the deployment to update.
+        is_enabled (:obj:`bool`, optional): Whether the deployment should be enabled
+          or disabled. Disabling a deployment prevents new executions from being
+          triggered. It also frees up computing resources associated to a low-latency
+          deployment. Defaults to `None`.
+        inputs_mapping(:obj:`list` of instances of :class:`InputSource`):
+          List of inputs mapping to update with keys `pipeline_input_name`, and
+          `constant_value` or `datastore_path`. The mapping types can not be changed;
+          only the values of constant values (`constant_value`) and data store paths
+          (`datastore_path`) can be updated. See :class:`InputSource` for more details.
+        outputs_mapping(:obj:`list` of instances of :class:`OutputDestination`):
+          List of outputs mapping to update with keys `pipeline_output_name` and
+          `datastore_path`. The mapping types can not be changed;
+          only the values of data store paths (`datastore_path`) can be updated.
+          See :class:`OutputDestination` for more details.
+        schedule (:obj:`str`, optional): New schedule to be assigned to the periodic
+          deployment. Must be a valid CRON expression. Defaults to `None`.
+
+    Returns:
+        :obj:`dict`: Deployment information represented as :obj:`dict` as described
+        in :func:`get_deployment`.
+    """
+    if timeout_s is not None and timeout_s <= 0:
+        raise ValueError("'timeout_s' must be greater than 0 or None.")
+
+    url = f"{sdk.base_environment_api_url}/deployments/{deployment_name}"
+
+    data = remove_none_values(
+        {
+            "is_enabled": is_enabled,
+            "schedule": schedule,
+            "inputs_mapping": _validate_inputs_mapping(inputs_mapping),
+            "outputs_mapping": _validate_outputs_mapping(outputs_mapping),
+        }
+    )
+
+    sdk._patch(url, json=data, allow_redirects=False)
+
+    return get_deployment(
+        sdk,
+        deployment_name,
+        wait_for_completion=wait_for_completion,
+        timeout_s=timeout_s,
+    )
+
+
 def get_deployment_logs(
     sdk: BaseCraftAiSdk,
     deployment_name,

{craft_ai_sdk-0.58.0rc1 → craft_ai_sdk-0.59.0}/craft_ai_sdk/core/endpoints.py

@@ -4,6 +4,16 @@ from urllib.parse import urlencode
 
 from ..utils import log_func_result, handle_http_response
 from ..sdk import BaseCraftAiSdk
+from .deployments import get_deployment
+
+
+def _get_endpoint_url_path(sdk: BaseCraftAiSdk, endpoint_name):
+    deployment = get_deployment(sdk, endpoint_name)
+
+    if deployment.get("execution_rule", "") != "endpoint":
+        raise ValueError(f"Deployment {endpoint_name} is not an endpoint deployment")
+
+    return deployment.get("endpoint_url_path", "")
 
 
 @log_func_result("Endpoint trigger")
@@ -38,6 +48,7 @@ def trigger_endpoint(
           output names as keys and corresponding values as values. Note that this
           key is only returned if ``wait_for_completion`` is `True`.
     """
+    endpoint_url_path = _get_endpoint_url_path(sdk, endpoint_name)
 
     body = {}
     files = {}
@@ -47,7 +58,7 @@ def trigger_endpoint(
         else:
             body[input_name] = input_value
 
-    url = f"{sdk.base_environment_url}/endpoints/{endpoint_name}"
+    url = f"{sdk.base_environment_url}/endpoints/{endpoint_url_path}"
     post_result = requests.post(
         url,
         headers={
@@ -62,14 +73,20 @@ def trigger_endpoint(
     execution_id = post_result.headers.get("Craft-Ai-Execution-Id", "")
     if wait_for_completion and 200 <= post_result.status_code < 400:
         return retrieve_endpoint_results(
-            sdk, endpoint_name, execution_id, endpoint_token
+            sdk,
+            endpoint_name,
+            execution_id,
+            endpoint_token,
         )
     return {"execution_id": execution_id}
 
 
 @log_func_result("Endpoint result retrieval")
 def retrieve_endpoint_results(
-    sdk: BaseCraftAiSdk, endpoint_name, execution_id, endpoint_token
+    sdk: BaseCraftAiSdk,
+    endpoint_name,
+    execution_id,
+    endpoint_token,
 ):
     """Get the results of an endpoint execution.
 
@@ -86,10 +103,11 @@ def retrieve_endpoint_results(
         * ``"outputs"`` (:obj:`dict`): Dictionary of outputs of the pipeline with
           output names as keys and corresponding values as values.
     """
+    endpoint_url_path = _get_endpoint_url_path(sdk, endpoint_name)
 
     url = (
         f"{sdk.base_environment_url}"
-        f"/endpoints/{endpoint_name}/executions/{execution_id}"
+        f"/endpoints/{endpoint_url_path}/executions/{execution_id}"
     )
     query = urlencode({"token": endpoint_token})
     response = requests.get(f"{url}?{query}")

{craft_ai_sdk-0.58.0rc1 → craft_ai_sdk-0.59.0}/craft_ai_sdk/core/pipeline_executions.py

@@ -5,10 +5,10 @@ import io
 from ..exceptions import SdkException
 from ..io import (
     INPUT_OUTPUT_TYPES,
-    InputSource,
-    OutputDestination,
     _format_execution_output,
     _format_execution_input,
+    _validate_inputs_mapping,
+    _validate_outputs_mapping,
 )
 from ..sdk import BaseCraftAiSdk
 from ..utils import (
@@ -85,33 +85,14 @@ value is not a string or bytes"
         elif input_types.get(input_name) != INPUT_OUTPUT_TYPES.FILE:
             data["json_inputs"][input_name] = input_value
     data["json_inputs"] = json.dumps(data["json_inputs"])
+
+    _inputs_mapping = _validate_inputs_mapping(inputs_mapping)
     if inputs_mapping is not None:
-        if any(
-            [
-                not isinstance(input_mapping_, InputSource)
-                for input_mapping_ in inputs_mapping
-            ]
-        ):
-            raise ValueError(
-                "'inputs_mapping' must be a list of instances of InputSource."
-            )
-        data["inputs_mapping"] = json.dumps(
-            [input_mapping_.to_dict() for input_mapping_ in inputs_mapping]
-        )
+        data["inputs_mapping"] = json.dumps(_inputs_mapping)
+
+    _outputs_mapping = _validate_outputs_mapping(outputs_mapping)
     if outputs_mapping is not None:
-        if any(
-            [
-                not isinstance(output_mapping_, OutputDestination)
-                for output_mapping_ in outputs_mapping
-            ]
-        ):
-            raise ValueError(
-                "'outputs_mapping' must be a list of instances of \
-OutputDestination."
-            )
-        data["outputs_mapping"] = json.dumps(
-            [output_mapping_.to_dict() for output_mapping_ in outputs_mapping]
-        )
+        data["outputs_mapping"] = json.dumps(_outputs_mapping)
 
     # Execute pipeline
     url = f"{sdk.base_environment_api_url}/pipelines/{pipeline_name}/run"

{craft_ai_sdk-0.58.0rc1 → craft_ai_sdk-0.59.0}/craft_ai_sdk/io.py

@@ -288,3 +288,26 @@ def _format_execution_input(name, input):
         "source": input["mapping_type"],
         "value": input["value"],
     }
+
+
+def _validate_inputs_mapping(inputs_mapping):
+    if inputs_mapping is None:
+        return None
+    if any(
+        not isinstance(input_mapping_, InputSource) for input_mapping_ in inputs_mapping
+    ):
+        raise ValueError("'inputs_mapping' must be a list of instances of InputSource.")
+    return [input_mapping_.to_dict() for input_mapping_ in inputs_mapping]
+
+
+def _validate_outputs_mapping(outputs_mapping):
+    if outputs_mapping is None:
+        return None
+    if any(
+        not isinstance(output_mapping_, OutputDestination)
+        for output_mapping_ in outputs_mapping
+    ):
+        raise ValueError(
+            "'outputs_mapping' must be a list of instances of OutputDestination."
+        )
+    return [output_mapping_.to_dict() for output_mapping_ in outputs_mapping]

{craft_ai_sdk-0.58.0rc1 → craft_ai_sdk-0.59.0}/craft_ai_sdk/sdk.py

@@ -34,6 +34,10 @@ class BaseCraftAiSdk(ABC):
     def _put(self, url, data=None, params=None, files=None, **kwargs):
         pass
 
+    @abstractmethod
+    def _patch(self, url, data=None, params=None, files=None, **kwargs):
+        pass
+
     @abstractmethod
     def _delete(self, url, **kwargs):
         pass
@@ -83,6 +87,7 @@ class CraftAiSdk(BaseCraftAiSdk):
         get_deployment,
         get_deployment_logs,
         list_deployments,
+        update_deployment,
         delete_deployment,
     )
     from .core.endpoints import (
@@ -130,7 +135,7 @@ class CraftAiSdk(BaseCraftAiSdk):
         os.environ.get("CRAFT_AI__MULTIPART_PART_SIZE__B", str(38 * 256 * 1024))
     )
     _access_token_margin = timedelta(seconds=30)
-    _version = "0.58.0rc1"  # Would be better to share it somewhere
+    _version = "0.59.0"  # Would be better to share it somewhere
 
     def __init__(
         self,
@@ -249,6 +254,17 @@ class CraftAiSdk(BaseCraftAiSdk):
             **kwargs,
         )
 
+    @handle_http_request
+    @use_authentication
+    def _patch(self, url, data=None, params=None, files=None, **kwargs):
+        return self._session.patch(
+            url,
+            data=data,
+            params=params,
+            files=files,
+            **kwargs,
+        )
+
     @handle_http_request
     @use_authentication
     def _delete(self, url, **kwargs):

{craft_ai_sdk-0.58.0rc1 → craft_ai_sdk-0.59.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "craft-ai-sdk"
-version = "0.58.0rc1"
+version = "0.59.0"
 description = "Craft AI MLOps platform SDK"
 license = "Apache-2.0"
 authors = ["Craft AI <contact@craft.ai>"]