semantic-link-labs 0.11.2__py3-none-any.whl → 0.12.0__py3-none-any.whl

sempy_labs/ml_model/_functions.py

@@ -0,0 +1,427 @@
+import pandas as pd
+from typing import Any, Optional, List
+from .._helper_functions import (
+    _update_dataframe_datatypes,
+    resolve_item_id,
+    resolve_item_name_and_id,
+    resolve_workspace_id,
+    _base_api,
+    delete_item,
+    _create_dataframe,
+    create_item,
+    resolve_workspace_name_and_id,
+)
+from uuid import UUID
+from sempy._utils._log import log
+import sempy_labs._icons as icons
+
+
+@log
+def list_ml_models(workspace: Optional[str | UUID] = None) -> pd.DataFrame:
+    """
+    Shows the ML models within a workspace.
+
+    This is a wrapper function for the following API: `Items - List ML Models <https://learn.microsoft.com/rest/api/fabric/mlmodel/items/list-ml-models>`_.
+
+    Parameters
+    ----------
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+
+    Returns
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing the ML models within a workspace.
+    """
+
+    columns = {
+        "ML Model Name": "string",
+        "ML Model Id": "string",
+        "Description": "string",
+    }
+    df = _create_dataframe(columns=columns)
+
+    workspace_id = resolve_workspace_id(workspace)
+
+    responses = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/mlModels",
+        status_codes=200,
+        uses_pagination=True,
+    )
+
+    rows = []
+    for r in responses:
+        for v in r.get("value", []):
+            model_id = v.get("id")
+            modelName = v.get("displayName")
+            desc = v.get("description")
+
+            rows.append(
+                {
+                    "ML Model Name": modelName,
+                    "ML Model Id": model_id,
+                    "Description": desc,
+                }
+            )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
+
+    return df
+
+
+@log
+def create_ml_model(
+    name: str, description: Optional[str] = None, workspace: Optional[str | UUID] = None
+):
+    """
+    Creates a Fabric ML model.
+
+    This is a wrapper function for the following API: `Items - Create ML Model <https://learn.microsoft.com/rest/api/fabric/mlmodel/items/create-ml-model>`_.
+
+    Parameters
+    ----------
+    name: str
+        Name of the ML model.
+    description : str, default=None
+        A description of the ML model.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+    """
+
+    create_item(name=name, description=description, type="MLModel", workspace=workspace)
+
+
+@log
+def delete_ml_model(ml_model: str | UUID, workspace: Optional[str | UUID] = None):
+    """
+    Deletes a Fabric ML model.
+
+    This is a wrapper function for the following API: `Items - Delete ML Model <https://learn.microsoft.com/rest/api/fabric/mlmodel/items/delete-ml-model>`_.
+
+    Parameters
+    ----------
+    ml_model: str | uuid.UUID
+        Name or ID of the ML model.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+    """
+
+    delete_item(item=ml_model, type="MLModel", workspace=workspace)
+
+
+@log
+def activate_ml_model_endpoint_version(
+    ml_model: str | UUID, name: str, workspace: Optional[str | UUID] = None
+):
+    """
+    Activates the specified model version endpoint.
+
+    This is a wrapper function for the following API: `Endpoint - Activate ML Model Endpoint Version <https://learn.microsoft.com/rest/api/fabric/mlmodel/endpoint/activate-ml-model-endpoint-version>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    ml_model: str | uuid.UUID
+        Name or ID of the ML model.
+    name: str
+        The ML model version name.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+    """
+
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (model_name, model_id) = resolve_item_name_and_id(
+        item=ml_model, type="MLModel", workspace=workspace
+    )
+
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/mlmodels/{model_id}/endpoint/versions/{name}/activate",
+        method="post",
+        client="fabric_sp",
+        lro_return_status_code=True,
+        status_codes=[200, 202],
+    )
+
+    print(
+        f"{icons.green_dot} The {model_name} model version {name} has been activated in the {workspace_name} workspace."
+    )
+
+
+@log
+def deactivate_ml_model_endpoint_version(
+    ml_model: str | UUID, name: str, workspace: Optional[str | UUID] = None
+):
+    """
+    Deactivates the specified model version endpoint.
+
+    This is a wrapper function for the following API: `Endpoint - Deactivate ML Model Endpoint Version <https://learn.microsoft.com/rest/api/fabric/mlmodel/endpoint/deactivate-ml-model-endpoint-version>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    ml_model: str | uuid.UUID
+        Name or ID of the ML model.
+    name: str
+        The ML model version name.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+    """
+
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (model_name, model_id) = resolve_item_name_and_id(
+        item=ml_model, type="MLModel", workspace=workspace
+    )
+
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/mlmodels/{model_id}/endpoint/versions/{name}/deactivate",
+        method="post",
+        client="fabric_sp",
+        lro_return_status_code=True,
+        status_codes=[200, 202],
+    )
+
+    print(
+        f"{icons.green_dot} The {model_name} model version {name} has been deactivated in the {workspace_name} workspace."
+    )
+
+
+@log
+def deactivate_all_ml_model_endpoint_versions(
+    ml_model: str | UUID, workspace: Optional[str | UUID] = None
+):
+    """
+    Deactivates the specified machine learning model and its version's endpoints.
+
+    This is a wrapper function for the following API: `Endpoint - Deactivate All ML Model Endpoint Versions <https://learn.microsoft.com/rest/api/fabric/mlmodel/endpoint/deactivate-all-ml-model-endpoint-versions>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    ml_model: str | uuid.UUID
+        Name or ID of the ML model.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+    """
+
+    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+    (model_name, model_id) = resolve_item_name_and_id(
+        item=ml_model, type="MLModel", workspace=workspace
+    )
+
+    _base_api(
+        request=f"/v1/workspaces/{workspace_id}/mlmodels/{model_id}/endpoint/versions/deactivateAll",
+        method="post",
+        client="fabric_sp",
+        lro_return_status_code=True,
+        status_codes=[200, 202],
+    )
+
+    print(
+        f"{icons.green_dot} All endpoint versions of the {model_name} model within the {workspace_name} workspace have been deactivated."
+    )
+
+
+@log
+def list_ml_model_endpoint_versions(
+    ml_model: str | UUID, workspace: Optional[str | UUID] = None
+) -> pd.DataFrame:
+    """
+    Lists all machine learning model endpoint versions.
+
+    This is a wrapper function for the following API: `Endpoint - List ML Model Endpoint Versions <https://learn.microsoft.com/rest/api/fabric/mlmodel/endpoint/list-ml-model-endpoint-versions>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    ml_model: str | uuid.UUID
+        Name or ID of the ML model.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+
+    Returns
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing the ML model endpoint versions within a workspace.
+    """
+
+    workspace_id = resolve_workspace_id(workspace)
+    model_id = resolve_item_id(item=ml_model, type="MLModel", workspace=workspace)
+
+    columns = {
+        "Version Name": "string",
+        "Status": "string",
+        "Type": "string",
+        "Name": "string",
+        "Required": "bool",
+        "Scale Rule": "string",
+    }
+    df = _create_dataframe(columns=columns)
+
+    responses = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/mlmodels/{model_id}/endpoint/versions",
+        client="fabric_sp",
+        uses_pagination=True,
+    )
+
+    rows = []
+    for r in responses:
+        for version in r.get("value", []):
+            base = {
+                "Version Name": version.get("versionName"),
+                "Status": version.get("status"),
+                "Scale Rule": version.get("scaleRule"),
+            }
+            for sig_type in ["inputSignature", "outputSignature"]:
+                for entry in version.get(sig_type, []):
+                    rows.append(
+                        {
+                            **base,
+                            "Signature Type": (
+                                "Input" if sig_type == "inputSignature" else "Output"
+                            ),
+                            "Name": entry.get("name"),
+                            "Type": entry.get("type"),
+                            "Required": entry.get("required"),
+                        }
+                    )
+            # Handle versions with no signatures
+            if "inputSignature" not in version and "outputSignature" not in version:
+                rows.append(base)
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
+        _update_dataframe_datatypes(dataframe=df, column_map=columns)
+
+    return df
+
+
+@log
+def score_ml_model_endpoint(
+    ml_model: str | UUID,
+    inputs: List[List[Any]],
+    orientation: str = "values",
+    workspace: Optional[str | UUID] = None,
+) -> dict:
+    """
+    Scores input data using the default version of the endpoint and returns results.
+
+    This is a wrapper function for the following API: `Endpoint - Score ML Model Endpoint <https://learn.microsoft.com/rest/api/fabric/mlmodel/endpoint/score-ml-model-endpoint>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    ml_model: str | uuid.UUID
+        Name or ID of the ML model.
+    inputs: List[List[Any]]
+        Machine learning inputs to score in the form of Pandas dataset arrays that can include strings, numbers, integers and booleans.
+    orientation: str, default='values'
+        `Orientation <https://learn.microsoft.com/en-us/rest/api/fabric/mlmodel/endpoint/score-ml-model-endpoint?tabs=HTTP#orientation>`_ of the input data.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+    """
+
+    workspace_id = resolve_workspace_id(workspace)
+    model_id = resolve_item_id(item=ml_model, type="MLModel", workspace=workspace)
+
+    orientation = _validate_orientation(orientation)
+    payload = {
+        "formatType": "dataframe",
+        "orientation": orientation,
+        "inputs": inputs,
+    }
+
+    result = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/mlmodels/{model_id}/endpoint/score",
+        method="post",
+        client="fabric_sp",
+        payload=payload,
+        lro_return_json=True,
+        status_codes=[200, 202],
+    )
+
+    return result
+
+
+@log
+def score_ml_model_endpoint_version(
+    ml_model: str | UUID,
+    name: str,
+    inputs: List[List[Any]],
+    orientation: str = "values",
+    workspace: Optional[str | UUID] = None,
+) -> dict:
+    """
+    Scores input data using the default version of the endpoint and returns results.
+
+    This is a wrapper function for the following API: `Endpoint - Score ML Model Endpoint Version <https://learn.microsoft.com/rest/api/fabric/mlmodel/endpoint/score-ml-model-endpoint-version>`_.
+
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    ml_model: str | uuid.UUID
+        Name or ID of the ML model.
+    name: str
+        The ML model version name.
+    inputs: List[List[Any]]
+        Machine learning inputs to score in the form of Pandas dataset arrays that can include strings, numbers, integers and booleans.
+    orientation: str, default='values'
+        `Orientation <https://learn.microsoft.com/en-us/rest/api/fabric/mlmodel/endpoint/score-ml-model-endpoint?tabs=HTTP#orientation>`_ of the input data.
+    workspace : str | uuid.UUID, default=None
+        The Fabric workspace name or ID.
+        Defaults to None which resolves to the workspace of the attached lakehouse
+        or if no lakehouse attached, resolves to the workspace of the notebook.
+    """
+
+    workspace_id = resolve_workspace_id(workspace)
+    model_id = resolve_item_id(item=ml_model, type="MLModel", workspace=workspace)
+
+    orientation = _validate_orientation(orientation)
+    payload = {
+        "formatType": "dataframe",
+        "orientation": orientation,
+        "inputs": inputs,
+    }
+
+    result = _base_api(
+        request=f"/v1/workspaces/{workspace_id}/mlmodels/{model_id}/endpoint/versions/{name}/score",
+        method="post",
+        client="fabric_sp",
+        payload=payload,
+        lro_return_json=True,
+        status_codes=[200, 202],
+    )
+
+    return result
+
+
+def _validate_orientation(orientation: str):
+
+    orientation = orientation.lower()
+    if orientation not in ["split", "values", "record", "index", "table"]:
+        raise ValueError(
+            f"Invalid orientation '{orientation}'. Must be one of 'split', 'values', 'record', 'index', or 'table'."
+        )
+    return orientation

