craft-ai-sdk 0.65.3__py3-none-any.whl → 0.66.0__py3-none-any.whl

craft_ai_sdk/__init__.py

@@ -13,4 +13,4 @@ from .io import (  # noqa: F401
 )
 from .sdk import CraftAiSdk  # noqa: F401
 
-__version__ = "0.65.3"
+__version__ = "0.66.0"

craft_ai_sdk/core/deployments.py

@@ -115,6 +115,7 @@ def create_deployment(
     wait_for_completion=True,
     timeout_s: Union[int, None] = None,
     execution_timeout_s: Union[int, None] = None,
+    endpoint_token: Union[str, None] = None,
 ):
     """Create a deployment associated with a given pipeline.
 
@@ -241,6 +242,11 @@ def create_deployment(
         timeout_s (:obj:`int`): Maximum time (in seconds) to wait for the deployment to
             be ready. Set to None to wait indefinitely. Defaults to None.
             Only applicable if ``wait_for_completion`` is ``True``.
+        endpoint_token (:obj:`str`, optional): Applicable only if ``execution_rule``
+          is ``"endpoint"``. The token to access the endpoint. If not set, a token
+          will be generated. This token is different from the SDK token, you can find it
+          in the result of this function as "endpoint_token". It is used as a secret
+          to trigger the endpoint.
 
     Returns:
         :obj:`dict[str, str]`: Created deployment represented as a dict with the
@@ -449,6 +455,14 @@ def create_deployment(
             )
         else:
             data["endpoint_url_path"] = endpoint_url_path
+    if endpoint_token is not None:
+        if execution_rule != "endpoint":
+            raise ValueError(
+                "'endpoint_token' can only be specified if 'execution_rule' is \
+'endpoint'."
+            )
+        else:
+            data["endpoint_token"] = endpoint_token
 
     data["inputs_mapping"] = _validate_inputs_mapping(inputs_mapping)
     data["outputs_mapping"] = _validate_outputs_mapping(outputs_mapping)

craft_ai_sdk/core/endpoints.py

@@ -4,6 +4,8 @@ from urllib.parse import urlencode
 
 import requests
 
+from craft_ai_sdk.utils.dict_utils import remove_none_values
+
 from ..sdk import BaseCraftAiSdk
 from ..shared.authentication import use_authentication
 from ..shared.logger import log_func_result
@@ -204,12 +206,14 @@ def retrieve_endpoint_results(
 
 
 def generate_new_endpoint_token(
-    sdk: BaseCraftAiSdk, endpoint_name: str
+    sdk: BaseCraftAiSdk, endpoint_name: str, endpoint_token: Union[str, None] = None
 ) -> EndpointNewToken:
     """Generate a new endpoint token for an endpoint.
 
     Args:
         endpoint_name (:obj:`str`): Name of the endpoint.
+        endpoint_token (:obj:`str`, optional): New endpoint token to set. If not set,
+            a new token will be generated.
 
     Returns:
         :obj:`dict[str, str]`: New endpoint token represented as :obj:`dict` with
