dataiku-api-client 14.4.2__tar.gz → 14.4.4__tar.gz

{dataiku_api_client-14.4.2 → dataiku_api_client-14.4.4}/HISTORY.txt

@@ -2,6 +2,18 @@ Changelog
 ==========
 
 
+14.4.4 (2026-04-15)
+-------------------
+
+* Initial release for DSS 14.4.4
+
+
+14.4.3 (2026-03-19)
+-------------------
+
+* Initial release for DSS 14.4.3
+
+
 14.4.2 (2026-03-06)
 -------------------
 

{dataiku_api_client-14.4.2/dataiku_api_client.egg-info → dataiku_api_client-14.4.4}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: dataiku-api-client
-Version: 14.4.2
+Version: 14.4.4
 Summary: Python API client for Dataiku APIs
 Home-page: https://www.dataiku.com
-Download-URL: https://github.com/dataiku/dataiku-api-client-python/tarball/14.4.2
+Download-URL: https://github.com/dataiku/dataiku-api-client-python/tarball/14.4.4
 Author: Dataiku
 Author-email: support@dataiku.com
 License: Apache Software License
@@ -36,6 +36,18 @@ Changelog
 ==========
 
 
+14.4.4 (2026-04-15)
+-------------------
+
+* Initial release for DSS 14.4.4
+
+
+14.4.3 (2026-03-19)
+-------------------
+
+* Initial release for DSS 14.4.3
+
+
 14.4.2 (2026-03-06)
 -------------------
 

{dataiku_api_client-14.4.2 → dataiku_api_client-14.4.4/dataiku_api_client.egg-info}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: dataiku-api-client
-Version: 14.4.2
+Version: 14.4.4
 Summary: Python API client for Dataiku APIs
 Home-page: https://www.dataiku.com
-Download-URL: https://github.com/dataiku/dataiku-api-client-python/tarball/14.4.2
+Download-URL: https://github.com/dataiku/dataiku-api-client-python/tarball/14.4.4
 Author: Dataiku
 Author-email: support@dataiku.com
 License: Apache Software License
@@ -36,6 +36,18 @@ Changelog
 ==========
 
 
+14.4.4 (2026-04-15)
+-------------------
+
+* Initial release for DSS 14.4.4
+
+
+14.4.3 (2026-03-19)
+-------------------
+
+* Initial release for DSS 14.4.3
+
+
 14.4.2 (2026-03-06)
 -------------------
 

{dataiku_api_client-14.4.2 → dataiku_api_client-14.4.4}/dataikuapi/dss/document_extractor.py

@@ -1,10 +1,11 @@
 import base64
-
 import copy
 import json
+import warnings
 
 from dataikuapi.utils import _write_response_content_to_file
 
