databricks-sdk 0.63.0__py3-none-any.whl → 0.64.0__py3-none-any.whl

databricks/sdk/service/cleanrooms.py

@@ -45,7 +45,7 @@ class CleanRoom:
     using the separate CreateCleanRoomOutputCatalog API."""
 
     owner: Optional[str] = None
-    """This is Databricks username of the owner of the local clean room securable for permission
+    """This is the Databricks username of the owner of the local clean room securable for permission
     management."""
 
     remote_detailed_info: Optional[CleanRoomRemoteDetail] = None
@@ -358,7 +358,7 @@ class CleanRoomAssetNotebook:
     """All existing approvals or rejections"""
 
     runner_collaborator_aliases: Optional[List[str]] = None
-    """collaborators that can run the notebook"""
+    """Aliases of collaborators that can run the notebook."""
 
     def as_dict(self) -> dict:
         """Serializes the CleanRoomAssetNotebook into a dictionary suitable for use as a JSON request body."""
@@ -643,7 +643,7 @@ class CleanRoomCollaborator:
     It is not restricted to these values and could change in the future"""
 
     global_metastore_id: Optional[str] = None
-    """The global Unity Catalog metastore id of the collaborator. The identifier is of format
+    """The global Unity Catalog metastore ID of the collaborator. The identifier is of format
     cloud:region:metastore-uuid."""
 
     invite_recipient_email: Optional[str] = None

databricks/sdk/service/dashboards.py

@@ -413,6 +413,14 @@ class GenieConversationSummary:
         )
 
 
+class GenieFeedbackRating(Enum):
+    """Feedback rating for Genie messages"""
+
+    NEGATIVE = "NEGATIVE"
+    NONE = "NONE"
+    POSITIVE = "POSITIVE"
+
+
 @dataclass
 class GenieGetMessageQueryResultResponse:
     statement_response: Optional[sql.StatementResponse] = None
@@ -439,6 +447,38 @@ class GenieGetMessageQueryResultResponse:
         return cls(statement_response=_from_dict(d, "statement_response", sql.StatementResponse))
 
 