sempy_labs/report/_bpareporttemplate/.pbi/localSettings.json

@@ -0,0 +1,9 @@
+{
+  "version": "1.0",
+  "remoteArtifacts": [
+    {
+      "reportId": "6a91c344-dba8-4ebf-bedb-e07134f2a204"
+    }
+  ],
+  "securityBindingsSignature": "AQAAANCMnd8BFdERjHoAwE/Cl+sBAAAAMAVu7l76YU6Sl11KOiJdgQAAAAACAAAAAAAQZgAAAAEAACAAAAD1Ty+c7tZLT9/Sjguxhn/5ivfLWfUMNtgudyJ3BKzzZgAAAAAOgAAAAAIAACAAAABAyGf+iKMwvmNtcoRczjgebeIm0nlc9SFYTBYv3N7yvVADAADQN3JsIsvJUcKKc9WMo2EhiE21odezpd35tb+yudHwA/RYhypMA3fwiCTwArLefBZQ3vZ7KYh4MjihXS07i9o1XVqxAmDoli83Yhs/Wei+0HIfYOT5HOVHLUEul5x41Yx/7Bdfhc881SK6IoaJogBdwsiJVxPne+niMYqJQA6qLEPyJ33g6ucUxLA40lwdbN2cMWFzRn6tymmicDPwH0hcGPDMWwseAU+OuUeidkneRWhUGs6lkiiXLiO6kmY5RKq+S4FdtR19/e1B6EjAd94zSw+M5jQzYxn4eCZzWYiB+8Zd/jy07lfyLoGwagNqiQzbcNONqQd5w0n+8/+n4zGkBi2UojfRXoGaYDirQeZMTbt3pfPx2PArxsJ8dF0iT634pHiCF1ZFdtY+79JaFLUUG+Yf7JJv8IxuuuF74tAp4NYmuOij4hTDaf8Jafa5IoRVh7ICkwrjJyVQ8dG7I3tr0VvR+toBPG3Zlbm9BijcaBxhh1AINhnRAIkENOnPFQVH7l3Ml7B60H8Tst6ic3ihCCMYjtmN+NNWqFrJKT2trilh5TAxN+ei4H5fPwM9S7zb2bH5jhExcYTtoe7iCzxOvBsoYoFM+7FMjn9R2FATNICktYdbKDo1Of+u4oZ1+RsvBHQBVaMhSCoZ7+K5T5pZayNK3V2UID3wOuLOYvouxXXr4NVFsdgiV2oMuxTWeqmd/4bLxeqe3uTkGFmQU4mumF2YVsNbdO3IcRXhhrCCZ27ffzXBsH+lE3EhusD37Z0dsVbVVlG8AHXCh7Atgd8n73/eSI5mvj36DCOSRBVauItIATIa2FXueKA7vU6lRDYBSX8FCC2qkeN6dWpMoN5uXXEBsb5Yot1Fgrovcyl5lk7rh772Xon4FaIYFHZpklsY3JK5EXp3bF8UOE6ByN1ZucmkGgYRcTT/up/Uc86TLN6env9XXL4FQYPlReiOGWKBLVi9OoXGRLDshspniULtV3EwQ6WsjF2AyQ+WdLj3bbWKzG5Mg9jvANLrjycZAGWskh4X5JDGiv4TiJmnYQ/xPZAKKiowpVIHikLeG76uXFI+bxtpihV9+DaEJy4UxisHQxwuvUsQs38u3SHgpJmT8CNssZl41+T/IJdoQwJFLUAAAACnUQZGV9DvcOyrj8HBpXBVB5PuOQDxLB4HZOevHqCB5dc5z787E93B51QmN7I15fF6GCdWwN5f94gv1er2dtN3"
+}

