databricks-sdk 0.56.0__py3-none-any.whl → 0.58.0__py3-none-any.whl

databricks/sdk/service/qualitymonitorv2.py

@@ -63,24 +63,6 @@ class AnomalyDetectionRunStatus(Enum):
     ANOMALY_DETECTION_RUN_STATUS_WORKSPACE_MISMATCH_ERROR = "ANOMALY_DETECTION_RUN_STATUS_WORKSPACE_MISMATCH_ERROR"
 
 
-@dataclass
-class DeleteQualityMonitorResponse:
-    def as_dict(self) -> dict:
-        """Serializes the DeleteQualityMonitorResponse into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the DeleteQualityMonitorResponse into a shallow dictionary of its immediate attributes."""
-        body = {}
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> DeleteQualityMonitorResponse:
-        """Deserializes the DeleteQualityMonitorResponse from a dictionary."""
-        return cls()
-
-
 @dataclass
 class ListQualityMonitorResponse:
     next_page_token: Optional[str] = None
@@ -163,9 +145,7 @@ class QualityMonitorV2API:
         self._api = api_client
 
     def create_quality_monitor(self, quality_monitor: QualityMonitor) -> QualityMonitor:
-        """Create a quality monitor.
-
-        Create a quality monitor on UC object
+        """Create a quality monitor on UC object
 
         :param quality_monitor: :class:`QualityMonitor`
 
@@ -181,9 +161,7 @@ class QualityMonitorV2API:
         return QualityMonitor.from_dict(res)
 
     def delete_quality_monitor(self, object_type: str, object_id: str):
-        """Delete a quality monitor.
-
-        Delete a quality monitor on UC object
+        """Delete a quality monitor on UC object
 
         :param object_type: str
           The type of the monitored object. Can be one of the following: schema.
@@ -200,9 +178,7 @@ class QualityMonitorV2API:
         self._api.do("DELETE", f"/api/2.0/quality-monitors/{object_type}/{object_id}", headers=headers)
 
     def get_quality_monitor(self, object_type: str, object_id: str) -> QualityMonitor:
-        """Read a quality monitor.
-
-        Read a quality monitor on UC object
+        """Read a quality monitor on UC object
 
         :param object_type: str
           The type of the monitored object. Can be one of the following: schema.
@@ -222,9 +198,7 @@ class QualityMonitorV2API:
     def list_quality_monitor(
         self, *, page_size: Optional[int] = None, page_token: Optional[str] = None
     ) -> Iterator[QualityMonitor]:
-        """List quality monitors.
-
-        (Unimplemented) List quality monitors
+        """(Unimplemented) List quality monitors
 
         :param page_size: int (optional)
         :param page_token: str (optional)
@@ -253,9 +227,7 @@ class QualityMonitorV2API:
     def update_quality_monitor(
         self, object_type: str, object_id: str, quality_monitor: QualityMonitor
     ) -> QualityMonitor:
-        """Update a quality monitor.
-
-        (Unimplemented) Update a quality monitor on UC object
+        """(Unimplemented) Update a quality monitor on UC object
 
         :param object_type: str
           The type of the monitored object. Can be one of the following: schema.

databricks/sdk/service/serving.py

@@ -306,8 +306,12 @@ class AiGatewayRateLimit:
     """Renewal period field for a rate limit. Currently, only 'minute' is supported."""
 
     key: Optional[AiGatewayRateLimitKey] = None
-    """Key field for a rate limit. Currently, only 'user' and 'endpoint' are supported, with 'endpoint'
-    being the default if not specified."""
+    """Key field for a rate limit. Currently, 'user', 'user_group, 'service_principal', and 'endpoint'
+    are supported, with 'endpoint' being the default if not specified."""
+
+    principal: Optional[str] = None
+    """Principal field for a user, user group, or service principal to apply rate limiting to. Accepts
+    a user email, group name, or service principal application ID."""
 
     def as_dict(self) -> dict:
         """Serializes the AiGatewayRateLimit into a dictionary suitable for use as a JSON request body."""
@@ -316,6 +320,8 @@ class AiGatewayRateLimit:
             body["calls"] = self.calls
         if self.key is not None:
             body["key"] = self.key.value
+        if self.principal is not None:
+            body["principal"] = self.principal
         if self.renewal_period is not None:
             body["renewal_period"] = self.renewal_period.value
         return body
@@ -327,6 +333,8 @@ class AiGatewayRateLimit:
             body["calls"] = self.calls
         if self.key is not None:
             body["key"] = self.key