+@dataclass
+class GenieListConversationMessagesResponse:
+    messages: Optional[List[GenieMessage]] = None
+    """List of messages in the conversation."""
+
+    next_page_token: Optional[str] = None
+    """The token to use for retrieving the next page of results."""
+
+    def as_dict(self) -> dict:
+        """Serializes the GenieListConversationMessagesResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.messages:
+            body["messages"] = [v.as_dict() for v in self.messages]
+        if self.next_page_token is not None:
+            body["next_page_token"] = self.next_page_token
+        return body
+
+    def as_shallow_dict(self) -> dict:
+        """Serializes the GenieListConversationMessagesResponse into a shallow dictionary of its immediate attributes."""
+        body = {}
+        if self.messages:
+            body["messages"] = self.messages
+        if self.next_page_token is not None:
+            body["next_page_token"] = self.next_page_token
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, Any]) -> GenieListConversationMessagesResponse:
+        """Deserializes the GenieListConversationMessagesResponse from a dictionary."""
+        return cls(messages=_repeated_dict(d, "messages", GenieMessage), next_page_token=d.get("next_page_token", None))
+
+
 @dataclass
 class GenieListConversationsResponse:
     conversations: Optional[List[GenieConversationSummary]] = None
@@ -1630,6 +1670,29 @@ class GenieAPI:
 
         self._api.do("DELETE", f"/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}", headers=headers)
 
+    def delete_conversation_message(self, space_id: str, conversation_id: str, message_id: str):
+        """Delete a conversation message.
+
+        :param space_id: str
+          The ID associated with the Genie space where the message is located.
+        :param conversation_id: str
+          The ID associated with the conversation.
+        :param message_id: str
+          The ID associated with the message to delete.
+
+
+        """
+
+        headers = {
+            "Accept": "application/json",
+        }
+
+        self._api.do(
+            "DELETE",
+            f"/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}",
+            headers=headers,
+        )
+
     def execute_message_attachment_query(
         self, space_id: str, conversation_id: str, message_id: str, attachment_id: str
     ) -> GenieGetMessageQueryResultResponse:
@@ -1662,7 +1725,8 @@ class GenieAPI:
     def execute_message_query(
         self, space_id: str, conversation_id: str, message_id: str
     ) -> GenieGetMessageQueryResultResponse:
-        """Execute the SQL query in the message.
+        """DEPRECATED: Use [Execute Message Attachment Query](:method:genie/executemessageattachmentquery)
+        instead.
 
         :param space_id: str
           Genie space ID
@@ -1741,8 +1805,8 @@ class GenieAPI:
     def get_message_query_result(
         self, space_id: str, conversation_id: str, message_id: str
     ) -> GenieGetMessageQueryResultResponse:
-        """Get the result of SQL query if the message has a query attachment. This is only available if a message
-        has a query attachment and the message status is `EXECUTING_QUERY`.
+        """DEPRECATED: Use [Get Message Attachment Query Result](:method:genie/getmessageattachmentqueryresult)
+        instead.
 
         :param space_id: str
           Genie space ID
@@ -1768,8 +1832,8 @@ class GenieAPI:
     def get_message_query_result_by_attachment(
         self, space_id: str, conversation_id: str, message_id: str, attachment_id: str
     ) -> GenieGetMessageQueryResultResponse:
-        """Get the result of SQL query if the message has a query attachment. This is only available if a message
-        has a query attachment and the message status is `EXECUTING_QUERY` OR `COMPLETED`.
+        """DEPRECATED: Use [Get Message Attachment Query Result](:method:genie/getmessageattachmentqueryresult)
+        instead.
 
         :param space_id: str
           Genie space ID
@@ -1810,13 +1874,55 @@ class GenieAPI:
         res = self._api.do("GET", f"/api/2.0/genie/spaces/{space_id}", headers=headers)
         return GenieSpace.from_dict(res)
 
+    def list_conversation_messages(
+        self, space_id: str, conversation_id: str, *, page_size: Optional[int] = None, page_token: Optional[str] = None
+    ) -> GenieListConversationMessagesResponse:
+        """List messages in a conversation
+
+        :param space_id: str
+          The ID associated with the Genie space where the conversation is located
+        :param conversation_id: str
+          The ID of the conversation to list messages from
+        :param page_size: int (optional)
+          Maximum number of messages to return per page
+        :param page_token: str (optional)
+          Token to get the next page of results
+
+        :returns: :class:`GenieListConversationMessagesResponse`
+        """
+
+        query = {}
+        if page_size is not None:
+            query["page_size"] = page_size
+        if page_token is not None:
+            query["page_token"] = page_token
+        headers = {
+            "Accept": "application/json",
+        }
+
+        res = self._api.do(
+            "GET",
+            f"/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages",
+            query=query,
+            headers=headers,
+        )
+        return GenieListConversationMessagesResponse.from_dict(res)
+
     def list_conversations(
-        self, space_id: str, *, page_size: Optional[int] = None, page_token: Optional[str] = None
+        self,
+        space_id: str,
+        *,
+        include_all: Optional[bool] = None,
+        page_size: Optional[int] = None,
+        page_token: Optional[str] = None,
     ) -> GenieListConversationsResponse:
         """Get a list of conversations in a Genie Space.
 
         :param space_id: str
           The ID of the Genie space to retrieve conversations from.
+        :param include_all: bool (optional)
+          Include all conversations in the space across all users. Requires "Can Manage" permission on the
+          space.
         :param page_size: int (optional)
           Maximum number of conversations to return per page
         :param page_token: str (optional)