+
 class DocumentExtractor(object):
     """
     A handle to interact with a DSS-managed Document Extractor.
@@ -51,14 +52,14 @@ class DocumentExtractor(object):
             extractor_request["inputs"] = {
                 "imagesRef": {
                     "type": images[0].type,
-                    "inlineImages": [ir.as_json() for ir in images]
+                    "inlineImages": [ir.as_dict() for ir in images]
                 }
             }
         elif all(isinstance(ir, ManagedFolderImageRef) for ir in images):
             extractor_request["inputs"] = {
                 "imagesRef": {
                     "type": images[0].type,
-                    "managedFolderId": images[0].managed_folder_id,
+                    "managedFolderRef": images[0].managed_folder_ref,
                     "imagesPaths": [ir.image_path for ir in images]
                 }
             }
@@ -102,12 +103,12 @@ class DocumentExtractor(object):
 
         extractor_request = {
             "inputs": {
-                "document": document.as_json()
+                "document": document.as_dict()
             },
             "settings": {
                 "maxSectionDepth": max_section_depth,
                 "imageValidation": image_validation,
-                "outputManagedFolderId": output_managed_folder,
+                "outputManagedFolderRef": output_managed_folder,
             }
         }
         if image_handling_mode == "IGNORE":
@@ -164,7 +165,7 @@ class DocumentExtractor(object):
 
         extractor_request = {
             "inputs": {
-                "document": document.as_json()
+                "document": document.as_dict()
             },
             "settings": {
             }
@@ -212,7 +213,7 @@ class DocumentExtractor(object):
             for idx, screenshot in enumerate(response):
                 if (idx % fetch_size == 0) and idx != 0:
                     print(f"Computing the next {fetch_size} screenshots")
-                print(f"Screenshot #{idx}: {screenshot.as_json()}")
+                print(f"Screenshot #{idx}: {screenshot.as_dict()}")
 
             # Alternatively, response being an iterable, you can compute & fetch all screenshots at once:
             response = doc_extractor.generate_pages_screenshots(document_ref)
@@ -275,12 +276,30 @@ class ScreenshotterRequest(object):
         self.fetch_size = fetch_size
 
     def as_json(self):
+        """
+        Get a dictionary representation.
+
+        .. caution::
+
+            Deprecated, use :meth:`as_dict` instead
+
+        :rtype: dict
+        """
+        warnings.warn("ScreenshotterRequest.as_json is deprecated, please use as_dict", DeprecationWarning)
+        return self.as_dict()
+
+    def as_dict(self):
+        """
+        Get a dictionary representation.
+
+        :rtype: dict
+        """
         return {
             "inputs": {
-                "document": self.document.as_json(),
+                "document": self.document.as_dict(),
             },
             "settings": {
-                "outputManagedFolderId": self.output_managed_folder,
+                "outputManagedFolderRef": self.output_managed_folder,
                 "paginationOffset": self.offset,
                 "paginationSize": self.fetch_size,
             }
@@ -300,7 +319,7 @@ class ScreenshotterResponse(object):
         self.project_key = project_key
         self.screenshotter_request = screenshotter_request
         self._current_data = self.client._perform_json("POST", "/projects/%s/document-extractors/screenshotter" % self.project_key,
-                                                       raw_body={"screenshotRequest": json.dumps(screenshotter_request.as_json())},
+                                                       raw_body={"screenshotRequest": json.dumps(screenshotter_request.as_dict())},
                                                        files={"file": screenshotter_request.document.file} if isinstance(screenshotter_request.document,
                                                                                                                          LocalFileDocumentRef) else None)
         self._fail_unless_success()
@@ -324,7 +343,7 @@ class ScreenshotterResponse(object):
             self.screenshotter_request.offset = screenshot_index
             self.screenshotter_request.document = self.document
             self._current_data = self.client._perform_json("POST", "/projects/%s/document-extractors/screenshotter" % self.project_key,
-                                                           raw_body={"screenshotRequest": json.dumps(self.screenshotter_request.as_json())},
+                                                           raw_body={"screenshotRequest": json.dumps(self.screenshotter_request.as_dict())},
                                                            files={"file": self.document.file} if isinstance(self.document, LocalFileDocumentRef) else None)
             self._fail_unless_success()
             self._update_screenshot_list_at_index(screenshot_index)
@@ -335,7 +354,7 @@ class ScreenshotterResponse(object):
             res = [InlineImageRef(image["content"], image["mimeType"] if "mimeType" in image else None) for image in
                    self._current_data["imagesRefs"]["inlineImages"]]
         elif self._current_data["imagesRefs"]["type"] == "managed_folder":
-            res = [ManagedFolderImageRef(self._current_data["imagesRefs"]["managedFolderId"], path) for path in self._current_data["imagesRefs"]["imagesPaths"]]
+            res = [ManagedFolderImageRef(self._current_data["imagesRefs"]["managedFolderRef"], path) for path in self._current_data["imagesRefs"]["imagesPaths"]]
         else:
             raise ValueError("Did not return valid images ref")
         if not self.keep_fetched:
@@ -376,7 +395,9 @@ class ScreenshotterResponse(object):
         """
         doc_type = self._current_data.get("documentRef").get("type")
         if doc_type == "managed_folder":
