databricks-sdk 0.56.0__tar.gz → 0.57.0__tar.gz

{databricks_sdk-0.56.0 → databricks_sdk-0.57.0}/CHANGELOG.md

@@ -1,5 +1,32 @@
 # Version changelog
 
+## Release v0.57.0
+
+### API Changes
+* Added [w.ai_builder](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/aibuilder/ai_builder.html) workspace-level service.
+* Added [w.feature_store](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/ml/feature_store.html) workspace-level service.
+* Added `expiration_time` field for `databricks.sdk.service.database.DatabaseCredential`.
+* Added `effective_stopped` field for `databricks.sdk.service.database.DatabaseInstance`.
+* Added `existing_pipeline_id` field for `databricks.sdk.service.database.SyncedTableSpec`.
+* Added `pipeline_id` field for `databricks.sdk.service.database.SyncedTableStatus`.
+* Added `dbt_platform_output` field for `databricks.sdk.service.jobs.RunOutput`.
+* Added `dbt_platform_task` field for `databricks.sdk.service.jobs.RunTask`.
+* Added `dbt_platform_task` field for `databricks.sdk.service.jobs.SubmitTask`.
+* Added `dbt_platform_task` field for `databricks.sdk.service.jobs.Task`.
+* Added `environment` field for `databricks.sdk.service.pipelines.CreatePipeline`.
+* Added `environment` field for `databricks.sdk.service.pipelines.EditPipeline`.
+* Added `environment` field for `databricks.sdk.service.pipelines.PipelineSpec`.
+* Added `description` field for `databricks.sdk.service.serving.ServingEndpoint`.
+* Added `description` field for `databricks.sdk.service.serving.ServingEndpointDetailed`.
+* Added `cancelled`, `error`, `queued`, `running`, `starting` and `success` enum values for `databricks.sdk.service.jobs.DbtPlatformRunStatus`.
+* [Breaking] Changed `status` field for `databricks.sdk.service.jobs.DbtCloudJobRunStep` to type `databricks.sdk.service.jobs.DbtPlatformRunStatus` dataclass.
+* [Breaking] Removed [w.custom_llms](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/aibuilder/custom_llms.html) workspace-level service.
+* [Breaking] Removed `table_serving_url` field for `databricks.sdk.service.database.DatabaseTable`.
+* [Breaking] Removed `table_serving_url` field for `databricks.sdk.service.database.SyncedDatabaseTable`.
+* [Breaking] Removed `pipeline_id` field for `databricks.sdk.service.database.SyncedTableSpec`.
+* [Breaking] Removed `cancelled`, `error`, `queued`, `running`, `starting` and `success` enum values for `databricks.sdk.service.jobs.DbtCloudRunStatus`.
+
+
 ## Release v0.56.0
 
 ### API Changes