+        if self.principal is not None:
+            body["principal"] = self.principal
         if self.renewal_period is not None:
             body["renewal_period"] = self.renewal_period
         return body
@@ -337,6 +345,7 @@ class AiGatewayRateLimit:
         return cls(
             calls=d.get("calls", None),
             key=_enum(d, "key", AiGatewayRateLimitKey),
+            principal=d.get("principal", None),
             renewal_period=_enum(d, "renewal_period", AiGatewayRateLimitRenewalPeriod),
         )
 
@@ -344,7 +353,9 @@ class AiGatewayRateLimit:
 class AiGatewayRateLimitKey(Enum):
 
     ENDPOINT = "endpoint"
+    SERVICE_PRINCIPAL = "service_principal"
     USER = "user"
+    USER_GROUP = "user_group"
 
 
 class AiGatewayRateLimitRenewalPeriod(Enum):
@@ -919,6 +930,8 @@ class CreateServingEndpoint:
     config: Optional[EndpointCoreConfigInput] = None
     """The core config of the serving endpoint."""
 
+    description: Optional[str] = None
+
     rate_limits: Optional[List[RateLimit]] = None
     """Rate limits to be applied to the serving endpoint. NOTE: this field is deprecated, please use AI
     Gateway to manage rate limits."""
@@ -938,6 +951,8 @@ class CreateServingEndpoint:
             body["budget_policy_id"] = self.budget_policy_id
         if self.config:
             body["config"] = self.config.as_dict()
+        if self.description is not None:
+            body["description"] = self.description
         if self.name is not None:
             body["name"] = self.name
         if self.rate_limits:
@@ -957,6 +972,8 @@ class CreateServingEndpoint:
             body["budget_policy_id"] = self.budget_policy_id
         if self.config:
             body["config"] = self.config
+        if self.description is not None:
+            body["description"] = self.description
         if self.name is not None:
             body["name"] = self.name
         if self.rate_limits:
@@ -974,6 +991,7 @@ class CreateServingEndpoint:
             ai_gateway=_from_dict(d, "ai_gateway", AiGatewayConfig),
             budget_policy_id=d.get("budget_policy_id", None),
             config=_from_dict(d, "config", EndpointCoreConfigInput),
+            description=d.get("description", None),
             name=d.get("name", None),
             rate_limits=_repeated_dict(d, "rate_limits", RateLimit),
             route_optimized=d.get("route_optimized", None),
@@ -2945,16 +2963,20 @@ class RateLimitRenewalPeriod(Enum):
 
 @dataclass
 class Route:
-    served_model_name: str
-    """The name of the served model this route configures traffic for."""
-
     traffic_percentage: int
     """The percentage of endpoint traffic to send to this route. It must be an integer between 0 and
     100 inclusive."""
 
+    served_entity_name: Optional[str] = None
+
+    served_model_name: Optional[str] = None
+    """The name of the served model this route configures traffic for."""
+
     def as_dict(self) -> dict:
         """Serializes the Route into a dictionary suitable for use as a JSON request body."""
         body = {}
+        if self.served_entity_name is not None:
+            body["served_entity_name"] = self.served_entity_name
         if self.served_model_name is not None:
             body["served_model_name"] = self.served_model_name
         if self.traffic_percentage is not None:
@@ -2964,6 +2986,8 @@ class Route:
     def as_shallow_dict(self) -> dict:
         """Serializes the Route into a shallow dictionary of its immediate attributes."""
         body = {}
+        if self.served_entity_name is not None:
+            body["served_entity_name"] = self.served_entity_name
         if self.served_model_name is not None:
             body["served_model_name"] = self.served_model_name
         if self.traffic_percentage is not None:
@@ -2974,7 +2998,9 @@ class Route:
     def from_dict(cls, d: Dict[str, Any]) -> Route:
         """Deserializes the Route from a dictionary."""
         return cls(
-            served_model_name=d.get("served_model_name", None), traffic_percentage=d.get("traffic_percentage", None)
+            served_entity_name=d.get("served_entity_name", None),
+            served_model_name=d.get("served_model_name", None),
+            traffic_percentage=d.get("traffic_percentage", None),
         )
 
 