-            return ManagedFolderDocumentRef(self._current_data.get("documentRef").get("filePath"), self._current_data.get("documentRef").get("managedFolderId"))
+            document_ref = self._current_data.get("documentRef")
+            managed_folder_ref = document_ref.get("managedFolderRef") or document_ref.get("managedFolderId")
+            return ManagedFolderDocumentRef(document_ref.get("filePath"), managed_folder_ref)
         if doc_type == "tmp_file":
             return _TmpDocumentRef(self._current_data.get("documentRef").get("tmpFileName"), self._current_data.get("documentRef").get("originalFileName"))
         else:
@@ -513,19 +534,19 @@ class StructuredExtractorResponse(object):
         """
 
         def _flatten_using_dfs(node, current_outline):
-            if not node or not "type" in node:
+            if not node or "type" not in node:
                 return []
             elif node["type"] == "text" or node["type"] == "table":
-                if not "text" in node or not node["text"]:
+                if "text" not in node or not node["text"]:
                     return []
                 return [{"text": node["text"], "outline": current_outline}]
             elif node["type"] == "image":
-                if not "description" in node or not node["description"]:
+                if "description" not in node or not node["description"]:
                     return []
                 return [{"text": node["description"], "outline": current_outline}]
             elif node["type"] not in ["document", "section", "slide"]:
                 raise ValueError("Unsupported structured content type: " + node["type"])
-            if not "content" in node:
+            if "content" not in node:
                 return []
             deeper_outline = copy.deepcopy(current_outline)
             if node["type"] == "section":
@@ -559,7 +580,7 @@ class PDFConversionResponse(object):
         self.path_in_output_folder = path_in_output_folder
         pdf_convert_request = {
             "inputs": {
-                "document": document.as_json()
+                "document": document.as_dict()
             }
         }
         if output_managed_folder is not None:
@@ -619,7 +640,9 @@ class PDFConversionResponse(object):
         if self.output_managed_folder is None:
             return None
         else:
-            return ManagedFolderDocumentRef(self._data.get("documentRef").get("filePath"), self._data.get("documentRef").get("managedFolderId"))
+            document_ref = self._data.get("documentRef")
+            managed_folder_ref = document_ref.get("managedFolderRef") or document_ref.get("managedFolderId")
+            return ManagedFolderDocumentRef(document_ref.get("filePath"), managed_folder_ref)
 
     @property
     def success(self):
@@ -685,7 +708,7 @@ class VlmExtractorResponse(object):
 
 
 class InputRef(object):
-    def as_json(self):
+    def as_dict(self):
         raise NotImplementedError
 
 
@@ -703,7 +726,7 @@ class DocumentRef(InputRef):
         self.type = None
         self.mime_type = mime_type
 
-    def as_json(self):
+    def as_dict(self):
         raise NotImplementedError
 
 
@@ -732,6 +755,19 @@ class LocalFileDocumentRef(DocumentRef):
         self.file = fp
 
     def as_json(self):
+        """
+        Get a dictionary representation.
+
+        .. caution::
+
+           Deprecated, use :meth:`as_dict` instead
+
+        :rtype: dict
+        """
+        warnings.warn("LocalFileDocumentRef.as_json is deprecated, please use as_dict", DeprecationWarning)
+        return self.as_dict()
+
+    def as_dict(self):
         return {
             "type": self.type,
             "mimeType": self.mime_type,
@@ -758,6 +794,19 @@ class _TmpDocumentRef(DocumentRef):
         self.original_file_name = original_file_name
 
     def as_json(self):
+        """
+        Get a dictionary representation.
+
+        .. caution::
+
+           Deprecated, use :meth:`as_dict` instead
+
+        :rtype: dict
+        """
+        warnings.warn("_TmpDocumentRef.as_json is deprecated, please use as_dict", DeprecationWarning)
+        return self.as_dict()
+
+    def as_dict(self):
         return {
             "type": self.type,
             "tmpFileName": self.tmp_file_name,
@@ -789,13 +838,36 @@ class ManagedFolderDocumentRef(DocumentRef):
         super(ManagedFolderDocumentRef, self).__init__(mime_type)
         self.type = "managed_folder"
         self.file_path = file_path
-        self.managed_folder_id = managed_folder_id
+        self.managed_folder_ref = managed_folder_id
+
+    @property
+    def managed_folder_id(self):
+        warnings.warn("ManagedFolderDocumentRef.managed_folder_id is deprecated, please use managed_folder_ref", DeprecationWarning)
+        return self.managed_folder_ref
 
     def as_json(self):
+        """
+        Get a dictionary representation.
+
+        .. caution::
+
+           Deprecated, use :meth:`as_dict` instead
+
+        :rtype: dict
+        """
+        warnings.warn("ManagedFolderDocumentRef.as_json is deprecated, please use as_dict", DeprecationWarning)
+        return self.as_dict()
+
+    def as_dict(self):
+        """
+        Get a dictionary representation.
+
+        :rtype: dict
+        """
         return {
             "type": self.type,
             "filePath": self.file_path,
-            "managedFolderId": self.managed_folder_id,
+            "managedFolderRef": self.managed_folder_ref,
             "mimeType": self.mime_type,
         }
 
@@ -818,6 +890,23 @@ class InlineDocumentRef(DocumentRef):
         self.content_type = content_type
 
     def as_json(self):
+        """
+        Get a dictionary representation.
+
+        .. caution::
+
+            Deprecated, use :meth:`as_dict` instead
+
+        :rtype: dict
+        """
+        return self.as_dict()
+
+    def as_dict(self):
+        """
+        Get a dictionary representation.
+
+        :rtype: dict
+        """
         return {
             "type": self.type,
             "content": self.content,
@@ -854,7 +943,7 @@ class ImageRef(InputRef):
         super(ImageRef, self).__init__()
         self.type = None
 
-    def as_json(self):
+    def as_dict(self):
         raise NotImplementedError
 
 
@@ -891,6 +980,24 @@ class InlineImageRef(ImageRef):
         self.mime_type = mime_type
 
     def as_json(self):
+        """
+        Get a dictionary representation.
+
+        .. caution::
+
+            Deprecated, use :meth:`as_dict` instead
+
+        :rtype: dict
+        """
+        warnings.warn("InlineImageRef.as_json is deprecated, please use as_dict", DeprecationWarning)
+        return self.as_dict()
+
+    def as_dict(self):
+        """
+        Get a dictionary representation.
+
+        :rtype: dict
+        """
         res = {
             "type": self.type,
             "content": self.image
@@ -908,25 +1015,48 @@ class ManagedFolderImageRef(ImageRef):
 
     .. code-block:: python
 
-        managed_img = ManagedFolderImageRef('managed_folder_id', 'path_in_folder/image.png')
+        managed_img = ManagedFolderImageRef('managed_folder_ref', 'path_in_folder/image.png')
 
         # Extract a text summary from the image using a vision LLM:
         resp = doc_ex.vlm_extract([managed_img], 'llm_id')
     """
 