{databricks_sdk-0.56.0 → databricks_sdk-0.57.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: databricks-sdk
-Version: 0.56.0
+Version: 0.57.0
 Summary: Databricks SDK for Python (Beta)
 Project-URL: Documentation, https://databricks-sdk-py.readthedocs.io
 Keywords: databricks,sdk

{databricks_sdk-0.56.0 → databricks_sdk-0.57.0}/databricks/sdk/__init__.py

@@ -36,7 +36,7 @@ from databricks.sdk.service import sharing as pkg_sharing
 from databricks.sdk.service import sql as pkg_sql
 from databricks.sdk.service import vectorsearch as pkg_vectorsearch
 from databricks.sdk.service import workspace as pkg_workspace
-from databricks.sdk.service.aibuilder import CustomLlmsAPI
+from databricks.sdk.service.aibuilder import AiBuilderAPI
 from databricks.sdk.service.apps import AppsAPI
 from databricks.sdk.service.billing import (BillableUsageAPI, BudgetPolicyAPI,
                                             BudgetsAPI, LogDeliveryAPI,
@@ -87,8 +87,8 @@ from databricks.sdk.service.marketplace import (
     ProviderExchangeFiltersAPI, ProviderExchangesAPI, ProviderFilesAPI,
     ProviderListingsAPI, ProviderPersonalizationRequestsAPI,
     ProviderProviderAnalyticsDashboardsAPI, ProviderProvidersAPI)
-from databricks.sdk.service.ml import (ExperimentsAPI, ForecastingAPI,
-                                       ModelRegistryAPI)
+from databricks.sdk.service.ml import (ExperimentsAPI, FeatureStoreAPI,
+                                       ForecastingAPI, ModelRegistryAPI)
 from databricks.sdk.service.oauth2 import (AccountFederationPolicyAPI,
                                            CustomAppIntegrationAPI,
                                            OAuthPublishedAppsAPI,
@@ -235,6 +235,7 @@ class WorkspaceClient:
         serving_endpoints = ServingEndpointsExt(self._api_client)
         self._access_control = pkg_iam.AccessControlAPI(self._api_client)
         self._account_access_control_proxy = pkg_iam.AccountAccessControlProxyAPI(self._api_client)
+        self._ai_builder = pkg_aibuilder.AiBuilderAPI(self._api_client)
         self._alerts = pkg_sql.AlertsAPI(self._api_client)
         self._alerts_legacy = pkg_sql.AlertsLegacyAPI(self._api_client)
         self._alerts_v2 = pkg_sql.AlertsV2API(self._api_client)
@@ -256,7 +257,6 @@ class WorkspaceClient:
         self._credentials = pkg_catalog.CredentialsAPI(self._api_client)
         self._credentials_manager = pkg_settings.CredentialsManagerAPI(self._api_client)
         self._current_user = pkg_iam.CurrentUserAPI(self._api_client)
-        self._custom_llms = pkg_aibuilder.CustomLlmsAPI(self._api_client)
         self._dashboard_widgets = pkg_sql.DashboardWidgetsAPI(self._api_client)
         self._dashboards = pkg_sql.DashboardsAPI(self._api_client)
         self._data_sources = pkg_sql.DataSourcesAPI(self._api_client)
@@ -265,6 +265,7 @@ class WorkspaceClient:
         self._dbsql_permissions = pkg_sql.DbsqlPermissionsAPI(self._api_client)
         self._experiments = pkg_ml.ExperimentsAPI(self._api_client)
         self._external_locations = pkg_catalog.ExternalLocationsAPI(self._api_client)
+        self._feature_store = pkg_ml.FeatureStoreAPI(self._api_client)
         self._files = _make_files_client(self._api_client, self._config)
         self._functions = pkg_catalog.FunctionsAPI(self._api_client)
         self._genie = pkg_dashboards.GenieAPI(self._api_client)
@@ -366,6 +367,11 @@ class WorkspaceClient:
         """These APIs manage access rules on resources in an account."""
         return self._account_access_control_proxy
 
+    @property
+    def ai_builder(self) -> pkg_aibuilder.AiBuilderAPI:
+        """The Custom LLMs service manages state and powers the UI for the Custom LLM product."""
+        return self._ai_builder
+
     @property
     def alerts(self) -> pkg_sql.AlertsAPI:
         """The alerts API can be used to perform CRUD operations on alerts."""
@@ -471,11 +477,6 @@ class WorkspaceClient:
         """This API allows retrieving information about currently authenticated user or service principal."""
         return self._current_user
 
-    @property
-    def custom_llms(self) -> pkg_aibuilder.CustomLlmsAPI:
-        """The Custom LLMs service manages state and powers the UI for the Custom LLM product."""
-        return self._custom_llms
-
     @property
     def dashboard_widgets(self) -> pkg_sql.DashboardWidgetsAPI:
         """This is an evolving API that facilitates the addition and removal of widgets from existing dashboards within the Databricks Workspace."""
@@ -516,6 +517,11 @@ class WorkspaceClient:
         """An external location is an object that combines a cloud storage path with a storage credential that authorizes access to the cloud storage path."""
         return self._external_locations
 
+    @property
+    def feature_store(self) -> pkg_ml.FeatureStoreAPI:
+        """A feature store is a centralized repository that enables data scientists to find and share features."""
+        return self._feature_store
+
     @property
     def files(self) -> pkg_files.FilesAPI:
         """The Files API is a standard HTTP API that allows you to read, write, list, and delete files and directories by referring to their URI."""

{databricks_sdk-0.56.0 → databricks_sdk-0.57.0}/databricks/sdk/service/aibuilder.py

@@ -21,23 +21,85 @@ class CancelCustomLlmOptimizationRunRequest:
 
 
 @dataclass
-class CancelResponse:
+class CancelOptimizeResponse:
     def as_dict(self) -> dict:
-        """Serializes the CancelResponse into a dictionary suitable for use as a JSON request body."""
+        """Serializes the CancelOptimizeResponse into a dictionary suitable for use as a JSON request body."""
         body = {}
         return body
 
     def as_shallow_dict(self) -> dict:
-        """Serializes the CancelResponse into a shallow dictionary of its immediate attributes."""
+        """Serializes the CancelOptimizeResponse into a shallow dictionary of its immediate attributes."""
         body = {}
         return body
 
     @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> CancelResponse:
-        """Deserializes the CancelResponse from a dictionary."""
+    def from_dict(cls, d: Dict[str, Any]) -> CancelOptimizeResponse:
+        """Deserializes the CancelOptimizeResponse from a dictionary."""
         return cls()
 
 
+@dataclass
+class CreateCustomLlmRequest:
+    name: str
+    """Name of the custom LLM. Only alphanumeric characters and dashes allowed."""
+
+    instructions: str
+    """Instructions for the custom LLM to follow"""
+
+    agent_artifact_path: Optional[str] = None
+    """Optional: UC path for agent artifacts. If you are using a dataset that you only have read
+    permissions, please provide a destination path where you have write permissions. Please provide
+    this in catalog.schema format."""
+
+    datasets: Optional[List[Dataset]] = None
+    """Datasets used for training and evaluating the model, not for inference. Currently, only 1
+    dataset is accepted."""
+
+    guidelines: Optional[List[str]] = None
+    """Guidelines for the custom LLM to adhere to"""
+
+    def as_dict(self) -> dict:
+        """Serializes the CreateCustomLlmRequest into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.agent_artifact_path is not None:
+            body["agent_artifact_path"] = self.agent_artifact_path
+        if self.datasets:
+            body["datasets"] = [v.as_dict() for v in self.datasets]
+        if self.guidelines:
+            body["guidelines"] = [v for v in self.guidelines]
+        if self.instructions is not None:
+            body["instructions"] = self.instructions
+        if self.name is not None:
+            body["name"] = self.name
+        return body
+
+    def as_shallow_dict(self) -> dict:
+        """Serializes the CreateCustomLlmRequest into a shallow dictionary of its immediate attributes."""
+        body = {}
+        if self.agent_artifact_path is not None:
+            body["agent_artifact_path"] = self.agent_artifact_path
+        if self.datasets:
+            body["datasets"] = self.datasets
+        if self.guidelines:
+            body["guidelines"] = self.guidelines
+        if self.instructions is not None:
+            body["instructions"] = self.instructions
+        if self.name is not None:
+            body["name"] = self.name
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, Any]) -> CreateCustomLlmRequest:
+        """Deserializes the CreateCustomLlmRequest from a dictionary."""
+        return cls(
+            agent_artifact_path=d.get("agent_artifact_path", None),
+            datasets=_repeated_dict(d, "datasets", Dataset),
+            guidelines=d.get("guidelines", None),
+            instructions=d.get("instructions", None),
+            name=d.get("name", None),
+        )
+
+
 @dataclass
 class CustomLlm:
     name: str
@@ -159,6 +221,24 @@ class Dataset:
         return cls(table=_from_dict(d, "table", Table))
 
 
+@dataclass
+class DeleteCustomLlmResponse:
+    def as_dict(self) -> dict:
+        """Serializes the DeleteCustomLlmResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        return body
+
+    def as_shallow_dict(self) -> dict:
+        """Serializes the DeleteCustomLlmResponse into a shallow dictionary of its immediate attributes."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, Any]) -> DeleteCustomLlmResponse:
+        """Deserializes the DeleteCustomLlmResponse from a dictionary."""
+        return cls()
+
+
 @dataclass
 class StartCustomLlmOptimizationRunRequest:
     id: Optional[str] = None
@@ -273,13 +353,13 @@ class UpdateCustomLlmRequest:
         )
 
 
-class CustomLlmsAPI:
+class AiBuilderAPI:
     """The Custom LLMs service manages state and powers the UI for the Custom LLM product."""
 
     def __init__(self, api_client):
         self._api = api_client
 
-    def cancel(self, id: str):
+    def cancel_optimize(self, id: str):
         """Cancel a Custom LLM Optimization Run.
 
         :param id: str
@@ -294,24 +374,68 @@ class CustomLlmsAPI:
 
         self._api.do("POST", f"/api/2.0/custom-llms/{id}/optimize/cancel", headers=headers)
 
-    def create(self, id: str) -> CustomLlm:
-        """Start a Custom LLM Optimization Run.
-
-        :param id: str
-          The Id of the tile.
+    def create_custom_llm(
+        self,
+        name: str,
+        instructions: str,
+        *,
+        agent_artifact_path: Optional[str] = None,
+        datasets: Optional[List[Dataset]] = None,
+        guidelines: Optional[List[str]] = None,
+    ) -> CustomLlm:
+        """Create a Custom LLM.
+
+        :param name: str
+          Name of the custom LLM. Only alphanumeric characters and dashes allowed.
+        :param instructions: str
+          Instructions for the custom LLM to follow
+        :param agent_artifact_path: str (optional)
+          Optional: UC path for agent artifacts. If you are using a dataset that you only have read
+          permissions, please provide a destination path where you have write permissions. Please provide this
+          in catalog.schema format.
+        :param datasets: List[:class:`Dataset`] (optional)
+          Datasets used for training and evaluating the model, not for inference. Currently, only 1 dataset is
+          accepted.
+        :param guidelines: List[str] (optional)
+          Guidelines for the custom LLM to adhere to
 
         :returns: :class:`CustomLlm`
         """
-
+        body = {}
+        if agent_artifact_path is not None:
+            body["agent_artifact_path"] = agent_artifact_path
+        if datasets is not None:
+            body["datasets"] = [v.as_dict() for v in datasets]
+        if guidelines is not None:
+            body["guidelines"] = [v for v in guidelines]
+        if instructions is not None:
+            body["instructions"] = instructions
+        if name is not None:
+            body["name"] = name
         headers = {
             "Accept": "application/json",
             "Content-Type": "application/json",
         }
 
-        res = self._api.do("POST", f"/api/2.0/custom-llms/{id}/optimize", headers=headers)
+        res = self._api.do("POST", "/api/2.0/custom-llms", body=body, headers=headers)
         return CustomLlm.from_dict(res)
 
-    def get(self, id: str) -> CustomLlm:
+    def delete_custom_llm(self, id: str):
+        """Delete a Custom LLM.
+
+        :param id: str
+          The id of the custom llm
+
+
+        """
+
+        headers = {
+            "Accept": "application/json",
+        }
+
+        self._api.do("DELETE", f"/api/2.0/custom-lms/{id}", headers=headers)
+
+    def get_custom_llm(self, id: str) -> CustomLlm:
         """Get a Custom LLM.
 
         :param id: str
@@ -327,7 +451,24 @@ class CustomLlmsAPI:
         res = self._api.do("GET", f"/api/2.0/custom-llms/{id}", headers=headers)
         return CustomLlm.from_dict(res)
 
-    def update(self, id: str, custom_llm: CustomLlm, update_mask: str) -> CustomLlm:
+    def start_optimize(self, id: str) -> CustomLlm:
+        """Start a Custom LLM Optimization Run.
+
+        :param id: str
+          The Id of the tile.
+
+        :returns: :class:`CustomLlm`
+        """
+
+        headers = {
+            "Accept": "application/json",
+            "Content-Type": "application/json",
+        }
+
+        res = self._api.do("POST", f"/api/2.0/custom-llms/{id}/optimize", headers=headers)
+        return CustomLlm.from_dict(res)
+
+    def update_custom_llm(self, id: str, custom_llm: CustomLlm, update_mask: str) -> CustomLlm:
         """Update a Custom LLM.
 
         :param id: str

{databricks_sdk-0.56.0 → databricks_sdk-0.57.0}/databricks/sdk/service/apps.py

@@ -1232,9 +1232,7 @@ class AppsAPI:
         raise TimeoutError(f"timed out after {timeout}: {status_message}")
 
     def create(self, app: App, *, no_compute: Optional[bool] = None) -> Wait[App]:
-        """Create an app.
-
-        Creates a new app.
+        """Creates a new app.
 
         :param app: :class:`App`
         :param no_compute: bool (optional)
@@ -1260,9 +1258,7 @@ class AppsAPI:
         return self.create(app=app, no_compute=no_compute).result(timeout=timeout)
 
     def delete(self, name: str) -> App:
-        """Delete an app.
-
-        Deletes an app.
+        """Deletes an app.
 
         :param name: str
           The name of the app.
@@ -1278,9 +1274,7 @@ class AppsAPI:
         return App.from_dict(res)
 
     def deploy(self, app_name: str, app_deployment: AppDeployment) -> Wait[AppDeployment]:
-        """Create an app deployment.
-
-        Creates an app deployment for the app with the supplied name.
+        """Creates an app deployment for the app with the supplied name.
 
         :param app_name: str
           The name of the app.
@@ -1310,9 +1304,7 @@ class AppsAPI:
         return self.deploy(app_deployment=app_deployment, app_name=app_name).result(timeout=timeout)
 
     def get(self, name: str) -> App:
-        """Get an app.
-
-        Retrieves information for the app with the supplied name.
+        """Retrieves information for the app with the supplied name.
 
         :param name: str
           The name of the app.
@@ -1328,9 +1320,7 @@ class AppsAPI:
         return App.from_dict(res)
 
     def get_deployment(self, app_name: str, deployment_id: str) -> AppDeployment:
-        """Get an app deployment.
-
-        Retrieves information for the app deployment with the supplied name and deployment id.
+        """Retrieves information for the app deployment with the supplied name and deployment id.
 
         :param app_name: str
           The name of the app.
@@ -1348,9 +1338,7 @@ class AppsAPI:
         return AppDeployment.from_dict(res)
 
     def get_permission_levels(self, app_name: str) -> GetAppPermissionLevelsResponse:
-        """Get app permission levels.
-
-        Gets the permission levels that a user can have on an object.
+        """Gets the permission levels that a user can have on an object.
 
         :param app_name: str
           The app for which to get or manage permissions.
@@ -1366,9 +1354,7 @@ class AppsAPI:
         return GetAppPermissionLevelsResponse.from_dict(res)
 
     def get_permissions(self, app_name: str) -> AppPermissions:
-        """Get app permissions.
-
-        Gets the permissions of an app. Apps can inherit permissions from their root object.
+        """Gets the permissions of an app. Apps can inherit permissions from their root object.
 
         :param app_name: str
           The app for which to get or manage permissions.
@@ -1384,9 +1370,7 @@ class AppsAPI:
         return AppPermissions.from_dict(res)
 
     def list(self, *, page_size: Optional[int] = None, page_token: Optional[str] = None) -> Iterator[App]:
-        """List apps.
-
-        Lists all apps in the workspace.
+        """Lists all apps in the workspace.
 
         :param page_size: int (optional)
           Upper bound for items returned.
@@ -1417,9 +1401,7 @@ class AppsAPI:
     def list_deployments(
         self, app_name: str, *, page_size: Optional[int] = None, page_token: Optional[str] = None
     ) -> Iterator[AppDeployment]:
-        """List app deployments.
-
-        Lists all app deployments for the app with the supplied name.
+        """Lists all app deployments for the app with the supplied name.
 
         :param app_name: str
           The name of the app.
@@ -1452,9 +1434,7 @@ class AppsAPI:
     def set_permissions(
         self, app_name: str, *, access_control_list: Optional[List[AppAccessControlRequest]] = None
     ) -> AppPermissions:
-        """Set app permissions.
-
-        Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
+        """Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct
         permissions if none are specified. Objects can inherit permissions from their root object.
 
         :param app_name: str
@@ -1475,9 +1455,7 @@ class AppsAPI:
         return AppPermissions.from_dict(res)
 
     def start(self, name: str) -> Wait[App]:
-        """Start an app.
-
-        Start the last active deployment of the app in the workspace.
+        """Start the last active deployment of the app in the workspace.
 
         :param name: str
           The name of the app.
@@ -1499,9 +1477,7 @@ class AppsAPI:
         return self.start(name=name).result(timeout=timeout)
 
     def stop(self, name: str) -> Wait[App]:
-        """Stop an app.
-
-        Stops the active deployment of the app in the workspace.
+        """Stops the active deployment of the app in the workspace.
 
         :param name: str
           The name of the app.
@@ -1523,9 +1499,7 @@ class AppsAPI:
         return self.stop(name=name).result(timeout=timeout)
 
     def update(self, name: str, app: App) -> App:
-        """Update an app.
-
-        Updates the app with the supplied name.
+        """Updates the app with the supplied name.
 
         :param name: str
           The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It
@@ -1546,9 +1520,7 @@ class AppsAPI:
     def update_permissions(
         self, app_name: str, *, access_control_list: Optional[List[AppAccessControlRequest]] = None
     ) -> AppPermissions:
-        """Update app permissions.
-
-        Updates the permissions on an app. Apps can inherit permissions from their root object.
+        """Updates the permissions on an app. Apps can inherit permissions from their root object.
 
         :param app_name: str
           The app for which to get or manage permissions.