@@ -218,4 +222,4 @@ def generate_new_endpoint_token(
         * ``"endpoint_token"`` (:obj:`str`): New endpoint token.
     """
     url = f"{sdk.base_environment_api_url}/endpoints/{endpoint_name}/generate-new-token"
-    return sdk._post(url)
+    return sdk._post(url, data=remove_none_values({"endpoint_token": endpoint_token}))

craft_ai_sdk/io.py

@@ -1,4 +1,3 @@
-import warnings
 from typing import Any, TypedDict, cast
 
 from strenum import LowercaseStrEnum
@@ -19,19 +18,19 @@ class INPUT_OUTPUT_TYPES(LowercaseStrEnum):
 
 
 class Input:
-    """Class to specify a step input when creating a step
-    (cf. :meth:`.CraftAiSdk.create_step`).
+    """Class to specify a pipeline input when creating a pipeline
+    (cf. :meth:`.CraftAiSdk.create_pipeline`).
 
     Args:
         name (:obj:`str`): Name of the input. This corresponds to the name of a
-            parameter of a step function.
+            parameter of a pipeline function.
         data_type (:obj:`str`): Type of the input: It could be one of "string",
             "number","boolean", "json", "array" or "file". For convenience, members of
             the enumeration :class:`INPUT_OUTPUT_TYPES` could be used too.
         description (:obj:`str`, optional): Description. Defaults to None.
         is_required (:obj:`bool`, optional): Specify if an value should be provided at
             execution time. Defaults to None.
-        default_value (:obj:`Any`, optional): A default value for the step input at
+        default_value (:obj:`Any`, optional): A default value for the pipeline input at
             execution time. The type for `default_value` should match the type specified
             by `data_type`. Defaults to None.
     """
@@ -57,12 +56,12 @@ class Input:
 
 
 class Output:
-    """Class to specify a step output when creating a step
-    (cf. :meth:`.CraftAiSdk.create_step`).
+    """Class to specify a pipeline output when creating a pipeline
+    (cf. :meth:`.CraftAiSdk.create_pipeline`).
 
     Args:
         name (:obj:`str`): Name of the output. This corresponds to the key of the `dict`
-            returned by the step function.
+            returned by the pipeline function.
         data_type (:obj:`str`): Type of the output. It could be one of "string",
             "number", "boolean", "json", "array" or "file". For convenience, members of
             the enumeration :class:`INPUT_OUTPUT_TYPES` could be used too.
@@ -97,7 +96,7 @@ class InputSourceDict(TypedDict):
 
 
 class InputSource:
-    """Class to specify to which source a step input should be mapped when creating
+    """Class to specify to which source a pipeline input should be mapped when creating
     a deployment (cf. :meth:`.CraftAiSdk.create_deployment`). The different sources can
     be one of:
 
@@ -125,16 +124,16 @@ class InputSource:
             value at execution time.
         datastore_path (:obj:`str`, optional): Path of the input file in the datastore.
             If you want to use a file from the datastore as input, this file will then
-            be accessible as if you passed the file path as an argument to the step.
+            be accessible as if you passed the file path as an argument to the pipeline.
             The resulting input will be a :obj:`dict` with `"path"` as key and the
             file path as value. The file will be downloaded in the execution environment
-            before the step is executed. You can then use the file as you would use any
-            other file in the execution environment. Here is an example of how to use
-            this feature in the step code:
+            before the pipeline is executed. You can then use the file as you would
+            use any other file in the execution environment. Here is an example of
+            how to use this feature in the pipeline code:
 
             .. code-block:: python
 
-                def step_function(input):
+                def pipeline_function(input):
                     with open(input["path"]) as f:
                         content = f.read()
                         print(content)
@@ -156,21 +155,7 @@ class InputSource:
         constant_value=None,
         is_null=None,
         datastore_path=None,
-        step_input_name=None,
     ):
-        if pipeline_input_name is not None and step_input_name is not None:
-            raise ValueError(
-                "Both pipeline_input_name and step_input_name cannot be specified."
-            )
-        if pipeline_input_name is None and step_input_name is None:
-            raise ValueError('missing "pipeline_input_name" argument.')
-        if step_input_name is not None:
-            warnings.warn(
-                "Providing the step_input_name argument is deprecated and will "
-                "be removed in a future version. Please use the pipeline_input_name keyword argument instead.",  # noqa: E501
-                FutureWarning,
-                stacklevel=2,
-            )
         self.pipeline_input_name = pipeline_input_name
         self.endpoint_input_name = endpoint_input_name
         self.environment_variable_name = environment_variable_name
@@ -179,7 +164,6 @@ class InputSource:
         self.constant_value = constant_value
         self.is_null = is_null
         self.datastore_path = datastore_path
-        self.step_input_name = step_input_name
 
     def to_dict(self) -> InputSourceDict:
         input_mapping_dict = {
@@ -191,7 +175,6 @@ class InputSource:
             "constant_value": self.constant_value,
             "is_null": self.is_null,
             "datastore_path": self.datastore_path,
-            "step_input_name": self.step_input_name,
         }
 
         return cast(InputSourceDict, remove_none_values(input_mapping_dict))
@@ -202,11 +185,10 @@ class OutputDestinationDict(TypedDict):
     endpoint_output_name: NotRequired[str]
     is_null: NotRequired[bool]
     datastore_path: NotRequired[str]
-    step_output_name: NotRequired[str]
 
 
 class OutputDestination:
-    """Class to specify to which destination a step output should be mapped when
+    """Class to specify to which destination a pipeline output should be mapped when
     creating a deployment (cf. :meth:`.CraftAiSdk.create_deployment`). If the execution
     rule of the deployment is endpoint, an output could either be exposed as an output
     of the endpoint (via `endpoint_output_name` parameter) or not (via `is_null`
@@ -221,16 +203,17 @@ class OutputDestination:
             deployment output.
         datastore_path (:obj:`str`, optional): Path of the output file in the datastore.
             If you want to upload a file to the datastore as output, you can specify
-            this parameter. The file will be uploaded to the datastore after the step
-            is executed. In order to pass the file to be uploaded in the datastore, you
-            will have to do the same as if you were passing a file as output. You will
-            have to return a :obj:`dict` with `"path"` as key and the file path as
-            value. The file will be uploaded to the datastore after the step is
-            executed. Here is an example of how to use this feature in the step code:
+            this parameter. The file will be uploaded to the datastore after the
+            pipeline is executed. In order to pass the file to be uploaded in the
+            datastore, you will have to do the same as if you were passing a file
+            as output. You will have to return a :obj:`dict` with `"path"` as key
+            and the file path as value. The file will be uploaded to the datastore
+            after the pipeline is executed. Here is an example of how to use this
+            feature in the pipeline code:
 
             .. code-block:: python
 
-                def step_function():
+                def pipeline_function():
                     file_path = "path/to/file"
                     with open(file_path, "w") as f:
                         f.write("content")
@@ -253,26 +236,11 @@ class OutputDestination:
         endpoint_output_name=None,
         is_null=None,
         datastore_path=None,
-        step_output_name=None,
     ):
-        if pipeline_output_name is not None and step_output_name is not None:
-            raise ValueError(
-                "Both pipeline_output_name and step_output_name cannot be specified."
-            )
-        if pipeline_output_name is None and step_output_name is None:
-            raise ValueError('missing "pipeline_output_name" argument.')
-        if step_output_name is not None:
-            warnings.warn(
-                "Providing the 'step_output_name' argument is deprecated and will "
-                "be removed in a future version. Please use the 'pipeline_output_name' keyword argument instead.",  # noqa: E501
-                FutureWarning,
-                stacklevel=2,
-            )
         self.pipeline_output_name = pipeline_output_name
         self.endpoint_output_name = endpoint_output_name
         self.is_null = is_null
         self.datastore_path = datastore_path
-        self.step_output_name = step_output_name
 
     def to_dict(self) -> OutputDestinationDict:
         output_mapping_dict = {
@@ -280,7 +248,6 @@ class OutputDestination:
             "endpoint_output_name": self.endpoint_output_name,
             "is_null": self.is_null,
             "datastore_path": self.datastore_path,
-            "step_output_name": self.step_output_name,
         }
 
         return cast(OutputDestinationDict, remove_none_values(output_mapping_dict))

craft_ai_sdk/sdk.py