-    def __init__(self, managed_folder_id, image_path):
+    def __init__(self, managed_folder_ref, image_path):
         """
-        :param str managed_folder_id: identifier of the folder containing the image
+        :param str managed_folder_ref: identifier of the folder containing the image
         :param str image_path: path to the image file inside the managed folder
         """
         super(ManagedFolderImageRef, self).__init__()
         self.type = "managed_folder"
-        self.managed_folder_id = managed_folder_id
+        self.managed_folder_ref = managed_folder_ref
         self.image_path = image_path
 
+    @property
+    def managed_folder_id(self):
+        warnings.warn("ManagedFolderImageRef.managed_folder_id is deprecated, please use managed_folder_ref", DeprecationWarning)
+        return self.managed_folder_ref
+
     def as_json(self):
+        """
+        Get a dictionary representation.
+
+        .. caution::
+
+            Deprecated, use :meth:`as_dict` instead
+
+        :rtype: dict
+        """
+        warnings.warn("ManagedFolderImageRef.as_json is deprecated, please use as_dict", DeprecationWarning)
+        return self.as_dict()
+
+    def as_dict(self):
+        """
+        Get a dictionary representation.
+
+        :rtype: dict
+        """
         return {
             "type": self.type,
-            "managedFolderId": self.managed_folder_id,
+            "managedFolderRef": self.managed_folder_ref,
             "imagePath": self.image_path
         }