@@ -1826,6 +1932,8 @@ class GenieAPI:
         """
 
         query = {}
+        if include_all is not None:
+            query["include_all"] = include_all
         if page_size is not None:
             query["page_size"] = page_size
         if page_token is not None:
@@ -1862,6 +1970,47 @@ class GenieAPI:
         res = self._api.do("GET", "/api/2.0/genie/spaces", query=query, headers=headers)
         return GenieListSpacesResponse.from_dict(res)
 
+    def send_message_feedback(
+        self,
+        space_id: str,
+        conversation_id: str,
+        message_id: str,
+        feedback_rating: GenieFeedbackRating,
+        *,
+        feedback_text: Optional[str] = None,
+    ):
+        """Send feedback for a message.
+
+        :param space_id: str
+          The ID associated with the Genie space where the message is located.
+        :param conversation_id: str
+          The ID associated with the conversation.
+        :param message_id: str
+          The ID associated with the message to provide feedback for.
+        :param feedback_rating: :class:`GenieFeedbackRating`
+          The rating (POSITIVE, NEGATIVE, or NONE).
+        :param feedback_text: str (optional)
+          Optional text feedback that will be stored as a comment.
+
+
+        """
+        body = {}
+        if feedback_rating is not None:
+            body["feedback_rating"] = feedback_rating.value
+        if feedback_text is not None:
+            body["feedback_text"] = feedback_text
+        headers = {
+            "Accept": "application/json",
+            "Content-Type": "application/json",
+        }
+
+        self._api.do(
+            "POST",
+            f"/api/2.0/genie/spaces/{space_id}/conversations/{conversation_id}/messages/{message_id}/feedback",
+            body=body,
+            headers=headers,
+        )
+
     def start_conversation(self, space_id: str, content: str) -> Wait[GenieMessage]:
         """Start a new conversation.
 

databricks/sdk/service/jobs.py

@@ -42,6 +42,9 @@ class BaseJob:
     Jobs UI in the job details page and Jobs API using `budget_policy_id` 3. Inferred default based
     on accessible budget policies of the run_as identity on job creation or modification."""
 
+    effective_usage_policy_id: Optional[str] = None
+    """The id of the usage policy used by this job for cost attribution purposes."""
+
     has_more: Optional[bool] = None
     """Indicates if the job has more array properties (`tasks`, `job_clusters`) that are not shown.
     They can be accessed via :method:jobs/get endpoint. It is only relevant for API 2.2
@@ -66,6 +69,8 @@ class BaseJob:
             body["creator_user_name"] = self.creator_user_name
         if self.effective_budget_policy_id is not None:
             body["effective_budget_policy_id"] = self.effective_budget_policy_id
+        if self.effective_usage_policy_id is not None:
+            body["effective_usage_policy_id"] = self.effective_usage_policy_id
         if self.has_more is not None:
             body["has_more"] = self.has_more
         if self.job_id is not None:
@@ -85,6 +90,8 @@ class BaseJob:
             body["creator_user_name"] = self.creator_user_name
         if self.effective_budget_policy_id is not None:
             body["effective_budget_policy_id"] = self.effective_budget_policy_id
+        if self.effective_usage_policy_id is not None:
+            body["effective_usage_policy_id"] = self.effective_usage_policy_id
         if self.has_more is not None:
             body["has_more"] = self.has_more
         if self.job_id is not None:
@@ -102,6 +109,7 @@ class BaseJob:
             created_time=d.get("created_time", None),
             creator_user_name=d.get("creator_user_name", None),
             effective_budget_policy_id=d.get("effective_budget_policy_id", None),
+            effective_usage_policy_id=d.get("effective_usage_policy_id", None),
             has_more=d.get("has_more", None),
             job_id=d.get("job_id", None),
             settings=_from_dict(d, "settings", JobSettings),