@@ -138,7 +138,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.65.3"  # Would be better to share it somewhere
+    _version = "0.66.0"  # Would be better to share it somewhere
 
     def __init__(
         self,

{craft_ai_sdk-0.65.3.dist-info → craft_ai_sdk-0.66.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: craft-ai-sdk
-Version: 0.65.3
+Version: 0.66.0
 Summary: Craft AI MLOps platform SDK
 License: Apache-2.0
 Author: Craft AI

{craft_ai_sdk-0.65.3.dist-info → craft_ai_sdk-0.66.0.dist-info}/RECORD

@@ -1,8 +1,8 @@
-craft_ai_sdk/__init__.py,sha256=ihzipaTQTB6IBVmQA5o4Pl_vAND4Fv8tHTXbgxspNds,363
+craft_ai_sdk/__init__.py,sha256=veuzN4isifu8Hhhi6X3JJy6t5zCuJmvf7cogoeNkfWY,363
 craft_ai_sdk/constants.py,sha256=rH4JrGlTpbjjjNRrKhk5oScbj5G5INrcVza6Bb6kIzY,980
 craft_ai_sdk/core/data_store.py,sha256=dlVZajXGwcI_4mzqFctHpzKO-uySIP5lvQaJy6CKwY0,9131
-craft_ai_sdk/core/deployments.py,sha256=8IijSJjomEtiLNeYgVuwMKqqs3MD5rCMqoGKOYHGOtc,36915
-craft_ai_sdk/core/endpoints.py,sha256=nZgkxM69cJjLpO8GHgT-yat5DkGvi2s0AfOKYbN7F7w,7355
+craft_ai_sdk/core/deployments.py,sha256=O4JjH8CjfA4Dy-Y7H_ABVEPS3TbMhO9j66F2mKf22K4,37617
+craft_ai_sdk/core/endpoints.py,sha256=smNLSDG4T6ZMNyu494Ip52SURBOqmmx3oSWtz8GzCCc,7648
 craft_ai_sdk/core/environment_variables.py,sha256=CpkyneLf8UF-1QXe36Ay_RZJ8grSfbZZWBvGSQzKlLs,2221
 craft_ai_sdk/core/pipeline_executions.py,sha256=p_vjsOMR92_6UUG5S-pgyen3V7yYHTjHBJ7pNfANe5I,18661
 craft_ai_sdk/core/pipeline_metrics.py,sha256=IJFzAptwqjanb2Jl-XQCh0FtashEd4I2Pb51ky51cyY,7166
@@ -12,8 +12,8 @@ craft_ai_sdk/core/steps.py,sha256=JptHia3zHRdbQ-lXxg-aCgoN2S2L10AxU8D3A2Mlxl0,23
 craft_ai_sdk/core/users.py,sha256=q5et87q0SOMpRTBOiLX026oaEOTaY1aGqKdbUC51zbA,618
 craft_ai_sdk/core/vector_database.py,sha256=S3h68Ej1FnHYJdc5LdLlNjobYYdmaCloSq2UaylPWko,2334
 craft_ai_sdk/exceptions.py,sha256=IC-JfZmmmaTsbMCgirOEByRmWnatQLjKe8BErRkuwM0,1075
-craft_ai_sdk/io.py,sha256=jeCH5nVBpaSPX3SRwj6UahhOw9z52iRTqDgX6DuSEkY,13468
-craft_ai_sdk/sdk.py,sha256=YIXMPWabAwOSa54qxvgFYA5u8ElRTJ_Xu6FNlL_bJBE,10812
+craft_ai_sdk/io.py,sha256=x1G7ga10W_SeTDLHe-FrhU26_WNwWW32-yprMmCZ5Ck,11836
+craft_ai_sdk/sdk.py,sha256=m3eZtexqGPqdfJA2zIfjzd0qQG81YFE5ncG_Dc7lDHs,10812
 craft_ai_sdk/shared/authentication.py,sha256=OdwtAH47tOUS-u_HhxlI8JdjZT5REr5B5cGSrX7sz00,885
 craft_ai_sdk/shared/environments.py,sha256=LbpRK-ACpwFfN7WTuo0nrtbbi2NAXhuMRKf7YkktEYI,510
 craft_ai_sdk/shared/execution_context.py,sha256=B2Ghq-wiUvq81q5mhsm79Oc59c8c00uQxMIpApFD03o,585
@@ -26,8 +26,8 @@ craft_ai_sdk/utils/__init__.py,sha256=A0sLCXSPD1Z3q2GP1uLDjvif4ivOr__Hzg9RQysEuq
 craft_ai_sdk/utils/datetime_utils.py,sha256=yYP5HVdI879WXxQCajPTnas1pWrwInOxMux-mxqQNQM,734
 craft_ai_sdk/utils/dict_utils.py,sha256=1HQ3A14SN48XPFDmQleujGAgksmkjIs3hyPLpwhwh24,748
 craft_ai_sdk/utils/file_utils.py,sha256=o10-CDt4qzgCJNPykvlNrL6WTouhVLY8C8BVpHJYt18,2795
-craft_ai_sdk-0.65.3.dist-info/LICENSE,sha256=_2oYRJic9lZK05LceuJ9aZZw5mPHYc1WQhJiVS-oGFU,10754
-craft_ai_sdk-0.65.3.dist-info/METADATA,sha256=OcxCuOinh8qkU4GaVfBzVX4xK2mBniL6p4v_DmhOxRg,1676
-craft_ai_sdk-0.65.3.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-craft_ai_sdk-0.65.3.dist-info/entry_points.txt,sha256=QC96WcXvvUfLMRgFD-l_y7_TgC9SqZybLs9EQ8dsGiQ,417
-craft_ai_sdk-0.65.3.dist-info/RECORD,,
+craft_ai_sdk-0.66.0.dist-info/LICENSE,sha256=_2oYRJic9lZK05LceuJ9aZZw5mPHYc1WQhJiVS-oGFU,10754
+craft_ai_sdk-0.66.0.dist-info/METADATA,sha256=2BLk5MjWIqsFg3bIdXnyeRMP5bibtaQ_xF4_m_zpePM,1676
+craft_ai_sdk-0.66.0.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+craft_ai_sdk-0.66.0.dist-info/entry_points.txt,sha256=QC96WcXvvUfLMRgFD-l_y7_TgC9SqZybLs9EQ8dsGiQ,417
+craft_ai_sdk-0.66.0.dist-info/RECORD,,