@@ -3164,8 +3190,6 @@ class ServedEntityOutput:
     external_model later. The task type of all external models within an endpoint must be the same."""
 
     foundation_model: Optional[FoundationModel] = None
-    """All fields are not sensitive as they are hard-coded in the system and made available to
-    customers."""
 
     instance_profile_arn: Optional[str] = None
     """ARN of the instance profile that the served entity uses to access AWS resources."""
@@ -3331,8 +3355,6 @@ class ServedEntitySpec:
     external_model: Optional[ExternalModel] = None
 
     foundation_model: Optional[FoundationModel] = None
-    """All fields are not sensitive as they are hard-coded in the system and made available to
-    customers."""
 
     name: Optional[str] = None
 
@@ -3799,6 +3821,9 @@ class ServingEndpoint:
     creator: Optional[str] = None
     """The email of the user who created the serving endpoint."""
 
+    description: Optional[str] = None
+    """Description of the endpoint"""
+
     id: Optional[str] = None
     """System-generated ID of the endpoint, included to be used by the Permissions API."""
 
@@ -3830,6 +3855,8 @@ class ServingEndpoint:
             body["creation_timestamp"] = self.creation_timestamp
         if self.creator is not None:
             body["creator"] = self.creator
+        if self.description is not None:
+            body["description"] = self.description
         if self.id is not None:
             body["id"] = self.id
         if self.last_updated_timestamp is not None:
@@ -3857,6 +3884,8 @@ class ServingEndpoint:
             body["creation_timestamp"] = self.creation_timestamp
         if self.creator is not None:
             body["creator"] = self.creator
+        if self.description is not None:
+            body["description"] = self.description
         if self.id is not None:
             body["id"] = self.id
         if self.last_updated_timestamp is not None:
@@ -3880,6 +3909,7 @@ class ServingEndpoint:
             config=_from_dict(d, "config", EndpointCoreConfigSummary),
             creation_timestamp=d.get("creation_timestamp", None),
             creator=d.get("creator", None),
+            description=d.get("description", None),
             id=d.get("id", None),
             last_updated_timestamp=d.get("last_updated_timestamp", None),
             name=d.get("name", None),
@@ -3895,7 +3925,6 @@ class ServingEndpointAccessControlRequest:
     """name of the group"""
 
     permission_level: Optional[ServingEndpointPermissionLevel] = None
-    """Permission level"""
 
     service_principal_name: Optional[str] = None
     """application ID of a service principal"""
@@ -4021,6 +4050,9 @@ class ServingEndpointDetailed:
     data_plane_info: Optional[ModelDataPlaneInfo] = None
     """Information required to query DataPlane APIs."""
 
+    description: Optional[str] = None
+    """Description of the serving model"""
+
     endpoint_url: Optional[str] = None
     """Endpoint invocation url if route optimization is enabled for endpoint"""
 
@@ -4067,6 +4099,8 @@ class ServingEndpointDetailed:
             body["creator"] = self.creator
         if self.data_plane_info:
             body["data_plane_info"] = self.data_plane_info.as_dict()
+        if self.description is not None:
+            body["description"] = self.description
         if self.endpoint_url is not None:
             body["endpoint_url"] = self.endpoint_url
         if self.id is not None:
@@ -4104,6 +4138,8 @@ class ServingEndpointDetailed:
             body["creator"] = self.creator
         if self.data_plane_info:
             body["data_plane_info"] = self.data_plane_info
+        if self.description is not None:
+            body["description"] = self.description
         if self.endpoint_url is not None:
             body["endpoint_url"] = self.endpoint_url
         if self.id is not None:
@@ -4136,6 +4172,7 @@ class ServingEndpointDetailed:
             creation_timestamp=d.get("creation_timestamp", None),
             creator=d.get("creator", None),
             data_plane_info=_from_dict(d, "data_plane_info", ModelDataPlaneInfo),
+            description=d.get("description", None),
             endpoint_url=d.get("endpoint_url", None),
             id=d.get("id", None),
             last_updated_timestamp=d.get("last_updated_timestamp", None),
@@ -4163,7 +4200,6 @@ class ServingEndpointPermission:
     inherited_from_object: Optional[List[str]] = None
 
     permission_level: Optional[ServingEndpointPermissionLevel] = None
-    """Permission level"""
 
     def as_dict(self) -> dict:
         """Serializes the ServingEndpointPermission into a dictionary suitable for use as a JSON request body."""
@@ -4250,7 +4286,6 @@ class ServingEndpointPermissionsDescription:
     description: Optional[str] = None
 
     permission_level: Optional[ServingEndpointPermissionLevel] = None
-    """Permission level"""
 
     def as_dict(self) -> dict:
         """Serializes the ServingEndpointPermissionsDescription into a dictionary suitable for use as a JSON request body."""
@@ -4489,9 +4524,7 @@ class ServingEndpointsAPI:
         raise TimeoutError(f"timed out after {timeout}: {status_message}")
 
     def build_logs(self, name: str, served_model_name: str) -> BuildLogsResponse:
-        """Get build logs for a served model.
-
-        Retrieves the build logs associated with the provided served model.
+        """Retrieves the build logs associated with the provided served model.
 
         :param name: str
           The name of the serving endpoint that the served model belongs to. This field is required.
@@ -4517,6 +4550,7 @@ class ServingEndpointsAPI:
         ai_gateway: Optional[AiGatewayConfig] = None,
         budget_policy_id: Optional[str] = None,
         config: Optional[EndpointCoreConfigInput] = None,
+        description: Optional[str] = None,
         rate_limits: Optional[List[RateLimit]] = None,
         route_optimized: Optional[bool] = None,
         tags: Optional[List[EndpointTag]] = None,
@@ -4534,6 +4568,7 @@ class ServingEndpointsAPI:
           The budget policy to be applied to the serving endpoint.
         :param config: :class:`EndpointCoreConfigInput` (optional)
           The core config of the serving endpoint.
+        :param description: str (optional)
         :param rate_limits: List[:class:`RateLimit`] (optional)
           Rate limits to be applied to the serving endpoint. NOTE: this field is deprecated, please use AI
           Gateway to manage rate limits.
@@ -4553,6 +4588,8 @@ class ServingEndpointsAPI:
             body["budget_policy_id"] = budget_policy_id
         if config is not None:
             body["config"] = config.as_dict()
+        if description is not None:
+            body["description"] = description
         if name is not None:
             body["name"] = name
         if rate_limits is not None:
@@ -4580,6 +4617,7 @@ class ServingEndpointsAPI:
         ai_gateway: Optional[AiGatewayConfig] = None,
         budget_policy_id: Optional[str] = None,
         config: Optional[EndpointCoreConfigInput] = None,
+        description: Optional[str] = None,
         rate_limits: Optional[List[RateLimit]] = None,
         route_optimized: Optional[bool] = None,
         tags: Optional[List[EndpointTag]] = None,
@@ -4589,6 +4627,7 @@ class ServingEndpointsAPI:
             ai_gateway=ai_gateway,
             budget_policy_id=budget_policy_id,
             config=config,
+            description=description,
             name=name,
             rate_limits=rate_limits,
             route_optimized=route_optimized,
@@ -4672,9 +4711,7 @@ class ServingEndpointsAPI:
         self._api.do("DELETE", f"/api/2.0/serving-endpoints/{name}", headers=headers)
 
     def export_metrics(self, name: str) -> ExportMetricsResponse:
-        """Get metrics of a serving endpoint.
-
-        Retrieves the metrics associated with the provided serving endpoint in either Prometheus or
+        """Retrieves the metrics associated with the provided serving endpoint in either Prometheus or
         OpenMetrics exposition format.
 
         :param name: str
@@ -4691,9 +4728,7 @@ class ServingEndpointsAPI:
         return ExportMetricsResponse.from_dict(res)
 
     def get(self, name: str) -> ServingEndpointDetailed:
-        """Get a single serving endpoint.
-
-        Retrieves the details for a single serving endpoint.
+        """Retrieves the details for a single serving endpoint.
 
         :param name: str
           The name of the serving endpoint. This field is required.
@@ -4709,9 +4744,7 @@ class ServingEndpointsAPI:
         return ServingEndpointDetailed.from_dict(res)
 
     def get_open_api(self, name: str) -> GetOpenApiResponse:
-        """Get the schema for a serving endpoint.
-
-        Get the query schema of the serving endpoint in OpenAPI format. The schema contains information for
+        """Get the query schema of the serving endpoint in OpenAPI format. The schema contains information for
         the supported paths, input and output format and datatypes.
 
         :param name: str
@@ -4728,9 +4761,7 @@ class ServingEndpointsAPI:
         return GetOpenApiResponse.from_dict(res)
 
     def get_permission_levels(self, serving_endpoint_id: str) -> GetServingEndpointPermissionLevelsResponse:
-        """Get serving endpoint 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 serving_endpoint_id: str
           The serving endpoint for which to get or manage permissions.