@@ -147,6 +155,9 @@ class BaseRun:
     `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and
     optimized cluster performance."""
 
+    effective_usage_policy_id: Optional[str] = None
+    """The id of the usage policy used by this run for cost attribution purposes."""
+
     end_time: Optional[int] = None
     """The time at which this run ended in epoch milliseconds (milliseconds since 1/1/1970 UTC). This
     field is set to 0 if the job is still running."""
@@ -267,6 +278,8 @@ class BaseRun:
             body["description"] = self.description
         if self.effective_performance_target is not None:
             body["effective_performance_target"] = self.effective_performance_target.value
+        if self.effective_usage_policy_id is not None:
+            body["effective_usage_policy_id"] = self.effective_usage_policy_id
         if self.end_time is not None:
             body["end_time"] = self.end_time
         if self.execution_duration is not None:
@@ -338,6 +351,8 @@ class BaseRun:
             body["description"] = self.description
         if self.effective_performance_target is not None:
             body["effective_performance_target"] = self.effective_performance_target
+        if self.effective_usage_policy_id is not None:
+            body["effective_usage_policy_id"] = self.effective_usage_policy_id
         if self.end_time is not None:
             body["end_time"] = self.end_time
         if self.execution_duration is not None:
@@ -403,6 +418,7 @@ class BaseRun:
             creator_user_name=d.get("creator_user_name", None),
             description=d.get("description", None),
             effective_performance_target=_enum(d, "effective_performance_target", PerformanceTarget),
+            effective_usage_policy_id=d.get("effective_usage_policy_id", None),
             end_time=d.get("end_time", None),
             execution_duration=d.get("execution_duration", None),
             git_source=_from_dict(d, "git_source", GitSource),
@@ -2212,6 +2228,9 @@ class Job:
     Jobs UI in the job details page and Jobs API using `budget_policy_id` 3. Inferred default based
     on accessible budget policies of the run_as identity on job creation or modification."""
 
+    effective_usage_policy_id: Optional[str] = None
+    """The id of the usage policy used by this job for cost attribution purposes."""
+
     has_more: Optional[bool] = None
     """Indicates if the job has more array properties (`tasks`, `job_clusters`) that are not shown.
     They can be accessed via :method:jobs/get endpoint. It is only relevant for API 2.2
@@ -2248,6 +2267,8 @@ class Job:
             body["creator_user_name"] = self.creator_user_name
         if self.effective_budget_policy_id is not None:
             body["effective_budget_policy_id"] = self.effective_budget_policy_id
+        if self.effective_usage_policy_id is not None:
+            body["effective_usage_policy_id"] = self.effective_usage_policy_id
         if self.has_more is not None:
             body["has_more"] = self.has_more
         if self.job_id is not None:
@@ -2271,6 +2292,8 @@ class Job:
             body["creator_user_name"] = self.creator_user_name
         if self.effective_budget_policy_id is not None:
             body["effective_budget_policy_id"] = self.effective_budget_policy_id
+        if self.effective_usage_policy_id is not None:
+            body["effective_usage_policy_id"] = self.effective_usage_policy_id
         if self.has_more is not None:
             body["has_more"] = self.has_more
         if self.job_id is not None:
@@ -2292,6 +2315,7 @@ class Job:
             created_time=d.get("created_time", None),
             creator_user_name=d.get("creator_user_name", None),
             effective_budget_policy_id=d.get("effective_budget_policy_id", None),
+            effective_usage_policy_id=d.get("effective_usage_policy_id", None),
             has_more=d.get("has_more", None),
             job_id=d.get("job_id", None),
             next_page_token=d.get("next_page_token", None),
@@ -3039,8 +3063,8 @@ class JobSettings:
 
     usage_policy_id: Optional[str] = None
     """The id of the user specified usage policy to use for this job. If not specified, a default usage
-    policy may be applied when creating or modifying the job. See `effective_budget_policy_id` for
-    the budget policy used by this workload."""
+    policy may be applied when creating or modifying the job. See `effective_usage_policy_id` for
+    the usage policy used by this workload."""
 
     webhook_notifications: Optional[WebhookNotifications] = None
     """A collection of system notification IDs to notify when runs of this job begin or complete."""
@@ -4509,6 +4533,9 @@ class Run:
     `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and
     optimized cluster performance."""
 
+    effective_usage_policy_id: Optional[str] = None
+    """The id of the usage policy used by this run for cost attribution purposes."""
+
     end_time: Optional[int] = None
     """The time at which this run ended in epoch milliseconds (milliseconds since 1/1/1970 UTC). This
     field is set to 0 if the job is still running."""
@@ -4635,6 +4662,8 @@ class Run:
             body["description"] = self.description
         if self.effective_performance_target is not None:
             body["effective_performance_target"] = self.effective_performance_target.value
+        if self.effective_usage_policy_id is not None:
+            body["effective_usage_policy_id"] = self.effective_usage_policy_id
         if self.end_time is not None:
             body["end_time"] = self.end_time
         if self.execution_duration is not None:
@@ -4710,6 +4739,8 @@ class Run:
             body["description"] = self.description
         if self.effective_performance_target is not None:
             body["effective_performance_target"] = self.effective_performance_target
+        if self.effective_usage_policy_id is not None:
+            body["effective_usage_policy_id"] = self.effective_usage_policy_id
         if self.end_time is not None:
             body["end_time"] = self.end_time
         if self.execution_duration is not None:
@@ -4779,6 +4810,7 @@ class Run:
             creator_user_name=d.get("creator_user_name", None),
             description=d.get("description", None),
             effective_performance_target=_enum(d, "effective_performance_target", PerformanceTarget),
+            effective_usage_policy_id=d.get("effective_usage_policy_id", None),
             end_time=d.get("end_time", None),
             execution_duration=d.get("execution_duration", None),
             git_source=_from_dict(d, "git_source", GitSource),
@@ -8546,8 +8578,8 @@ class JobsAPI:
           `runNow`.
         :param usage_policy_id: str (optional)
           The id of the user specified usage policy to use for this job. If not specified, a default usage
-          policy may be applied when creating or modifying the job. See `effective_budget_policy_id` for the
-          budget policy used by this workload.
+          policy may be applied when creating or modifying the job. See `effective_usage_policy_id` for the
+          usage policy used by this workload.
         :param webhook_notifications: :class:`WebhookNotifications` (optional)
           A collection of system notification IDs to notify when runs of this job begin or complete.
 

databricks/sdk/service/serving.py

@@ -314,6 +314,9 @@ class AiGatewayRateLimit:
     """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."""
 
+    tokens: Optional[int] = None
+    """Used to specify how many tokens are allowed for a key within the renewal_period."""
+
     def as_dict(self) -> dict:
         """Serializes the AiGatewayRateLimit into a dictionary suitable for use as a JSON request body."""
         body = {}
@@ -325,6 +328,8 @@ class AiGatewayRateLimit:
             body["principal"] = self.principal
         if self.renewal_period is not None:
             body["renewal_period"] = self.renewal_period.value
+        if self.tokens is not None:
+            body["tokens"] = self.tokens
         return body
 
     def as_shallow_dict(self) -> dict:
@@ -338,6 +343,8 @@ class AiGatewayRateLimit:
             body["principal"] = self.principal
         if self.renewal_period is not None:
             body["renewal_period"] = self.renewal_period
+        if self.tokens is not None:
+            body["tokens"] = self.tokens
         return body
 
     @classmethod
@@ -348,6 +355,7 @@ class AiGatewayRateLimit:
             key=_enum(d, "key", AiGatewayRateLimitKey),
             principal=d.get("principal", None),
             renewal_period=_enum(d, "renewal_period", AiGatewayRateLimitRenewalPeriod),
+            tokens=d.get("tokens", None),
         )
 
 
@@ -3374,6 +3382,9 @@ class ServingEndpoint:
     task: Optional[str] = None
     """The task type of the serving endpoint."""
 
+    usage_policy_id: Optional[str] = None
+    """The usage policy associated with serving endpoint."""
+
     def as_dict(self) -> dict:
         """Serializes the ServingEndpoint into a dictionary suitable for use as a JSON request body."""
         body = {}
@@ -3401,6 +3412,8 @@ class ServingEndpoint:
             body["tags"] = [v.as_dict() for v in self.tags]
         if self.task is not None:
             body["task"] = self.task
+        if self.usage_policy_id is not None:
+            body["usage_policy_id"] = self.usage_policy_id
         return body
 
     def as_shallow_dict(self) -> dict:
@@ -3430,6 +3443,8 @@ class ServingEndpoint:
             body["tags"] = self.tags
         if self.task is not None:
             body["task"] = self.task
+        if self.usage_policy_id is not None:
+            body["usage_policy_id"] = self.usage_policy_id
         return body
 
     @classmethod
@@ -3448,6 +3463,7 @@ class ServingEndpoint:
             state=_from_dict(d, "state", EndpointState),
             tags=_repeated_dict(d, "tags", EndpointTag),
             task=d.get("task", None),
+            usage_policy_id=d.get("usage_policy_id", None),
         )