databricks-sdk 0.63.0__tar.gz → 0.65.0__tar.gz

{databricks_sdk-0.63.0 → databricks_sdk-0.65.0}/CHANGELOG.md

@@ -1,5 +1,52 @@
 # Version changelog
 
+## Release v0.65.0
+
+### New Features and Improvements
+
+* Added support for passing additional kwargs to `WorkspaceClient().serving_endpoints.get_open_ai_client()` ([#1025](https://github.com/databricks/databricks-sdk-py/pull/1025)). Users can now pass standard OpenAI client parameters like `timeout` and `max_retries` when creating an OpenAI client for Databricks Model Serving.
+
+### API Changes
+* Added `comment` field for `databricks.sdk.service.dashboards.GenieSendMessageFeedbackRequest`.
+* [Breaking] Added `rating` field for `databricks.sdk.service.dashboards.GenieSendMessageFeedbackRequest`.
+* Added `effective_enable_pg_native_login` and `enable_pg_native_login` fields for `databricks.sdk.service.database.DatabaseInstance`.
+* Added `task_retry_mode` field for `databricks.sdk.service.jobs.Continuous`.
+* Added `source_configurations` field for `databricks.sdk.service.pipelines.IngestionPipelineDefinition`.
+* Added `app_id`, `app_id_set`, `auth_secret`, `auth_secret_set`, `channel_url`, `channel_url_set`, `tenant_id` and `tenant_id_set` fields for `databricks.sdk.service.settings.MicrosoftTeamsConfig`.
+* Added `ensure_reranker_compatible` field for `databricks.sdk.service.vectorsearch.GetIndexRequest`.
+* Added `reranker` field for `databricks.sdk.service.vectorsearch.QueryVectorIndexRequest`.
+* [Breaking] Changed `create_clean_room_asset_review()` method 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 `send_message_feedback()` method for [w.genie](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/dashboards/genie.html) workspace-level service with new required argument order.
+* Changed `notebook_review` field for `databricks.sdk.service.cleanrooms.CreateCleanRoomAssetReviewRequest` to no longer be required.
+* [Breaking] Changed `features` field for `databricks.sdk.service.ml.FeatureList` to type list[`databricks.sdk.service.ml.LinkedFeature`] dataclass.
+* [Breaking] Removed `feedback_rating` and `feedback_text` fields for `databricks.sdk.service.dashboards.GenieSendMessageFeedbackRequest`.
+
+
+## Release v0.64.0
+
+### API Changes
+* Added `databricks.sdk.service.settingsv2` and `databricks.sdk.service.tags` packages.
+* Added [w.apps_settings](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/apps/apps_settings.html) workspace-level service.
+* Added [w.entity_tag_assignments](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/catalog/entity_tag_assignments.html) workspace-level service and [w.rfa](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/catalog/rfa.html) workspace-level service.
+* Added [a.account_settings_v2](https://databricks-sdk-py.readthedocs.io/en/latest/account/settingsv2/account_settings_v2.html) account-level service and [w.workspace_settings_v2](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/settingsv2/workspace_settings_v2.html) workspace-level service.
+* Added [w.tag_policies](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/tags/tag_policies.html) workspace-level service.
+* Added `delete_conversation_message()`, `list_conversation_messages()` and `send_message_feedback()` methods for [w.genie](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/dashboards/genie.html) workspace-level service.
+* Added `include_all` field for `databricks.sdk.service.dashboards.GenieListConversationsRequest`.
+* Added `effective_usage_policy_id` field for `databricks.sdk.service.jobs.BaseJob`.
+* Added `effective_usage_policy_id` field for `databricks.sdk.service.jobs.BaseRun`.
+* Added `effective_usage_policy_id` field for `databricks.sdk.service.jobs.Job`.
+* Added `effective_usage_policy_id` field for `databricks.sdk.service.jobs.Run`.
+* Added `tokens` field for `databricks.sdk.service.serving.AiGatewayRateLimit`.
+* Added `usage_policy_id` field for `databricks.sdk.service.serving.ServingEndpoint`.
+* Added `effective_run_as` and `run_as` fields for `databricks.sdk.service.sql.AlertV2`.
+* Added `cache_query_id` field for `databricks.sdk.service.sql.QueryInfo`.
+* Added `model_endpoint_name_for_query` field for `databricks.sdk.service.vectorsearch.EmbeddingSourceColumn`.
+* [Breaking] Removed `environment_settings` field for `databricks.sdk.service.catalog.ConnectionInfo`.
+* [Breaking] Removed `environment_settings` field for `databricks.sdk.service.catalog.CreateConnection`.
+* [Breaking] Removed `environment_settings` field for `databricks.sdk.service.catalog.UpdateConnection`.
+* [Breaking] Removed `comment`, `display_name` and `tags` fields for `databricks.sdk.service.sharing.Share`.
+
+
 ## Release v0.63.0
 
 ### API Changes

{databricks_sdk-0.63.0 → databricks_sdk-0.65.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: databricks-sdk
-Version: 0.63.0
+Version: 0.65.0
 Summary: Databricks SDK for Python (Beta)
 Project-URL: Documentation, https://databricks-sdk-py.readthedocs.io
 Keywords: databricks,sdk
@@ -26,7 +26,7 @@ Requires-Dist: google-auth~=2.0
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: pytest-xdist; extra == "dev"
+Requires-Dist: pytest-xdist<4.0,>=3.6.1; extra == "dev"
 Requires-Dist: pytest-mock; extra == "dev"
 Requires-Dist: black; extra == "dev"
 Requires-Dist: pycodestyle; extra == "dev"

{databricks_sdk-0.63.0 → databricks_sdk-0.65.0}/databricks/sdk/__init__.py

@@ -32,12 +32,14 @@ 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 settingsv2 as pkg_settingsv2
 from databricks.sdk.service import sharing as pkg_sharing
 from databricks.sdk.service import sql as pkg_sql
+from databricks.sdk.service import tags as pkg_tags
 from databricks.sdk.service import vectorsearch as pkg_vectorsearch
 from databricks.sdk.service import workspace as pkg_workspace
 from databricks.sdk.service.agentbricks import AgentBricksAPI
-from databricks.sdk.service.apps import AppsAPI
+from databricks.sdk.service.apps import AppsAPI, AppsSettingsAPI
 from databricks.sdk.service.billing import (BillableUsageAPI, BudgetPolicyAPI,
                                             BudgetsAPI, LogDeliveryAPI,
                                             UsageDashboardsAPI)
@@ -46,6 +48,7 @@ from databricks.sdk.service.catalog import (AccountMetastoreAssignmentsAPI,
                                             AccountStorageCredentialsAPI,
                                             ArtifactAllowlistsAPI, CatalogsAPI,
                                             ConnectionsAPI, CredentialsAPI,
+                                            EntityTagAssignmentsAPI,
                                             ExternalLineageAPI,
                                             ExternalLocationsAPI,
                                             ExternalMetadataAPI, FunctionsAPI,
@@ -53,8 +56,8 @@ from databricks.sdk.service.catalog import (AccountMetastoreAssignmentsAPI,
                                             ModelVersionsAPI, OnlineTablesAPI,
                                             PoliciesAPI, QualityMonitorsAPI,
                                             RegisteredModelsAPI,
-                                            ResourceQuotasAPI, SchemasAPI,
-                                            StorageCredentialsAPI,
+                                            ResourceQuotasAPI, RfaAPI,
+                                            SchemasAPI, StorageCredentialsAPI,
                                             SystemSchemasAPI,
                                             TableConstraintsAPI, TablesAPI,
                                             TemporaryPathCredentialsAPI,
@@ -128,6 +131,8 @@ from databricks.sdk.service.settings import (
     RestrictWorkspaceAdminsAPI, SettingsAPI, SqlResultsDownloadAPI,
     TokenManagementAPI, TokensAPI, WorkspaceConfAPI,
     WorkspaceNetworkConfigurationAPI)
+from databricks.sdk.service.settingsv2 import (AccountSettingsV2API,
+                                               WorkspaceSettingsV2API)
 from databricks.sdk.service.sharing import (ProvidersAPI,
                                             RecipientActivationAPI,
                                             RecipientFederationPoliciesAPI,
@@ -141,6 +146,7 @@ from databricks.sdk.service.sql import (AlertsAPI, AlertsLegacyAPI,
                                         QueryVisualizationsLegacyAPI,
                                         RedashConfigAPI, StatementExecutionAPI,
                                         WarehousesAPI)
+from databricks.sdk.service.tags import TagPoliciesAPI
 from databricks.sdk.service.vectorsearch import (VectorSearchEndpointsAPI,
                                                  VectorSearchIndexesAPI)
 from databricks.sdk.service.workspace import (GitCredentialsAPI, ReposAPI,
@@ -248,6 +254,7 @@ class WorkspaceClient:
         self._alerts_legacy = pkg_sql.AlertsLegacyAPI(self._api_client)
         self._alerts_v2 = pkg_sql.AlertsV2API(self._api_client)
         self._apps = pkg_apps.AppsAPI(self._api_client)
+        self._apps_settings = pkg_apps.AppsSettingsAPI(self._api_client)
         self._artifact_allowlists = pkg_catalog.ArtifactAllowlistsAPI(self._api_client)
         self._catalogs = pkg_catalog.CatalogsAPI(self._api_client)
         self._clean_room_asset_revisions = pkg_cleanrooms.CleanRoomAssetRevisionsAPI(self._api_client)
@@ -273,6 +280,7 @@ class WorkspaceClient:
         self._database = pkg_database.DatabaseAPI(self._api_client)
         self._dbfs = DbfsExt(self._api_client)
         self._dbsql_permissions = pkg_sql.DbsqlPermissionsAPI(self._api_client)
+        self._entity_tag_assignments = pkg_catalog.EntityTagAssignmentsAPI(self._api_client)
         self._experiments = pkg_ml.ExperimentsAPI(self._api_client)
         self._external_lineage = pkg_catalog.ExternalLineageAPI(self._api_client)
         self._external_locations = pkg_catalog.ExternalLocationsAPI(self._api_client)
@@ -329,6 +337,7 @@ class WorkspaceClient:
         self._registered_models = pkg_catalog.RegisteredModelsAPI(self._api_client)
         self._repos = pkg_workspace.ReposAPI(self._api_client)
         self._resource_quotas = pkg_catalog.ResourceQuotasAPI(self._api_client)
+        self._rfa = pkg_catalog.RfaAPI(self._api_client)
         self._schemas = pkg_catalog.SchemasAPI(self._api_client)
         self._secrets = pkg_workspace.SecretsAPI(self._api_client)
         self._service_principal_secrets_proxy = pkg_oauth2.ServicePrincipalSecretsProxyAPI(self._api_client)
@@ -347,6 +356,7 @@ class WorkspaceClient:
         self._system_schemas = pkg_catalog.SystemSchemasAPI(self._api_client)
         self._table_constraints = pkg_catalog.TableConstraintsAPI(self._api_client)
         self._tables = pkg_catalog.TablesAPI(self._api_client)
+        self._tag_policies = pkg_tags.TagPoliciesAPI(self._api_client)
         self._temporary_path_credentials = pkg_catalog.TemporaryPathCredentialsAPI(self._api_client)
         self._temporary_table_credentials = pkg_catalog.TemporaryTableCredentialsAPI(self._api_client)
         self._token_management = pkg_settings.TokenManagementAPI(self._api_client)
@@ -359,6 +369,7 @@ class WorkspaceClient:
         self._workspace = WorkspaceExt(self._api_client)
         self._workspace_bindings = pkg_catalog.WorkspaceBindingsAPI(self._api_client)
         self._workspace_conf = pkg_settings.WorkspaceConfAPI(self._api_client)
+        self._workspace_settings_v2 = pkg_settingsv2.WorkspaceSettingsV2API(self._api_client)
         self._forecasting = pkg_ml.ForecastingAPI(self._api_client)
 
     @property
@@ -408,6 +419,11 @@ class WorkspaceClient:
         """Apps run directly on a customer’s Databricks instance, integrate with their data, use and extend Databricks services, and enable users to interact through single sign-on."""
         return self._apps
 
+    @property
+    def apps_settings(self) -> pkg_apps.AppsSettingsAPI:
+        """Apps Settings manage the settings for the Apps service on a customer's Databricks instance."""
+        return self._apps_settings
+
     @property
     def artifact_allowlists(self) -> pkg_catalog.ArtifactAllowlistsAPI:
         """In Databricks Runtime 13.3 and above, you can add libraries and init scripts to the `allowlist` in UC so that users can leverage these artifacts on compute configured with shared access mode."""
@@ -533,6 +549,11 @@ class WorkspaceClient:
         """The SQL Permissions API is similar to the endpoints of the :method:permissions/set."""
         return self._dbsql_permissions
 
+    @property
+    def entity_tag_assignments(self) -> pkg_catalog.EntityTagAssignmentsAPI:
+        """Tags are attributes that include keys and optional values that you can use to organize and categorize entities in Unity Catalog."""
+        return self._entity_tag_assignments
+
     @property
     def experiments(self) -> pkg_ml.ExperimentsAPI:
         """Experiments are the primary unit of organization in MLflow; all MLflow runs belong to an experiment."""
@@ -803,6 +824,11 @@ class WorkspaceClient:
         """Unity Catalog enforces resource quotas on all securable objects, which limits the number of resources that can be created."""
         return self._resource_quotas
 
+    @property
+    def rfa(self) -> pkg_catalog.RfaAPI:
+        """Request for Access enables customers to request access to and manage access request destinations for Unity Catalog securables."""
+        return self._rfa
+
     @property
     def schemas(self) -> pkg_catalog.SchemasAPI:
         """A schema (also called a database) is the second layer of Unity Catalog’s three-level namespace."""
@@ -868,6 +894,11 @@ class WorkspaceClient:
         """A table resides in the third layer of Unity Catalog’s three-level namespace."""
         return self._tables
 
+    @property
+    def tag_policies(self) -> pkg_tags.TagPoliciesAPI:
+        """The Tag Policy API allows you to manage tag policies in Databricks."""
+        return self._tag_policies
+
     @property
     def temporary_path_credentials(self) -> pkg_catalog.TemporaryPathCredentialsAPI:
         """Temporary Path Credentials refer to short-lived, downscoped credentials used to access external cloud storage locations registered in Databricks."""
@@ -928,6 +959,11 @@ class WorkspaceClient:
         """This API allows updating known workspace settings for advanced users."""
         return self._workspace_conf
 
+    @property
+    def workspace_settings_v2(self) -> pkg_settingsv2.WorkspaceSettingsV2API:
+        """APIs to manage workspace level settings."""
+        return self._workspace_settings_v2
+
     @property
     def forecasting(self) -> pkg_ml.ForecastingAPI:
         """The Forecasting API allows you to create and get serverless forecasting experiments."""
@@ -1029,6 +1065,7 @@ class AccountClient:
         self._service_principal_secrets = pkg_oauth2.ServicePrincipalSecretsAPI(self._api_client)
         self._service_principals = pkg_iam.AccountServicePrincipalsAPI(self._api_client)
         self._settings = pkg_settings.AccountSettingsAPI(self._api_client)
+        self._settings_v2 = pkg_settingsv2.AccountSettingsV2API(self._api_client)
         self._storage = pkg_provisioning.StorageAPI(self._api_client)
         self._storage_credentials = pkg_catalog.AccountStorageCredentialsAPI(self._api_client)
         self._usage_dashboards = pkg_billing.UsageDashboardsAPI(self._api_client)
@@ -1157,6 +1194,11 @@ class AccountClient:
         """Accounts Settings API allows users to manage settings at the account level."""
         return self._settings
 
+    @property
+    def settings_v2(self) -> pkg_settingsv2.AccountSettingsV2API:
+        """APIs to manage account level settings."""
+        return self._settings_v2
+
     @property
     def storage(self) -> pkg_provisioning.StorageAPI:
         """These APIs manage storage configurations for this workspace."""

{databricks_sdk-0.63.0 → databricks_sdk-0.65.0}/databricks/sdk/mixins/open_ai_client.py

@@ -31,7 +31,41 @@ class ServingEndpointsExt(ServingEndpointsAPI):
         http_client = httpx.Client(auth=databricks_token_auth)
         return http_client
 
-    def get_open_ai_client(self):
+    def get_open_ai_client(self, **kwargs):
+        """Create an OpenAI client configured for Databricks Model Serving.
+
+        Returns an OpenAI client instance that is pre-configured to send requests to
+        Databricks Model Serving endpoints. The client uses Databricks authentication
+        to query endpoints within the workspace associated with the current WorkspaceClient
+        instance.
+
+        Args:
+            **kwargs: Additional parameters to pass to the OpenAI client constructor.
+                Common parameters include:
+                - timeout (float): Request timeout in seconds (e.g., 30.0)
+                - max_retries (int): Maximum number of retries for failed requests (e.g., 3)
+                - default_headers (dict): Additional headers to include with requests
+                - default_query (dict): Additional query parameters to include with requests
+
+                Any parameter accepted by the OpenAI client constructor can be passed here,
+                except for the following parameters which are reserved for Databricks integration:
+                base_url, api_key, http_client
+
+        Returns:
+            OpenAI: An OpenAI client instance configured for Databricks Model Serving.
+
+        Raises:
+            ImportError: If the OpenAI library is not installed.
+            ValueError: If any reserved Databricks parameters are provided in kwargs.
+
+        Example:
+            >>> client = workspace_client.serving_endpoints.get_open_ai_client()
+            >>> # With custom timeout and retries
+            >>> client = workspace_client.serving_endpoints.get_open_ai_client(
+            ...     timeout=30.0,
+            ...     max_retries=5
+            ... )
+        """
         try:
             from openai import OpenAI
         except Exception:
@@ -39,11 +73,26 @@ class ServingEndpointsExt(ServingEndpointsAPI):
                 "Open AI is not installed. Please install the Databricks SDK with the following command `pip install databricks-sdk[openai]`"
             )
 
-        return OpenAI(
-            base_url=self._api._cfg.host + "/serving-endpoints",
-            api_key="no-token",  # Passing in a placeholder to pass validations, this will not be used
-            http_client=self._get_authorized_http_client(),
-        )
+        # Check for reserved parameters that should not be overridden
+        reserved_params = {"base_url", "api_key", "http_client"}
+        conflicting_params = reserved_params.intersection(kwargs.keys())
+        if conflicting_params:
+            raise ValueError(
+                f"Cannot override reserved Databricks parameters: {', '.join(sorted(conflicting_params))}. "
+                f"These parameters are automatically configured for Databricks Model Serving."
+            )
+
+        # Default parameters that are required for Databricks integration
+        client_params = {
+            "base_url": self._api._cfg.host + "/serving-endpoints",
+            "api_key": "no-token",  # Passing in a placeholder to pass validations, this will not be used
+            "http_client": self._get_authorized_http_client(),
+        }
+
+        # Update with any additional parameters passed by the user
+        client_params.update(kwargs)
+
+        return OpenAI(**client_params)
 
     def get_langchain_chat_open_ai_client(self, model):
         try:

{databricks_sdk-0.63.0 → databricks_sdk-0.65.0}/databricks/sdk/service/agentbricks.py

@@ -227,9 +227,9 @@ class AgentBricksAPI:
         :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.
+          This will soon be deprecated!! 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.