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

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

@@ -1,5 +1,84 @@
 # Version changelog
 
+## Release v0.56.0
+
+### API Changes
+* Added `databricks.sdk.service.aibuilder`, `databricks.sdk.service.database` and `databricks.sdk.service.qualitymonitorv2` packages.
+* Added [w.custom_llms](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/aibuilder/custom_llms.html) workspace-level service.
+* Added [w.dashboard_email_subscriptions](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/settings/settings/dashboard_email_subscriptions.html) workspace-level service and [w.sql_results_download](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/settings/settings/sql_results_download.html) workspace-level service.
+* Added [w.database](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/database/database.html) workspace-level service.
+* Added [w.quality_monitor_v2](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/qualitymonitorv2/quality_monitor_v2.html) workspace-level service.
+* Added `update_private_endpoint_rule()` method for [a.network_connectivity](https://databricks-sdk-py.readthedocs.io/en/latest/account/settings/network_connectivity.html) account-level service.
+* Added `list_spaces()` method for [w.genie](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/dashboards/genie.html) workspace-level service.
+* Added `page_token` field for `databricks.sdk.service.billing.ListLogDeliveryRequest`.
+* Added `next_page_token` field for `databricks.sdk.service.billing.WrappedLogDeliveryConfigurations`.
+* Added `next_page_token` field for `databricks.sdk.service.catalog.EffectivePermissionsList`.
+* Added `max_results` and `page_token` fields for `databricks.sdk.service.catalog.GetEffectiveRequest`.
+* Added `max_results` and `page_token` fields for `databricks.sdk.service.catalog.GetGrantRequest`.
+* Added `next_page_token` field for `databricks.sdk.service.catalog.ListMetastoresResponse`.
+* Added `clean_room_name` field for `databricks.sdk.service.cleanrooms.CleanRoomAsset`.
+* [Breaking] Added `name` field for `databricks.sdk.service.cleanrooms.DeleteCleanRoomAssetRequest`.
+* [Breaking] Added `name` field for `databricks.sdk.service.cleanrooms.GetCleanRoomAssetRequest`.
+* Added `trigger_state` field for `databricks.sdk.service.jobs.BaseJob`.
+* Added `trigger_state` field for `databricks.sdk.service.jobs.Job`.
+* Added `dbt_cloud_output` field for `databricks.sdk.service.jobs.RunOutput`.
+* Added `dbt_cloud_task` field for `databricks.sdk.service.jobs.RunTask`.
+* Added `dbt_cloud_task` field for `databricks.sdk.service.jobs.SubmitTask`.
+* Added `dbt_cloud_task` field for `databricks.sdk.service.jobs.Task`.
+* Added `tags` field for `databricks.sdk.service.pipelines.CreatePipeline`.
+* Added `tags` field for `databricks.sdk.service.pipelines.EditPipeline`.
+* Added `tags` field for `databricks.sdk.service.pipelines.PipelineSpec`.
+* Added `max_provisioned_concurrency` and `min_provisioned_concurrency` fields for `databricks.sdk.service.serving.ServedEntityInput`.
+* Added `max_provisioned_concurrency` and `min_provisioned_concurrency` fields for `databricks.sdk.service.serving.ServedEntityOutput`.
+* Added `max_provisioned_concurrency` and `min_provisioned_concurrency` fields for `databricks.sdk.service.serving.ServedModelInput`.
+* Added `max_provisioned_concurrency` and `min_provisioned_concurrency` fields for `databricks.sdk.service.serving.ServedModelOutput`.
+* Added `endpoint_service` and `resource_names` fields for `databricks.sdk.service.settings.CreatePrivateEndpointRule`.
+* Added `aws_private_endpoint_rules` field for `databricks.sdk.service.settings.NccEgressTargetRules`.
+* Added `task_time_over_time_range` field for `databricks.sdk.service.sql.QueryMetrics`.
+* Added `deltasharing_catalog`, `foreign_catalog`, `internal_catalog`, `managed_catalog`, `managed_online_catalog`, `system_catalog` and `unknown_catalog_type` enum values for `databricks.sdk.service.catalog.CatalogType`.
+* Added `ga4_raw_data`, `power_bi`, `salesforce`, `salesforce_data_cloud`, `servicenow`, `unknown_connection_type` and `workday_raas` enum values for `databricks.sdk.service.catalog.ConnectionType`.
+* Added `oauth_access_token`, `oauth_m2m`, `oauth_refresh_token`, `oauth_resource_owner_password`, `oauth_u2m`, `oauth_u2m_mapping`, `oidc_token`, `pem_private_key`, `service_credential` and `unknown_credential_type` enum values for `databricks.sdk.service.catalog.CredentialType`.
+* Added `internal` and `internal_and_external` enum values for `databricks.sdk.service.catalog.DeltaSharingScopeEnum`.
+* Added `catalog`, `clean_room`, `connection`, `credential`, `external_location`, `external_metadata`, `function`, `metastore`, `pipeline`, `provider`, `recipient`, `schema`, `share`, `staging_table`, `storage_credential`, `table`, `unknown_securable_type` and `volume` enum values for `databricks.sdk.service.catalog.SecurableType`.
+* Added `cluster_migrated` enum value for `databricks.sdk.service.compute.EventType`.
+* Added `driver_unhealthy` enum value for `databricks.sdk.service.compute.TerminationReasonCode`.
+* Added `teradata` enum value for `databricks.sdk.service.pipelines.IngestionSourceType`.
+* Added `oidc_federation` enum value for `databricks.sdk.service.sharing.AuthenticationType`.
+* [Breaking] Changed `create()` method for [a.log_delivery](https://databricks-sdk-py.readthedocs.io/en/latest/account/billing/log_delivery.html) account-level service with new required argument order.
+* [Breaking] Changed `get()` method for [a.log_delivery](https://databricks-sdk-py.readthedocs.io/en/latest/account/billing/log_delivery.html) account-level service to return `databricks.sdk.service.billing.GetLogDeliveryConfigurationResponse` dataclass.
+* [Breaking] Changed `create_private_endpoint_rule()`, `delete_private_endpoint_rule()` and `get_private_endpoint_rule()` methods for [a.network_connectivity](https://databricks-sdk-py.readthedocs.io/en/latest/account/settings/network_connectivity.html) account-level service to return `databricks.sdk.service.settings.NccPrivateEndpointRule` dataclass.
+* [Breaking] Changed `list_private_endpoint_rules()` method for [a.network_connectivity](https://databricks-sdk-py.readthedocs.io/en/latest/account/settings/network_connectivity.html) account-level service to return `databricks.sdk.service.settings.ListPrivateEndpointRulesResponse` dataclass.
+* [Breaking] Changed `delete()` and `get()` methods for [w.clean_room_assets](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/cleanrooms/clean_room_assets.html) workspace-level service . Method path has changed.
+* [Breaking] Changed `delete()` and `get()` methods for [w.clean_room_assets](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/cleanrooms/clean_room_assets.html) workspace-level service with new required argument order.
+* [Breaking] Changed `get()` method for [w.grants](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/catalog/grants.html) workspace-level service to return `databricks.sdk.service.catalog.GetPermissionsResponse` dataclass.
+* [Breaking] Changed `update()` method for [w.grants](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/catalog/grants.html) workspace-level service to return `databricks.sdk.service.catalog.UpdatePermissionsResponse` dataclass.
+* [Breaking] Changed `list()` method for [w.metastores](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/catalog/metastores.html) workspace-level service to require request of `databricks.sdk.service.catalog.ListMetastoresRequest` dataclass.
+* Changed `account_id`, `credentials_id`, `log_type`, `output_format` and `storage_configuration_id` fields for `databricks.sdk.service.billing.LogDeliveryConfiguration` to be required.
+* Changed `message` and `status` fields for `databricks.sdk.service.billing.LogDeliveryStatus` to be required.
+* [Breaking] Changed `log_delivery_configuration` field for `databricks.sdk.service.billing.WrappedCreateLogDeliveryConfiguration` to be required.
+* [Breaking] Changed `securable_type` field for `databricks.sdk.service.catalog.ConnectionInfo` to type `databricks.sdk.service.catalog.SecurableType` dataclass.
+* [Breaking] Changed `securable_type` field for `databricks.sdk.service.catalog.GetEffectiveRequest` to type `str` dataclass.
+* [Breaking] Changed `securable_type` field for `databricks.sdk.service.catalog.GetGrantRequest` to type `str` dataclass.
+* [Breaking] Changed `delta_sharing_scope` field for `databricks.sdk.service.catalog.GetMetastoreSummaryResponse` to type `databricks.sdk.service.catalog.DeltaSharingScopeEnum` dataclass.
+* [Breaking] Changed `delta_sharing_scope` field for `databricks.sdk.service.catalog.MetastoreInfo` to type `databricks.sdk.service.catalog.DeltaSharingScopeEnum` dataclass.
+* [Breaking] Changed `catalog_type` field for `databricks.sdk.service.catalog.SchemaInfo` to type `databricks.sdk.service.catalog.CatalogType` dataclass.
+* [Breaking] Changed `delta_sharing_scope` field for `databricks.sdk.service.catalog.UpdateMetastore` to type `databricks.sdk.service.catalog.DeltaSharingScopeEnum` dataclass.
+* [Breaking] Changed `securable_type` field for `databricks.sdk.service.catalog.UpdatePermissions` to type `str` dataclass.
+* Changed `resource_id` field for `databricks.sdk.service.settings.CreatePrivateEndpointRule` to no longer be required.
+* [Breaking] Changed pagination for [NetworkConnectivityAPI.list_private_endpoint_rules](https://databricks-sdk-py.readthedocs.io/en/latest/account/settings/network_connectivity.html#databricks.sdk.service.settings.NetworkConnectivityAPI.list_private_endpoint_rules) method.
+* [Breaking] Removed [w.database_instances](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/catalog/database_instances.html) workspace-level service.
+* [Breaking] Removed [w.query_execution](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/dashboards/query_execution.html) workspace-level service.
+* [Breaking] Removed `update_ncc_azure_private_endpoint_rule_public()` method for [a.network_connectivity](https://databricks-sdk-py.readthedocs.io/en/latest/account/settings/network_connectivity.html) account-level service.
+* [Breaking] Removed `get_credentials_for_trace_data_download()`, `get_credentials_for_trace_data_upload()` and `list_logged_model_artifacts()` methods for [w.experiments](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/ml/experiments.html) workspace-level service.
+* [Breaking] Removed `get_published_dashboard_embedded()` method for [w.lakeview_embedded](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/dashboards/lakeview_embedded.html) workspace-level service.
+* [Breaking] Removed `asset_full_name` field for `databricks.sdk.service.cleanrooms.DeleteCleanRoomAssetRequest`.
+* [Breaking] Removed `asset_full_name` field for `databricks.sdk.service.cleanrooms.GetCleanRoomAssetRequest`.
+* [Breaking] Removed `internal` and `internal_and_external` enum values for `databricks.sdk.service.catalog.GetMetastoreSummaryResponseDeltaSharingScope`.
+* [Breaking] Removed `internal` and `internal_and_external` enum values for `databricks.sdk.service.catalog.MetastoreInfoDeltaSharingScope`.
+* [Breaking] Removed `catalog`, `clean_room`, `connection`, `credential`, `external_location`, `external_metadata`, `function`, `metastore`, `pipeline`, `provider`, `recipient`, `schema`, `share`, `staging_table`, `storage_credential`, `table`, `unknown_securable_type` and `volume` enum values for `databricks.sdk.service.catalog.SecurableType`.
+* [Breaking] Removed `internal` and `internal_and_external` enum values for `databricks.sdk.service.catalog.UpdateMetastoreDeltaSharingScope`.
+
+
 ## Release v0.55.0
 
 ### New Features and Improvements

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

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

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

@@ -13,12 +13,14 @@ from databricks.sdk.mixins.files import DbfsExt, FilesExt
 from databricks.sdk.mixins.jobs import JobsExt
 from databricks.sdk.mixins.open_ai_client import ServingEndpointsExt
 from databricks.sdk.mixins.workspace import WorkspaceExt
+from databricks.sdk.service import aibuilder as pkg_aibuilder
 from databricks.sdk.service import apps as pkg_apps
 from databricks.sdk.service import billing as pkg_billing
 from databricks.sdk.service import catalog as pkg_catalog
 from databricks.sdk.service import cleanrooms as pkg_cleanrooms
 from databricks.sdk.service import compute as pkg_compute
 from databricks.sdk.service import dashboards as pkg_dashboards
+from databricks.sdk.service import database as pkg_database
 from databricks.sdk.service import files as pkg_files
 from databricks.sdk.service import iam as pkg_iam
 from databricks.sdk.service import jobs as pkg_jobs
@@ -27,12 +29,14 @@ from databricks.sdk.service import ml as pkg_ml
 from databricks.sdk.service import oauth2 as pkg_oauth2
 from databricks.sdk.service import pipelines as pkg_pipelines
 from databricks.sdk.service import provisioning as pkg_provisioning
+from databricks.sdk.service import qualitymonitorv2 as pkg_qualitymonitorv2
 from databricks.sdk.service import serving as pkg_serving
 from databricks.sdk.service import settings as pkg_settings
 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.apps import AppsAPI
 from databricks.sdk.service.billing import (BillableUsageAPI, BudgetPolicyAPI,
                                             BudgetsAPI, LogDeliveryAPI,
@@ -42,7 +46,6 @@ from databricks.sdk.service.catalog import (AccountMetastoreAssignmentsAPI,
                                             AccountStorageCredentialsAPI,
                                             ArtifactAllowlistsAPI, CatalogsAPI,
                                             ConnectionsAPI, CredentialsAPI,
-                                            DatabaseInstancesAPI,
                                             ExternalLocationsAPI, FunctionsAPI,
                                             GrantsAPI, MetastoresAPI,
                                             ModelVersionsAPI, OnlineTablesAPI,
@@ -65,8 +68,8 @@ from databricks.sdk.service.compute import (ClusterPoliciesAPI, ClustersAPI,
                                             PolicyComplianceForClustersAPI,
                                             PolicyFamiliesAPI)
 from databricks.sdk.service.dashboards import (GenieAPI, LakeviewAPI,
-                                               LakeviewEmbeddedAPI,
-                                               QueryExecutionAPI)
+                                               LakeviewEmbeddedAPI)
+from databricks.sdk.service.database import DatabaseAPI
 from databricks.sdk.service.files import DbfsAPI, FilesAPI
 from databricks.sdk.service.iam import (AccessControlAPI,
                                         AccountAccessControlAPI,
@@ -98,6 +101,7 @@ from databricks.sdk.service.provisioning import (CredentialsAPI,
                                                  NetworksAPI, PrivateAccessAPI,
                                                  StorageAPI, VpcEndpointsAPI,
                                                  Workspace, WorkspacesAPI)
+from databricks.sdk.service.qualitymonitorv2 import QualityMonitorV2API
 from databricks.sdk.service.serving import (ServingEndpointsAPI,
                                             ServingEndpointsDataPlaneAPI)
 from databricks.sdk.service.settings import (
@@ -105,16 +109,17 @@ from databricks.sdk.service.settings import (
     AibiDashboardEmbeddingAccessPolicyAPI,
     AibiDashboardEmbeddingApprovedDomainsAPI, AutomaticClusterUpdateAPI,
     ComplianceSecurityProfileAPI, CredentialsManagerAPI,
-    CspEnablementAccountAPI, DefaultNamespaceAPI, DisableLegacyAccessAPI,
-    DisableLegacyDbfsAPI, DisableLegacyFeaturesAPI, EnableExportNotebookAPI,
-    EnableIpAccessListsAPI, EnableNotebookTableClipboardAPI,
-    EnableResultsDownloadingAPI, EnhancedSecurityMonitoringAPI,
-    EsmEnablementAccountAPI, IpAccessListsAPI,
+    CspEnablementAccountAPI, DashboardEmailSubscriptionsAPI,
+    DefaultNamespaceAPI, DisableLegacyAccessAPI, DisableLegacyDbfsAPI,
+    DisableLegacyFeaturesAPI, EnableExportNotebookAPI, EnableIpAccessListsAPI,
+    EnableNotebookTableClipboardAPI, EnableResultsDownloadingAPI,
+    EnhancedSecurityMonitoringAPI, EsmEnablementAccountAPI, IpAccessListsAPI,
     LlmProxyPartnerPoweredAccountAPI, LlmProxyPartnerPoweredEnforceAPI,
     LlmProxyPartnerPoweredWorkspaceAPI, NetworkConnectivityAPI,
     NetworkPoliciesAPI, NotificationDestinationsAPI, PersonalComputeAPI,
-    RestrictWorkspaceAdminsAPI, SettingsAPI, TokenManagementAPI, TokensAPI,
-    WorkspaceConfAPI, WorkspaceNetworkConfigurationAPI)
+    RestrictWorkspaceAdminsAPI, SettingsAPI, SqlResultsDownloadAPI,
+    TokenManagementAPI, TokensAPI, WorkspaceConfAPI,
+    WorkspaceNetworkConfigurationAPI)
 from databricks.sdk.service.sharing import (ProvidersAPI,
                                             RecipientActivationAPI,
                                             RecipientFederationPoliciesAPI,
@@ -251,10 +256,11 @@ 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)
-        self._database_instances = pkg_catalog.DatabaseInstancesAPI(self._api_client)
+        self._database = pkg_database.DatabaseAPI(self._api_client)
         self._dbfs = DbfsExt(self._api_client)
         self._dbsql_permissions = pkg_sql.DbsqlPermissionsAPI(self._api_client)
         self._experiments = pkg_ml.ExperimentsAPI(self._api_client)
@@ -294,10 +300,10 @@ class WorkspaceClient:
         )
         self._provider_providers = pkg_marketplace.ProviderProvidersAPI(self._api_client)
         self._providers = pkg_sharing.ProvidersAPI(self._api_client)
+        self._quality_monitor_v2 = pkg_qualitymonitorv2.QualityMonitorV2API(self._api_client)
         self._quality_monitors = pkg_catalog.QualityMonitorsAPI(self._api_client)
         self._queries = pkg_sql.QueriesAPI(self._api_client)
         self._queries_legacy = pkg_sql.QueriesLegacyAPI(self._api_client)
-        self._query_execution = pkg_dashboards.QueryExecutionAPI(self._api_client)
         self._query_history = pkg_sql.QueryHistoryAPI(self._api_client)
         self._query_visualizations = pkg_sql.QueryVisualizationsAPI(self._api_client)
         self._query_visualizations_legacy = pkg_sql.QueryVisualizationsLegacyAPI(self._api_client)
@@ -372,7 +378,7 @@ class WorkspaceClient:
 
     @property
     def alerts_v2(self) -> pkg_sql.AlertsV2API:
-        """TODO: Add description."""
+        """New version of SQL Alerts."""
         return self._alerts_v2
 
     @property
@@ -465,6 +471,11 @@ 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."""
@@ -481,9 +492,9 @@ class WorkspaceClient:
         return self._data_sources
 
     @property
-    def database_instances(self) -> pkg_catalog.DatabaseInstancesAPI:
+    def database(self) -> pkg_database.DatabaseAPI:
         """Database Instances provide access to a database via REST API or direct SQL."""
-        return self._database_instances
+        return self._database
 
     @property
     def dbfs(self) -> DbfsExt:
@@ -670,6 +681,11 @@ class WorkspaceClient:
         """A data provider is an object representing the organization in the real world who shares the data."""
         return self._providers
 
+    @property
+    def quality_monitor_v2(self) -> pkg_qualitymonitorv2.QualityMonitorV2API:
+        """Manage data quality of UC objects (currently support `schema`)."""
+        return self._quality_monitor_v2
+
     @property
     def quality_monitors(self) -> pkg_catalog.QualityMonitorsAPI:
         """A monitor computes and monitors data or model quality metrics for a table over time."""
@@ -685,11 +701,6 @@ class WorkspaceClient:
         """These endpoints are used for CRUD operations on query definitions."""
         return self._queries_legacy
 
-    @property
-    def query_execution(self) -> pkg_dashboards.QueryExecutionAPI:
-        """Query execution APIs for AI / BI Dashboards."""
-        return self._query_execution
-
     @property
     def query_history(self) -> pkg_sql.QueryHistoryAPI:
         """A service responsible for storing and retrieving the list of queries run against SQL endpoints and serverless compute."""
@@ -1021,7 +1032,7 @@ class AccountClient:
 
     @property
     def log_delivery(self) -> pkg_billing.LogDeliveryAPI:
-        """These APIs manage log delivery configurations for this account."""
+        """These APIs manage Log delivery configurations for this account."""
         return self._log_delivery
 
     @property
@@ -1116,7 +1127,7 @@ class AccountClient:
 
     @property
     def workspace_network_configuration(self) -> pkg_settings.WorkspaceNetworkConfigurationAPI:
-        """These APIs allow configuration of network settings for Databricks workspaces."""
+        """These APIs allow configuration of network settings for Databricks workspaces by selecting which network policy to associate with the workspace."""
         return self._workspace_network_configuration
 
     @property

databricks_sdk-0.56.0/databricks/sdk/service/aibuilder.py

@@ -0,0 +1,364 @@
+# Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+from __future__ import annotations
+
+import logging
+from dataclasses import dataclass
+from enum import Enum
+from typing import Any, Dict, List, Optional
+
+from ._internal import _enum, _from_dict, _repeated_dict
+
+_LOG = logging.getLogger("databricks.sdk")
+
+
+# all definitions in this file are in alphabetical order
+
+
+@dataclass
+class CancelCustomLlmOptimizationRunRequest:
+    id: Optional[str] = None
+
+
+@dataclass
+class CancelResponse:
+    def as_dict(self) -> dict:
+        """Serializes the CancelResponse 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."""
+        body = {}
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, Any]) -> CancelResponse:
+        """Deserializes the CancelResponse from a dictionary."""
+        return cls()
+
+
+@dataclass
+class CustomLlm:
+    name: str
+    """Name of the custom LLM"""
+
+    instructions: str
+    """Instructions for the custom LLM to follow"""
+
+    optimization_state: State
+    """If optimization is kicked off, tracks the state of the custom LLM"""
+
+    agent_artifact_path: Optional[str] = None
+
+    creation_time: Optional[str] = None
+    """Creation timestamp of the custom LLM"""
+
+    creator: Optional[str] = None
+    """Creator of the custom LLM"""
+
+    datasets: Optional[List[Dataset]] = None
+    """Datasets used for training and evaluating the model, not for inference"""
+
+    endpoint_name: Optional[str] = None
+    """Name of the endpoint that will be used to serve the custom LLM"""
+
+    guidelines: Optional[List[str]] = None
+    """Guidelines for the custom LLM to adhere to"""
+
+    id: Optional[str] = None
+
+    def as_dict(self) -> dict:
+        """Serializes the CustomLlm 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.creation_time is not None:
+            body["creation_time"] = self.creation_time
+        if self.creator is not None:
+            body["creator"] = self.creator
+        if self.datasets:
+            body["datasets"] = [v.as_dict() for v in self.datasets]
+        if self.endpoint_name is not None:
+            body["endpoint_name"] = self.endpoint_name
+        if self.guidelines:
+            body["guidelines"] = [v for v in self.guidelines]
+        if self.id is not None:
+            body["id"] = self.id
+        if self.instructions is not None:
+            body["instructions"] = self.instructions
+        if self.name is not None:
+            body["name"] = self.name
+        if self.optimization_state is not None:
+            body["optimization_state"] = self.optimization_state.value
+        return body
+
+    def as_shallow_dict(self) -> dict:
+        """Serializes the CustomLlm 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.creation_time is not None:
+            body["creation_time"] = self.creation_time
+        if self.creator is not None:
+            body["creator"] = self.creator
+        if self.datasets:
+            body["datasets"] = self.datasets
+        if self.endpoint_name is not None:
+            body["endpoint_name"] = self.endpoint_name
+        if self.guidelines:
+            body["guidelines"] = self.guidelines
+        if self.id is not None:
+            body["id"] = self.id
+        if self.instructions is not None:
+            body["instructions"] = self.instructions
+        if self.name is not None:
+            body["name"] = self.name
+        if self.optimization_state is not None:
+            body["optimization_state"] = self.optimization_state
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, Any]) -> CustomLlm:
+        """Deserializes the CustomLlm from a dictionary."""
+        return cls(
+            agent_artifact_path=d.get("agent_artifact_path", None),
+            creation_time=d.get("creation_time", None),
+            creator=d.get("creator", None),
+            datasets=_repeated_dict(d, "datasets", Dataset),
+            endpoint_name=d.get("endpoint_name", None),
+            guidelines=d.get("guidelines", None),
+            id=d.get("id", None),
+            instructions=d.get("instructions", None),
+            name=d.get("name", None),
+            optimization_state=_enum(d, "optimization_state", State),
+        )
+
+
+@dataclass
+class Dataset:
+    table: Table
+
+    def as_dict(self) -> dict:
+        """Serializes the Dataset into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.table:
+            body["table"] = self.table.as_dict()
+        return body
+
+    def as_shallow_dict(self) -> dict:
+        """Serializes the Dataset into a shallow dictionary of its immediate attributes."""
+        body = {}
+        if self.table:
+            body["table"] = self.table
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, Any]) -> Dataset:
+        """Deserializes the Dataset from a dictionary."""
+        return cls(table=_from_dict(d, "table", Table))
+
+
+@dataclass
+class StartCustomLlmOptimizationRunRequest:
+    id: Optional[str] = None
+    """The Id of the tile."""
+
+
+class State(Enum):
+    """States of Custom LLM optimization lifecycle."""
+
+    CANCELLED = "CANCELLED"
+    COMPLETED = "COMPLETED"
+    CREATED = "CREATED"
+    FAILED = "FAILED"
+    PENDING = "PENDING"
+    RUNNING = "RUNNING"
+
+
+@dataclass
+class Table:
+    table_path: str
+    """Full UC table path in catalog.schema.table_name format"""
+
+    request_col: str
+    """Name of the request column"""
+
+    response_col: Optional[str] = None
+    """Optional: Name of the response column if the data is labeled"""
+
+    def as_dict(self) -> dict:
+        """Serializes the Table into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.request_col is not None:
+            body["request_col"] = self.request_col
+        if self.response_col is not None:
+            body["response_col"] = self.response_col
+        if self.table_path is not None:
+            body["table_path"] = self.table_path
+        return body
+
+    def as_shallow_dict(self) -> dict:
+        """Serializes the Table into a shallow dictionary of its immediate attributes."""
+        body = {}
+        if self.request_col is not None:
+            body["request_col"] = self.request_col
+        if self.response_col is not None:
+            body["response_col"] = self.response_col
+        if self.table_path is not None:
+            body["table_path"] = self.table_path
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, Any]) -> Table:
+        """Deserializes the Table from a dictionary."""
+        return cls(
+            request_col=d.get("request_col", None),
+            response_col=d.get("response_col", None),
+            table_path=d.get("table_path", None),
+        )
+
+
+@dataclass
+class UpdateCustomLlmRequest:
+    custom_llm: CustomLlm
+    """The CustomLlm containing the fields which should be updated."""
+
+    update_mask: str
+    """The list of the CustomLlm fields to update. These should correspond to the values (or lack
+    thereof) present in `custom_llm`.
+    
+    The field mask must be a single string, with multiple fields separated by commas (no spaces).
+    The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields
+    (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed,
+    as only the entire collection field can be specified. Field names must exactly match the
+    resource field names.
+    
+    A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
+    fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the
+    API changes in the future."""
+
+    id: Optional[str] = None
+    """The id of the custom llm"""
+
+    def as_dict(self) -> dict:
+        """Serializes the UpdateCustomLlmRequest into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.custom_llm:
+            body["custom_llm"] = self.custom_llm.as_dict()
+        if self.id is not None:
+            body["id"] = self.id
+        if self.update_mask is not None:
+            body["update_mask"] = self.update_mask
+        return body
+
+    def as_shallow_dict(self) -> dict:
+        """Serializes the UpdateCustomLlmRequest into a shallow dictionary of its immediate attributes."""
+        body = {}
+        if self.custom_llm:
+            body["custom_llm"] = self.custom_llm
+        if self.id is not None:
+            body["id"] = self.id
+        if self.update_mask is not None:
+            body["update_mask"] = self.update_mask
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, Any]) -> UpdateCustomLlmRequest:
+        """Deserializes the UpdateCustomLlmRequest from a dictionary."""
+        return cls(
+            custom_llm=_from_dict(d, "custom_llm", CustomLlm),
+            id=d.get("id", None),
+            update_mask=d.get("update_mask", None),
+        )
+
+
+class CustomLlmsAPI:
+    """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):
+        """Cancel a Custom LLM Optimization Run.
+
+        :param id: str
+
+
+        """
+
+        headers = {
+            "Accept": "application/json",
+            "Content-Type": "application/json",
+        }
+
+        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.
+
+        :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 get(self, id: str) -> CustomLlm:
+        """Get a Custom LLM.
+
+        :param id: str
+          The id of the custom llm
+
+        :returns: :class:`CustomLlm`
+        """
+
+        headers = {
+            "Accept": "application/json",
+        }
+
+        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:
+        """Update a Custom LLM.
+
+        :param id: str
+          The id of the custom llm
+        :param custom_llm: :class:`CustomLlm`
+          The CustomLlm containing the fields which should be updated.
+        :param update_mask: str
+          The list of the CustomLlm fields to update. These should correspond to the values (or lack thereof)
+          present in `custom_llm`.
+
+          The field mask must be a single string, with multiple fields separated by commas (no spaces). The
+          field path is relative to the resource object, using a dot (`.`) to navigate sub-fields (e.g.,
+          `author.given_name`). Specification of elements in sequence or map fields is not allowed, as only
+          the entire collection field can be specified. Field names must exactly match the resource field
+          names.
+
+          A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
+          fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the API
+          changes in the future.
+
+        :returns: :class:`CustomLlm`
+        """
+        body = {}
+        if custom_llm is not None:
+            body["custom_llm"] = custom_llm.as_dict()
+        if update_mask is not None:
+            body["update_mask"] = update_mask
+        headers = {
+            "Accept": "application/json",
+            "Content-Type": "application/json",
+        }
+
+        res = self._api.do("PATCH", f"/api/2.0/custom-llms/{id}", body=body, headers=headers)
+        return CustomLlm.from_dict(res)