{dataiku_api_client-14.4.2 → dataiku_api_client-14.4.4}/dataikuapi/dss/project.py

@@ -1829,13 +1829,13 @@ class DSSProject(object):
         if template_ref is not None:
             if not isinstance(template_ref, DocumentRef):
                 raise ValueError("Unsupported template document ref type %s, document templating only supports DocumentRef objects", template_ref.type)
-            payload["templateRef"] = template_ref.as_json()
+            payload["templateRef"] = template_ref.as_dict()
 
         if output_ref is None:
             output_ref = InlineDocumentRef("", InlineDocumentRef.CONTENT_TYPE_PLAIN_TEXT)
         if not isinstance(output_ref, DocumentRef):
             raise ValueError("Unsupported output document ref type %s, document templating only supports DocumentRef objects", template_ref.type)
-        payload["destinationRef"] = output_ref.as_json()
+        payload["destinationRef"] = output_ref.as_dict()
 
         ret = self.client._perform_json(
             "POST",
@@ -2315,7 +2315,8 @@ class DSSProject(object):
             return recipe.EmbedDocumentsRecipeCreator(name, self)
         elif type == "extract_content":
             return recipe.ExtractContentRecipeCreator(name, self)
-
+        elif type == "prompt":
+            return recipe.PromptRecipeCreator(name, self)
 
     ########################################################
     # Flow
@@ -4005,13 +4006,13 @@ class DocumentTemplateRenderingResponse(object):
 
         document_ref = self._raw["documentRef"]
         if document_ref.get("type") == "managed_folder":
-            if not "managedFolderId" in document_ref:
-                raise Exception("No output managed folder id available in the document ref")
+            if not "managedFolderRef" in document_ref:
+                raise Exception("No output managed folder ref available in the document ref")
             if not "filePath" in document_ref:
                 raise Exception("No output file path available in the document ref")
             return ManagedFolderDocumentRef(
                 document_ref["filePath"],
-                document_ref["managedFolderId"],
+                document_ref["managedFolderRef"],
                 mime_type=document_ref.get("mimeType"))
         elif document_ref.get("type") == "inline_document":
             if not "content" in document_ref:
@@ -4037,7 +4038,7 @@ class DocumentTemplateRenderingResponse(object):
         document = self.document
         if isinstance(document, ManagedFolderDocumentRef):
             project = self.client.get_project(self.project_key)
-            folder = project.get_managed_folder(document.managed_folder_id)
+            folder = project.get_managed_folder(document.managed_folder_ref)
             response = folder.get_file(document.file_path)
             response.raise_for_status()
             if document.mime_type == "text/plain":

{dataiku_api_client-14.4.2 → dataiku_api_client-14.4.4}/dataikuapi/dss/recipe.py

@@ -259,6 +259,8 @@ class DSSRecipe(object):
             return EmbedDocumentsRecipeSettings(self, data)
         elif type == "extract_content":
             return ExtractContentRecipeSettings(self, data)
+        elif type == "prompt":
+            return PromptRecipeSettings(self, data)
         else:
             return DSSRecipeSettings(self, data)
 
@@ -3636,3 +3638,95 @@ class ClusteringScoringRecipeCreator(SingleOutputRecipeCreator):
         :param string model_id: identifier of a saved model
         """
         return self._with_input(model_id, self.project.project_key, "model")
+
+
+class PromptRecipeSettings(DSSRecipeSettings):
+    """
+    Settings of a Prompt recipe.
+
+    .. important::
+
+        Do not instantiate directly, use :meth:`DSSRecipe.get_settings()`
+
+    A Prompt recipe allows you to use Large Language Models (LLMs) to process
+    dataset rows, typically for tasks like text summarization, classification,
+    or information extraction.
+
+    The payload of this recipe is a JSON object containing the prompt
+    template, the selected LLM, and various generation parameters
+    """
+    pass
+
+class PromptRecipeCreator(SingleOutputRecipeCreator):
+    """
+    Helper to create a new Prompt recipe.
+
+    .. important::
+
+        Do not instantiate directly, use :meth:`dataikuapi.dss.project.DSSProject.new_recipe()`
+        with type 'prompt' instead.
+
+    Usage example:
+
+    .. code-block:: python
+
+        project = client.get_project("MYPROJECT")
+        builder = project.new_recipe("prompt", "my_prompt_recipe")
+
+        # Define the input dataset and the LLM to use
+        builder.with_input("input_dataset")
+
+        # Define the llm to use, it can be an agent or simply an llm
+        builder.with_llm("my-gpt-4-connection")
+        # or using an agent, ra-llm or finetuned model like this
+        builder.with_llm("agent:agentid")
+
+        A `DSSLLMListItem` or `DSSLLM` is also supported as input for `with_llm`
+
+        # Create a new output dataset for the results
+        builder.with_new_output("output_dataset", connection="filesystem_managed")
+
+        recipe = builder.create()
+    """
+
+    def __init__(self, name, project):
+        SingleOutputRecipeCreator.__init__(self, 'prompt', name, project)
+
+    def with_llm(self, llm):
+        """
+        Sets the LLM to be used by the recipe.
+
+        :param llm: the LLM to use. Can be a :class:`dataikuapi.dss.llm.DSSLLM` handle,
+                    a :class:`dataikuapi.dss.llm.DSSLLMListItem`, or the LLM identifier string.
+        :type llm: object or str
+
+        :return: self
+        :rtype: :class:`PromptRecipeCreator`
+        """
+        if isinstance(llm, DSSLLM):
+            llm_id = llm.llm_id
+        elif isinstance(llm, DSSLLMListItem):
+            llm_id = llm.id
+        elif isinstance(llm, str):
+            llm_id = llm
+        else:
+            raise ValueError("Unknown LLM: %s" % llm)
+        initial_payload = self.creation_settings.setdefault("initialPayload", {})
+        initial_payload["llmId"] = llm_id
+        initial_payload["onlySetLLMId"] = False
+
+        chunks = llm_id.split(":")
+        llm_type = chunks[0]
+        type_to_id_index = {
+            "agent": 1,
+            "retrieval-augmented-llm": 1,
+            "saved-model": 3
+        }
+        # For agents, ra llms and finetuned models we also need to add them as input models
+        if llm_type in type_to_id_index:
+            idx = type_to_id_index[llm_type]
+            if len(chunks) <= idx:
+                raise ValueError("Malformed LLM id: %s" % llm_id)
+            model_id = chunks[idx]
+            return self._with_input(model_id, self.project.project_key, "model")
+        return self

{dataiku_api_client-14.4.2 → dataiku_api_client-14.4.4}/setup.py

@@ -2,7 +2,7 @@
 
 from setuptools import setup
 
-VERSION = "14.4.2"
+VERSION = "14.4.4"
 
 long_description = (open('README').read() + '\n\n' +
                     open('HISTORY.txt').read())