sempy_labs/report/_bpareporttemplate/.platform

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/fabric/gitIntegration/platformProperties/2.0.0/schema.json",
+  "metadata": {
+    "type": "Report",
+    "displayName": "BPAReport"
+  },
+  "config": {
+    "version": "2.0",
+    "logicalId": "a201f2cd-fd25-465f-bfbc-33b151e38b31"
+  }
+}

sempy_labs/report/_download_report.py

@@ -25,6 +25,8 @@ def download_report(
 
     This is a wrapper function for the following API: `Reports - Export Report In Group <https://learn.microsoft.com/rest/api/power-bi/reports/export-report-in-group>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     report: str | uuid.UUID
@@ -59,7 +61,8 @@ def download_report(
     report_id = resolve_item_id(item=report, type="Report", workspace=workspace)
 
     response = _base_api(
-        request=f"v1.0/myorg/groups/{workspace_id}/reports/{report_id}/Export?downloadType={download_type}"
+        request=f"v1.0/myorg/groups/{workspace_id}/reports/{report_id}/Export?downloadType={download_type}",
+        client="fabric_sp",
     )
 
     # Save file to the attached lakehouse

sempy_labs/report/_export_report.py

@@ -2,7 +2,7 @@ import sempy.fabric as fabric
 import json
 import os
 import time
-from .._helper_functions import (
+from sempy_labs._helper_functions import (
     generate_embedded_filter,
     resolve_workspace_name_and_id,
     _base_api,
@@ -12,7 +12,7 @@ from typing import Optional
 from sempy._utils._log import log
 import sempy_labs._icons as icons
 from uuid import UUID
-from ._report_functions import (
+from sempy_labs.report._report_functions import (
     list_report_visuals,
     list_report_pages,
 )
@@ -36,6 +36,8 @@ def export_report(
 
     This is a wrapper function for the following APIs: `Reports - Export To File In Group <https://learn.microsoft.com/rest/api/power-bi/reports/export-to-file-in-group>`_, `Reports - Get Export To File Status In Group <https://learn.microsoft.com/rest/api/power-bi/reports/get-export-to-file-status-in-group>`_, `Reports - Get File Of Export To File In Group <https://learn.microsoft.com/rest/api/power-bi/reports/get-file-of-export-to-file-in-group>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     report : str
@@ -241,22 +243,27 @@ def export_report(
         method="post",
         payload=request_body,
         status_codes=202,
+        client="fabric_sp",
     )
     export_id = json.loads(response.content).get("id")
 
     get_status_url = f"{base_url}/exports/{export_id}"
-    response = _base_api(request=get_status_url, status_codes=[200, 202])
+    response = _base_api(
+        request=get_status_url, status_codes=[200, 202], client="fabric_sp"
+    )
     response_body = json.loads(response.content)
     while response_body["status"] not in ["Succeeded", "Failed"]:
         time.sleep(3)
-        response = _base_api(request=get_status_url, status_codes=[200, 202])
+        response = _base_api(
+            request=get_status_url, status_codes=[200, 202], client="fabric_sp"
+        )
         response_body = json.loads(response.content)
     if response_body["status"] == "Failed":
         raise ValueError(
             f"{icons.red_dot} The export for the '{report}' report within the '{workspace_name}' workspace in the '{export_format}' format has failed."
         )
     else:
-        response = _base_api(request=f"{get_status_url}/file")
+        response = _base_api(request=f"{get_status_url}/file", client="fabric_sp")
         print(
             f"{icons.in_progress} Saving the '{export_format}' export for the '{report}' report within the '{workspace_name}' workspace to the lakehouse..."
         )

sempy_labs/report/_generate_report.py

@@ -3,7 +3,7 @@ import pandas as pd
 import json
 import os
 from typing import Optional
-from .._helper_functions import (
+from sempy_labs._helper_functions import (
     resolve_workspace_name_and_id,
     _conv_b64,
     resolve_dataset_name_and_id,
@@ -11,7 +11,7 @@ from .._helper_functions import (
     _update_dataframe_datatypes,
     _base_api,
     resolve_item_id,
-    get_item_definition,
+    _get_item_definition,
 )
 import sempy_labs._icons as icons
 from sempy._utils._log import log
@@ -31,6 +31,8 @@ def create_report_from_reportjson(
 
     This is a wrapper function for the following API: `Items - Create Report <https://learn.microsoft.com/rest/api/fabric/report/items/create-report>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     report : str
@@ -113,6 +115,7 @@ def create_report_from_reportjson(
         payload=request_body,
         lro_return_status_code=True,
         status_codes=[201, 202],
+        client="fabric_sp",
     )
 
     print(
@@ -129,6 +132,8 @@ def update_report_from_reportjson(
 
     This is a wrapper function for the following API: `Items - Update Report Definition <https://learn.microsoft.com/rest/api/fabric/report/items/update-report-definition>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     report : str | uuid.UUID
@@ -173,6 +178,7 @@ def update_report_from_reportjson(
         payload=payload,
         lro_return_status_code=True,
         status_codes=None,
+        client="fabric_sp",
     )
 
     print(
@@ -191,6 +197,8 @@ def get_report_definition(
 
     This is a wrapper function for the following API: `Items - Get Report Definition <https://learn.microsoft.com/rest/api/fabric/report/items/get-report-definition>`_.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     report : str | uuid.UUID
@@ -208,7 +216,7 @@ def get_report_definition(
         The collection of report definition files within a pandas dataframe.
     """
 
-    return get_item_definition(
+    return _get_item_definition(
         item=report,
         type="Report",
         workspace=workspace,

sempy_labs/report/_paginated.py

@@ -1,8 +1,8 @@
 from typing import Optional
 import pandas as pd
 from uuid import UUID
-from .._helper_functions import (
-    resolve_workspace_name_and_id,
+from sempy_labs._helper_functions import (
+    resolve_workspace_id,
     _base_api,
     resolve_item_id,
     _create_dataframe,
@@ -18,6 +18,8 @@ def get_report_datasources(
     """
     Returns a list of data sources for the specified paginated report (RDL) from the specified workspace.
 
+    Service Principal Authentication is supported (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
     Parameters
     ----------
     report : str | uuid.UUID
@@ -44,27 +46,31 @@ def get_report_datasources(
     }
     df = _create_dataframe(columns=columns)
 
-    (workspace_name, workspace_id) = resolve_workspace_name_and_id(workspace)
+    workspace_id = resolve_workspace_id(workspace)
     report_id = resolve_item_id(
         item=report, type="PaginatedReport", workspace=workspace
     )
 
     response = _base_api(
-        request=f"v1.0/myorg/groups/{workspace_id}/reports/{report_id}/datasources"
+        request=f"v1.0/myorg/groups/{workspace_id}/reports/{report_id}/datasources",
+        client="fabric_sp",
     )
 
+    rows = []
     for i in response.json().get("value", []):
         conn = i.get("connectionDetails", {})
-        new_data = {
-            "Report Name": report,
-            "Report Id": report_id,
-            "Datasource Id": i.get("datasourceId"),
-            "Datasource Type": i.get("datasourceType"),
-            "Gateway Id": i.get("gatewayId"),
-            "Server": conn.get("server") if conn else None,
-            "Database": conn.get("database") if conn else None,
-        }
-
-        df = pd.concat([df, pd.DataFrame(new_data, index=[0])], ignore_index=True)
+        rows.append(
+            {
+                "Report Name": report,
+                "Report Id": report_id,
+                "Datasource Id": i.get("datasourceId"),
+                "Datasource Type": i.get("datasourceType"),
+                "Gateway Id": i.get("gatewayId"),
+                "Server": conn.get("server") if conn else None,
+                "Database": conn.get("database") if conn else None,
+            }
+        )
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
 
     return df