@@ -4748,9 +4779,7 @@ class ServingEndpointsAPI:
         return GetServingEndpointPermissionLevelsResponse.from_dict(res)
 
     def get_permissions(self, serving_endpoint_id: str) -> ServingEndpointPermissions:
-        """Get serving endpoint permissions.
-
-        Gets the permissions of a serving endpoint. Serving endpoints can inherit permissions from their root
+        """Gets the permissions of a serving endpoint. Serving endpoints can inherit permissions from their root
         object.
 
         :param serving_endpoint_id: str
@@ -4818,6 +4847,7 @@ class ServingEndpointsAPI:
     def list(self) -> Iterator[ServingEndpoint]:
         """Get all serving endpoints.
 
+
         :returns: Iterator over :class:`ServingEndpoint`
         """
 
@@ -4830,9 +4860,7 @@ class ServingEndpointsAPI:
         return parsed if parsed is not None else []
 
     def logs(self, name: str, served_model_name: str) -> ServerLogsResponse:
-        """Get the latest logs for a served model.
-
-        Retrieves the service logs associated with the provided served model.
+        """Retrieves the service logs associated with the provided served model.
 
         :param name: str
           The name of the serving endpoint that the served model belongs to. This field is required.
@@ -4854,9 +4882,7 @@ class ServingEndpointsAPI:
     def patch(
         self, name: str, *, add_tags: Optional[List[EndpointTag]] = None, delete_tags: Optional[List[str]] = None
     ) -> EndpointTags:
-        """Update tags of a serving endpoint.
-
-        Used to batch add and delete tags from a serving endpoint with a single API call.
+        """Used to batch add and delete tags from a serving endpoint with a single API call.
 
         :param name: str
           The name of the serving endpoint who's tags to patch. This field is required.
@@ -4881,9 +4907,7 @@ class ServingEndpointsAPI:
         return EndpointTags.from_dict(res)
 
     def put(self, name: str, *, rate_limits: Optional[List[RateLimit]] = None) -> PutResponse:
-        """Update rate limits of a serving endpoint.
-
-        Deprecated: Please use AI Gateway to manage rate limits instead.
+        """Deprecated: Please use AI Gateway to manage rate limits instead.
 
         :param name: str
           The name of the serving endpoint whose rate limits are being updated. This field is required.
@@ -4913,9 +4937,7 @@ class ServingEndpointsAPI:
         rate_limits: Optional[List[AiGatewayRateLimit]] = None,
         usage_tracking_config: Optional[AiGatewayUsageTrackingConfig] = None,
     ) -> PutAiGatewayResponse:
-        """Update AI Gateway of a serving endpoint.
-
-        Used to update the AI Gateway of a serving endpoint. NOTE: External model, provisioned throughput, and
+        """Used to update the AI Gateway of a serving endpoint. NOTE: External model, provisioned throughput, and
         pay-per-token endpoints are fully supported; agent endpoints currently only support inference tables.
 
         :param name: str
@@ -5070,9 +5092,7 @@ class ServingEndpointsAPI:
         *,
         access_control_list: Optional[List[ServingEndpointAccessControlRequest]] = None,
     ) -> ServingEndpointPermissions:
-        """Set serving endpoint 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 serving_endpoint_id: str
@@ -5103,9 +5123,7 @@ class ServingEndpointsAPI:
         served_models: Optional[List[ServedModelInput]] = None,
         traffic_config: Optional[TrafficConfig] = None,
     ) -> Wait[ServingEndpointDetailed]:
-        """Update config of a serving endpoint.
-
-        Updates any combination of the serving endpoint's served entities, the compute configuration of those
+        """Updates any combination of the serving endpoint's served entities, the compute configuration of those
         served entities, and the endpoint's traffic config. An endpoint that already has an update in progress
         can not be updated until the current update completes or fails.
 
@@ -5173,9 +5191,7 @@ class ServingEndpointsAPI:
         *,
         access_control_list: Optional[List[ServingEndpointAccessControlRequest]] = None,
     ) -> ServingEndpointPermissions:
-        """Update serving endpoint permissions.
-
-        Updates the permissions on a serving endpoint. Serving endpoints can inherit permissions from their
+        """Updates the permissions on a serving endpoint. Serving endpoints can inherit permissions from their
         root object.
 
         :param serving_endpoint_id: str
@@ -5200,9 +5216,7 @@ class ServingEndpointsAPI:
     def update_provisioned_throughput_endpoint_config(
         self, name: str, config: PtEndpointCoreConfig
     ) -> Wait[ServingEndpointDetailed]:
-        """Update config of a PT serving endpoint.
-
-        Updates any combination of the pt endpoint's served entities, the compute configuration of those
+        """Updates any combination of the pt endpoint's served entities, the compute configuration of those
         served entities, and the endpoint's traffic config. Updates are instantaneous and endpoint should be
         updated instantly